Skip to content

The public source code of https://kissu.moe 's vichan(post server) component. The API server and React server are not public. For more detailed commit logs, see linked repository. NPFChan adds functionality for deleting and maintaining order as well as the archive. Original: https://github.com/vichan-devel/vichan ; NPFChan Fork: https://github.c…

License

ECHibiki/kissu.moe

Repository files navigation

ViQa-Kissu - An expanded lightweight and full featured PHP imageboard.

The public source code of kissu's vichan(post server) component. The API server and React server are not public. Ceratin files are hidden. For more detailed commit logs, see linked repository. NPFChan adds functionality for deleting and maintaining order as well as the archive. Original: https://github.com/vichan-devel/vichan ; NPFChan Fork: https://github.com/fallenPineapple/NPFchan

About

ViQa-Kissu is an expansion on top of the free light-weight, fast, highly configurable and user-friendly imageboard software package, ViChan. ViQa is written in PHP and has few dependencies. It aims to expand upon the current structure of ViChan to provide expanded functionality with a focus on more democratic and powerful system of moderation to beat spam while staying liked by your users.

On December 2018, ECHibiki started this repo to expose the source of /qa/'s Kissu.moe

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.

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

  1. PHP <= PHP 7.4.
  2. MySQL/MariaDB server
  3. mbstring
  4. PHP GD
  5. PHP PDO
  6. A Unix-like OS, preferrably FreeBSD or Linux. Notes. ViQa is developed on Ubuntu18.04 with an Ubuntu18.04 VPS Server

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.

Recommended

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

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

  1. Download and extract vichan to your web directory or get the latest development version with:

    git clone git://github.com/vichan-devel/vichan.git
    
  2. Navigate to install.php in your web browser and follow the prompts.

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

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.

About

The public source code of https://kissu.moe 's vichan(post server) component. The API server and React server are not public. For more detailed commit logs, see linked repository. NPFChan adds functionality for deleting and maintaining order as well as the archive. Original: https://github.com/vichan-devel/vichan ; NPFChan Fork: https://github.c…

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published