Repository files navigation

Please do not contact Fredrick Brennan in regards to vichan issues.

As of 29 August 2022 it supports PHP8.1.

vichan is a free light-weight, fast, highly configurable and user-friendlyimageboard software package. It is written in PHP and has few dependencies.

Some documentation may be found on ourwiki. (feel free to contribute)

vichan is a fork of (now defunc'd)Tinyboard,a great imageboard package, actively building on it and adding a lot of features and otherimprovements.

1. @perdedora and@RealAngeleno - 2023-Present.
2. Development Commission lead by@basedgentoo,@kuz-sysadmin, and@RealAngeleno. (2023 - 2023)
3. @h00j (2021 - ???)
4. @ctrlcctrlv (2017 - 2021)
5. @czaks (2014 - 2017) (The author of vichan fork)
6. @savetheinternet (2010 - 2014) (The creator of Tinyboard)

1. PHP >= 7.4
2. MySQL/MariaDB server
3. mbstring
4. PHP GD
5. PHP PDO
6. A Unix-like OS, preferrably FreeBSD or GNU/Linux

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.

1. MySQL/MariaDB server >= 5.5.3
2. ImageMagick (command-line ImageMagick or GraphicsMagick preferred).
3. APCu (Alternative PHP Cache),Memcached orRedis

You can contribute to vichan by:

• Developing patches/improvements/translations and using GitHub to submit pull requests
• Providing feedback and suggestions
• Writing/editing documentation

1. Get the latest development version with:

   git clone git://github.com/vichan-devel/vichan.git

2. runcomposer install inside the directory

3. Navigate toinstall.php in your web browser and follow theprompts.

4. vichan should now be installed. Log in tomod.php with thedefault username and password combination:admin / password.

Please remember to change the administrator account password.

See also:Configuration Basics.

To upgrade from any version of Tinyboard or vichan:

Either rungit pull to update your files, if you used git, orbackup yourinc/instance-config.php, replace all your files in place(don't remove boards etc.), then putinc/instance-config.php back andfinally runinstall.php.

To migrate from a Kusaba X board, usehttp://github.com/vichan-devel/Tinyboard-Migration

Demo with the most updated version ofVichan.

1. PHP 8.1
2. MySQL 5.7
3. KeyDB 6.2.1 (Redis)
4. NGINX 1.14.0

vichan is still beta software -- there are bound to be bugs. If you find abug, please report it.

There are a few command line interface tools, based on Tinyboard-Tools. These needto be launched from a Unix shell account (SSH, or something). They are located in atools/directory.

You actually don't need these tools for your imageboard functioning, they are aimedat the power users. You won't be able to run these from shared hosting accounts(i.e. all free web servers).

vichan makes use ofwPaint for oekaki. After you pull the repository, however, you will need to download wPaint separately using git'ssubmodule feature. Use the following commands:

git submodule initgit submodule update

To enable oekaki, add all the scripts listed injs/wpaint.js to yourinstance-config.php.

Readinc/lib/webm/README.md for information about enabling webm.

Vichan comes with a Dockerfile and docker-compose configuration, the latter aimed primarily at development and testing.See thedocker/doc.md file for more information.

vichan provides by default a 4chan-compatible JSON API. For documentation on this, see:https://github.com/vichan-devel/vichan-API/ .

SeeLICENSE.md.