Source code of Leftypol imageboard
Go to file
Marcin Łabanowski 0f533aaded Merge pull request #127 from JasonPuglisi/settings-space-fixes
Removed extra space for some options
2015-03-11 22:36:50 +01:00
inc Merge branch 'master' of github.com:vichan-devel/Tinyboard 2015-03-10 14:22:47 +01:00
js Removed extra space for some options 2015-03-11 16:35:49 -04:00
static Close #51: Prevent players from cheating the dice roller by using markup 2014-08-10 15:38:02 +00:00
stylesheets custom alert: now alert will be able to display custom HTML 2014-10-18 22:43:35 +02:00
templates ... 2015-03-10 13:34:02 +01:00
tools Reset to global locale before openBoard 2014-10-07 04:32:10 +02:00
.gitignore convert dos endlines to unix ones in .gitignore 2014-04-18 10:43:12 +02:00
.gitmodules include wPaint submodule, references bug vichan-devel#20 2014-01-29 21:05:50 +01:00
banned.php banned.php: remove polish strings; html5; needs further work 2013-07-27 01:19:30 -04:00
install.php support for slugified links; may introduce a few bugs 2015-03-10 12:48:59 +01:00
install.sql Merge branch 'master' of https://github.com/savetheinternet/Tinyboard into vichan-devel-4.5 2013-11-11 21:54:35 +01:00
LICENSE.md Updated license date 2015-01-01 10:48:28 +00:00
LICENSE.Tinyboard.md move Tinyboard license 2014-04-18 11:13:41 +02:00
mod.php support for slugified links; may introduce a few bugs 2015-03-10 12:48:59 +01:00
player.php Suppress warnings that might leak information 2014-08-09 12:14:56 +02:00
post.php ... 2015-03-10 13:28:55 +01:00
README.md requirements: php 5.3 -> php 5.4 2014-10-24 01:40:30 +02:00
search.php oh hey look I just fixed #8 search.php 2014-09-25 06:24:36 +02:00

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.

vichan is a fork of Tinyboard, a great imageboard package, actively building on it and adding a lot of features and other improvements.

Support and announcements: https://int.vichan.net/devel/

Requirements

  1. PHP >= 5.4 (we still try to keep compatibility with php 5.3 as much as possible)
  2. MySQL/MariaDB server
  3. mbstring
  4. PHP GD
  5. PHP PDO

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.

  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

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/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:

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:

Tinyboard support

vichan is based on a Tinyboard, so both engines have very much in common. These links may be helpful for you as well:

Donations

Do you like our work? You can motivate us financially to do better ;)

  • Bitcoin: tip for next commit

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

Wanting to have vichan 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 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.