From dbda783b9252f525c2d6aaa37227b4ed98cbd55f Mon Sep 17 00:00:00 2001 From: 8chan Date: Fri, 14 Nov 2014 04:15:04 -0800 Subject: [PATCH] Better install documentation --- README.md | 140 ++++------------------------------------------------ install.sql | 7 --- 2 files changed, 9 insertions(+), 138 deletions(-) diff --git a/README.md b/README.md index 96e008cc..4292844d 100644 --- a/README.md +++ b/README.md @@ -3,145 +3,23 @@ About ------------ -8chan is a free light-weight, fast, highly configurable and user-friendly -imageboard software package. It is written in PHP and has few dependencies. +8chan is a fork of vichan, with the difference that 8chan is geared towards allowing users to create their own boards. -8chan is a fork of [vichan](https://github.com/vichan-devel/vichan), which is a fork of [Tinyboard](http://tinyboard.org/), a great imageboard package, actively -building on it and adding a lot of features and other improvements. +Most things (other than installation) that apply to upstream vichan also apply to 8chan. See their readme for a detailed FAQ: https://github.com/vichan-devel/vichan/blob/master/README.md -Support and announcements: https://int.vichan.net/devel/ +If you are not interested in letting your users make their own boards, install vichan instead of 8chan. -Requirements ------------- -1. PHP >= 5.3 -2. MySQL/MariaDB server -3. [mbstring](http://www.php.net/manual/en/mbstring.installation.php) -4. [PHP GD](http://www.php.net/manual/en/intro.image.php) -5. [PHP PDO](http://www.php.net/manual/en/intro.pdo.php) - -We try to make sure vichan is compatible with all major web servers and -operating systems. vichan does not include an Apache ```.htaccess``` file nor does -it need one. - -### Recommended -1. MySQL/MariaDB server >= 5.5.3 -2. ImageMagick (command-line ImageMagick or GraphicsMagick preferred). -3. [APC (Alternative PHP Cache)](http://php.net/manual/en/book.apc.php), - [XCache](http://xcache.lighttpd.net/) or - [Memcached](http://www.php.net/manual/en/intro.memcached.php) - -Contributing ------------- -You can contribute to vichan by: -* Developing patches/improvements/translations and using GitHub to submit pull requests -* Providing feedback and suggestions -* Writing/editing documentation - -If you need help developing a patch, please join our IRC channel. - -Installation -------------- -1. Download and extract Tinyboard to your web directory or get the latest - development version with: - - git clone git://github.com/ctrlcctrlv/8chan.git - -2. Copy secrets.example.php to secrets.php and edit it. - -3. Navigate to ```install.php``` in your web browser and follow the - prompts. -4. vichan should now be installed. Log in to ```mod.php``` with the - default username and password combination: **admin / password**. - -Please remember to change the administrator account password. - -See also: [Configuration Basics](http://tinyboard.org/docs/?p=Config). - -Upgrade -------- -To upgrade from any version of Tinyboard or vichan: - -Either run ```git pull``` to update your files, if you used git, or -backup your ```inc/instance-config.php```, replace all your files in place -(don't remove boards etc.), then put ```inc/instance-config.php``` back and -finally run ```install.php```. - -Support --------- -vichan is still beta software -- there are bound to be bugs. If you find a -bug, please report it. - -If you need assistance with installing, configuring, or using vichan, you may -find support from a variety of sources: - -* If you're unsure about how to enable or configure certain features, make - sure you have read the comments in ```inc/config.php```. -* Check out an [official vichan board](http://int.vichan.net/devel/). -* You can join vichan's IRC channel for support - [irc.6irc.net #vichan-devel](irc://irc.6irc.net/vichan-devel) - -### Tinyboard support -8chan is based on a Tinyboard, so both engines have very much in common. These -links may be helpful for you as well: - -* Tinyboard documentation can be found [here](http://tinyboard.org/docs/). -* You can join Tinyboard's IRC channel for support and general queries: - [irc.datnode.net #tinyboard](irc://irc.datnode.net/tinyboard). -* You may find help at [tinyboard.org](http://tinyboard.org/#help). - -Donations ---------- -Do you like our work? You can motivate us financially to do better ;) -* Bitcoin: [![tip for next commit](http://tip4commit.com/projects/708.svg)](http://tip4commit.com/projects/708) - -You can also ask us to develop some feature specially for you <3. Join our IRC -channel and ask for a quote (there are a few of us, who work with the codebase -and are skilled enough to develop such features pretty quickly). - -CLI tools ------------------ -There are a few command line interface tools, based on Tinyboard-Tools. These need -to be launched from a Unix shell account (SSH, or something). They are located in a ```tools/``` -directory. - -You actually don't need these tools for your imageboard functioning, they are aimed -at the power users. You won't be able to run these from shared hosting accounts -(i.e. all free web servers). - -Localisation ------------- -Want to have vichan/8chan in your language? You can contribute your translations at this URL: - -https://www.transifex.com/projects/p/tinyboard-vichan-devel/ - -Oekaki ------- -vichan makes use of [wPaint](https://github.com/websanova/wPaint) for oekaki. After you pull the repository, however, you will need to download wPaint separately using git's `submodule` feature. Use the following commands: +Because I cannot be bothered to maintain `install.php`, the install process is as such: ``` -git submodule init -git submodule update +mysql -uroot 8chan < install.sql +echo '8chan' > .installed ``` -To enable oekaki, add all the scripts listed in `js/wpaint.js` to your `instance-config.php`. +Here's my install script as of 11/14/2014 for the 8chan servers which run Ubuntu 14.04: -WebM support ------------- -Read `inc/lib/webm/README.md` for information about enabling webm. - -Static Pages ------------- -Some pages like `/faq.html` need to be pre-generated: ``` -$ php faq.php > faq.html +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 ``` -vichan API ----------- -vichan provides by default a 4chan-compatible JSON API. For documentation on this, see: -https://github.com/vichan-devel/vichan-API/ . - -License --------- -See [LICENSE.md](http://github.com/vichan-devel/vichan/blob/master/LICENSE.md). - +Have fun! diff --git a/install.sql b/install.sql index 812349c1..9af84787 100644 --- a/install.sql +++ b/install.sql @@ -75,13 +75,6 @@ CREATE TABLE IF NOT EXISTS `board_create` ( `uri` text NOT NULL ) ENGINE=InnoDB DEFAULT CHARSET=utf8; --- --- Dumping data for table `boards` --- - -INSERT INTO `boards` VALUES -('b', 'Random', NULL); - -- -------------------------------------------------------- --