1
0
mirror of https://github.com/vichan-devel/vichan.git synced 2024-11-25 07:50:23 +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 6f427268f0 Merge pull request #17 from boreq/master
Updated banners.py
2014-09-23 19:49:17 -04:00
inc add htmlpurifier library 2014-09-23 23:25:04 +00:00
js KaTeX 2014-09-23 18:17:05 +00:00
static Fix #10 2014-09-23 23:26:27 +00:00
stylesheets Fix too many mentions overflowing container 2014-09-23 15:32:12 +00:00
templates Add templates I forgot 2014-09-23 19:49:52 +00:00
tools Apologies for this huge shitty commit. Git got corrupted. Contains a merge, change to katex, stylesheets, lots of shit really. ;_; 2014-09-22 18:29:06 -07: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
banners.php Updated banners.py 2014-09-24 01:37:23 +02:00
boards.php Fix #10 2014-09-23 23:26:27 +00:00
claim-old.php No more automatic claiming 2014-07-19 18:40:06 +00:00
claim.php No more automatic claiming 2014-07-19 18:40:06 +00:00
create.php Fix #13 2014-09-23 23:22:41 +00:00
expire.php Merge ../http 2014-09-23 15:32:19 +00:00
faq.php More files I forgot to git add 2014-09-23 20:12:32 +00:00
index.php index.php responsive 2014-09-24 01:27:01 +02:00
install.php tag for 4.9.92 2014-09-21 05:58:49 +02: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 remove license exception for Tinyboard vanilla, since they moved to a different one 2014-06-21 20:49:13 +02:00
LICENSE.Tinyboard.md move Tinyboard license 2014-04-18 11:13:41 +02:00
mod.php Allow mod.php?/board without final / 2014-06-10 23:46:28 +00:00
player.php Suppress warnings that might leak information 2014-08-09 12:14:56 +02:00
post.php Allow the user to decide whether or not he wants to display his country 2014-09-20 16:35:28 +00:00
random.php More files I forgot to git add 2014-09-23 20:12:32 +00:00
README.md Update README.md 2014-09-23 17:17:45 -03:00
search.php Enable search page for 8chan 2014-04-21 13:42:49 +00:00

8chan - The infinitely expanding 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.3
  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.

Support

Tinyboard 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/oekaki.js to your instance-config.php.

WebM support

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

Static Pages

Some pages like /faq.html need to be pre-generated:

$ php faq.php > faq.html

License

See LICENSE.md.