Cool_Tools/vichan
1
0
Fork 0
mirror of https://github.com/vichan-devel/vichan.git synced 2025-02-17 19:29:28 +01:00
Code Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
blahblah666 2015-01-29 02:49:34 -08:00
parent 26c75472e5
commit eaf784a96c
1 changed files with 49 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@ -1,29 +1,59 @@
infinity
========================================================
This fork adds a new board option to the version of infinity as of Jan. 28th 2015:
About
------------
infinity is a fork of vichan, with the difference that infinity is geared towards allowing users to create their own boards. A running instance is at [8ch.net](https://8ch.net/)
The requirement to solve a captcha in order to create a thread, but not in order to post a reply.
Most things (other than installation) that apply to upstream vichan also apply to infinity. See their readme for a detailed FAQ: https://github.com/vichan-devel/vichan/blob/master/README.md
Here's a quick rundown of where code edits have been made:
If you are not interested in letting your users make their own boards, install vichan instead of infinity.
ALL CODE EDITS FOR NEW THREAD CAPTCHA ARE MARKED WITH THE COMMENT "New thread captcha"
ONE ADITIONAL EDIT TO SETTINGS.HTML MARKED WITH:
"Added explanation to clarify purpose of "Enable CAPTCHA" now that "Enable CAPTCHA for new thread creation only" also exists".
Installation
------------
Basic requirements:
A server running a Unix-like OS(infinity has been specifically tested with and is known to work under Ubuntu 14.x)
Apache, MySQL, and PHP
* Make sure Apache has read/write access to the directory infinity resides in.
* `install.php` is not maintained. Don't use it.
The $config setting for new thread captcha is $config[new_thread_capt]
Step 1. Create infinity's database from the included install.sql file. Enter mysql and create an empty database named 'infinity'. Then, cd into the infinity base directory and run:
```
mysql -uroot -p infinity < install.sql
echo 'infinity' > .installed
```
templates/mod/settings.html
Option for new captcha thread creation has been added to the settings template.
"Enable CAPTCHA" also clarified with better description.
Step 2. /inc/secrets.php does not exist by default, but infinity needs it in order to function. To remedy this, cd into /inc/ and run:
```
sudo cp secrets.example.php secrets.php
```
inc/8chan-mod-pages.php
Three lines of code added to 8chan-mod-pages.php
Now open secrets.php and edit the $config['db'] settings to point to the 'infinity' MySQL database you created in Step 1. 'user' and 'password' refer to your MySQL login credentials. It should look something like this when you're finished:
inc/config.php
Line added, makes new thread captcha default to off.
```
$config['db']['server'] = 'localhost';
$config['db']['database'] = 'infinity';
$config['db']['prefix'] = '';
$config['db']['user'] = 'root';
$config['db']['password'] = 'password';
$config['timezone'] = 'UTC';
$config['cache']['enabled'] = 'apc';
```
/templates/post_form.html
Several lines added. Makes the verification box show up in the new thread form
when $config[new_thread_capt] is enabled.
Step 3.(Optional) By default, infinity will ignore any changes you make to the template files until you log into mod.php, go to Rebuild, and select Flush Cache. You may find this inconvenient. To make infinity automatically accept your changes to template files, open /inc/template.php and add:
/post.php
Added two new conditions to if statement.
```
'auto_reload' => true
```
To the array of settings passed to Twig_Environment().
Step 4. Infinity can function in a very barebones fashion after the first two steps, but you should probably install these additional packages if you want to seriously run it and/or contribute to it. ffmpeg may fail to intall under certain versions of Ubuntu. If it does, remove it from the script below and install it via an alternate method. Make sure to run the below as root:
```
apt-get install graphicsmagick gifsicle php5-fpm mysql-client php5-mysql php5-cli php-pear php5-apcu; add-apt-repository ppa:jon-severinsson/ffmpeg; add-apt-repository ppa:nginx/stable; apt-get update; apt-get install nginx ffmpeg; pear install Net_DNS2
```
Step 5. The current captcha provider listed inc/config.php is dead. You may want to work around this.
Have fun!