mirror of https://github.com/vichan-devel/vichan.git synced 2024-11-27 17:00:52 +01:00

Vichan is the most popular and widely used imageboard software in the world. It is a free, light-weight, fast, highly configurable and user-friendly imageboard software package.

Go to file

Fredrick Brennan 3a41c24e6e Fix PHP 7.3 regression in ?/users This gets rid of the "Case-insensitive constants are deprecated" error by passing doing \|upper before passing to constant().		2019-05-02 12:19:50 +08:00
inc	fix typo in inc/config.php	2019-03-22 10:02:38 +08:00
js	Update thread-watcher.js	2017-07-30 02:57:39 +02:00
static	Close #51 : Prevent players from cheating the dice roller by using markup	2014-08-10 15:38:02 +00:00
stylesheets	Minor changes to form and boardlist in sharp.css	2017-07-25 02:29:52 -04:00
templates	Fix PHP 7.3 regression in ?/users	2019-05-02 12:19:50 +08:00
tmp	tesseract OCR support for spamfilters	2016-06-09 11:09:10 +02:00
tools	(2/2) advanced build. implement a daemon that will build static pages.	2016-05-08 13:23:41 +02:00
.gitignore	update gitignore	2015-04-05 18:46:45 +02:00
.gitmodules	Edit static pages commit	2016-05-06 16:03:55 +02:00
banned.php	fix banned.php; thanks stigma	2015-04-07 02:29:38 +02:00
install.php	Fix broken link in install.php	2018-07-27 18:48:27 +08:00
install.sql	forgot Grave accents	2017-04-25 05:59:42 +02:00
LICENSE.md	Update license and copyright dates	2018-03-01 22:57:53 -03:00
LICENSE.Tinyboard.md	move Tinyboard license	2014-04-18 11:13:41 +02:00
log.php	Public action logs commit (log.php)	2016-05-06 15:44:26 +02:00
mod.php	[SECURITY] Lessen security impact	2017-05-17 14:05:01 -04:00
player.php	Suppress warnings that might leak information	2014-08-09 12:14:56 +02:00
post.php	Close #293	2019-03-09 11:54:18 +08:00
README.md	Remove refs to abandoned domains; IRC channels	2019-04-19 12:23:47 +08:00
report.php	Oops forgot a file	2016-05-05 13:33:14 +02:00
search.php	fix search not remembering board	2017-07-07 23:35:38 +01:00
smart_build.php	(2/2) advanced build. implement a daemon that will build static pages.	2016-05-08 13:23:41 +02:00

README.md

vichan - A lightweight and full featured PHP imageboard.

About

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

In November 2017, Marcin Łabanowski (@czaks) retired as maintainer for personal reasons. His retirement may be temporary, but in his absence, Fredrick Brennan (@ctrlcctrlv), co-maintainer since 2013, and #3 in terms of number of commits, took his place as interim sole maintianer and point of contact. (See issue #266)

Security problems can be reported to Fredrick Brennan at his email: COPYPASTE <AT> KITTENS <DOT> PH.

Vichan is still accepting patches, but there is at the moment no active development besides fixing security problems and other serious bugs as they emerge. Given the lack of active development, we strongly urge you to consider other imageboard packages. It is the opinion of the vichan development team that no new vichan imageboards should be deployed, and other imageboard packages, such as lynxchan, used instead.

History

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

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

Requirements

PHP >= 5.4 (we still try to keep compatibility with php 5.3 as much as possible) PHP 7.0 is explicitly supported. PHP 7.2 works as well, but may cause as yet unreported bugs.
MySQL/MariaDB server
mbstring
PHP GD
PHP PDO
A Unix-like OS, preferrably FreeBSD or 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.

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

Installation

Download and extract vichan to your web directory or get the latest development version with:
```
git clone git://github.com/vichan-devel/vichan.git
```
Navigate to install.php in your web browser and follow the prompts.
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.

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.

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

Support

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

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).

Oekaki

vichan makes use of 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:

git submodule init
git submodule update

To enable oekaki, add all the scripts listed in js/wpaint.js to your instance-config.php.

WebM support

Read inc/lib/webm/README.md for information about enabling webm.

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.