README.vichan.md

   1 ViChan - A lightweight and full featured PHP imageboard.
   2 ========================================================
   3
   4 About
   5 ------------
   6
   7 *Security problems can be reported to Fredrick Brennan at his email: COPYPASTE \<AT\> KITTENS \<DOT\> PH.*
   8
   9 History
  10 ------------
  11 vichan is a fork of (now defunc'd) [Tinyboard](http://github.com/savetheinternet/Tinyboard),
  12 a great imageboard package, actively building on it and adding a lot of features and other
  13 improvements.
  14
  15 Some documentation may be found on our [wiki](https://github.com/vichan-devel/vichan/wiki). (feel free to contribute)
  16
  17 Requirements
  18 ------------
  19 1.      PHP <= PHP 7.4.
  20 2.      MySQL/MariaDB server
  21 3.      [mbstring](http://www.php.net/manual/en/mbstring.installation.php)
  22 4.      [PHP GD](http://www.php.net/manual/en/intro.image.php)
  23 5.      [PHP PDO](http://www.php.net/manual/en/intro.pdo.php)
  24 6.      A Unix-like OS, preferrably FreeBSD or Linux.
  25 Notes. ViQa is developed on Ubuntu18.04 with an Ubuntu18.04 VPS Server
  26
  27 We try to make sure vichan is compatible with all major web servers. vichan does not include an Apache ```.htaccess``` file nor does it need one.
  28
  29 ### Recommended
  30 1.      MySQL/MariaDB server >= 5.5.3
  31 2.      ImageMagick (command-line ImageMagick or GraphicsMagick preferred).
  32 3.      [APC (Alternative PHP Cache)](http://php.net/manual/en/book.apc.php),
  33         [XCache](http://xcache.lighttpd.net/) or
  34         [Memcached](http://www.php.net/manual/en/intro.memcached.php)
  35
  36 Contributing
  37 ------------
  38 You can contribute to vichan by:
  39 *       Developing patches/improvements/translations and using GitHub to submit pull requests
  40 *       Providing feedback and suggestions
  41 *       Writing/editing documentation
  42
  43 Installation
  44 -------------
  45 1.      Download and extract vichan to your web directory or get the latest
  46         development version with:
  47
  48         git clone git://github.com/vichan-devel/vichan.git
  49
  50 2.      Navigate to ```install.php``` in your web browser and follow the
  51         prompts.
  52 3.      vichan should now be installed. Log in to ```mod.php``` with the
  53         default username and password combination: **admin / password**.
  54
  55 Please remember to change the administrator account password.
  56
  57 See also: [Configuration Basics](https://web.archive.org/web/20121003095922/http://tinyboard.org/docs/?p=Config).
  58
  59
  60
  61 Upgrade
  62 -------
  63 To upgrade from any version of Tinyboard or vichan:
  64
  65 Either run ```git pull``` to update your files, if you used git, or
  66 backup your ```inc/instance-config.php```, replace all your files in place
  67 (don't remove boards etc.), then put ```inc/instance-config.php``` back and
  68 finally run ```install.php```.
  69
  70 To migrate from a Kusaba X board, use http://github.com/vichan-devel/Tinyboard-Migration
  71
  72 Support
  73 --------
  74 vichan is still beta software -- there are bound to be bugs. If you find a
  75 bug, please report it.
  76
  77 CLI tools
  78 -----------------
  79 There are a few command line interface tools, based on Tinyboard-Tools. These need
  80 to be launched from a Unix shell account (SSH, or something). They are located in a ```tools/```
  81 directory.
  82
  83 You actually don't need these tools for your imageboard functioning, they are aimed
  84 at the power users. You won't be able to run these from shared hosting accounts
  85 (i.e. all free web servers).
  86
  87 Oekaki
  88 ------
  89 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:
  90
  91 ```
  92 git submodule init
  93 git submodule update
  94 ```
  95
  96 To enable oekaki, add all the scripts listed in `js/wpaint.js` to your `instance-config.php`.
  97
  98 WebM support
  99 ------------
 100 Read `inc/lib/webm/README.md` for information about enabling webm.
 101
 102 vichan API
 103 ----------
 104 vichan provides by default a 4chan-compatible JSON API. For documentation on this, see:
 105 https://github.com/vichan-devel/vichan-API/ .
 106
 107 License
 108 --------
 109 See [LICENSE.md](http://github.com/vichan-devel/vichan/blob/master/LICENSE.md).
 110