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

Marcin Łabanowski 7bc0f528ef Merge pull request #260 from theBladeee/patch-1 Fix for install.sql		2014-11-14 10:46:27 +01:00
inc	Enabe thread stats	2014-11-12 21:08:48 -08:00
js	Have to load onready	2014-11-12 01:19:02 -08:00
static	Merge pull request #176 from VladVP/master	2014-10-11 13:22:21 -04:00
stylesheets	Merge pull request #241 from topkek/patch-6	2014-11-10 14:22:14 +08:00
templates	Go to bottom link	2014-11-09 23:24:00 -08:00
tools	Reset to global locale before openBoard	2014-09-29 07:17:39 +00:00
.gitignore	Attempt to hide IPs from board volunteers	2014-10-09 21:39:37 -04:00
.gitmodules	include wPaint submodule, references bug vichan-devel#20	2014-01-29 21:05:50 +01:00
404.php	Make removing board from favorites on 404 actually work	2014-11-12 01:16:42 -08:00
banned.php	banned.php: remove polish strings; html5; needs further work	2013-07-27 01:19:30 -04:00
banners.php	Bug: Banners weren't displaying if board was over 10 chars long	2014-11-12 21:05:34 -08:00
boards.php	Don't die on bad board configs	2014-11-09 22:17:50 -08: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	30 chars	2014-11-09 22:18:06 -08:00
expire.php	yoga	2014-11-08 16:57:43 -08:00
faq.php	lol	2014-11-12 01:17:34 -08:00
index.php	Use templates for more pages, i18n	2014-09-26 23:52:02 +00:00
install.php	[#184 ] Added <body> tag classes. Style selector now adds a <body> class. Moved board list under moderator dashboard.	2014-10-18 20:07:04 -05:00
install.sql	Fix for install.sql	2014-11-14 04:45:34 -05: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	[#184 ] Reports made to clean posts are now ignored correctly (and in accordance with the local/global duality). Marking posts clean dismisses posts (also in accordance with local/global duality). Fixed up some templating issues (now display more correct messages and omit actions that are invalid). Moved Clean action off post-level and into reports action.	2014-10-21 07:50:25 -05:00
player.php	Suppress warnings that might leak information	2014-08-09 12:14:56 +02:00
post.php	SECURITY: CSRF in post.php	2014-11-12 21:08:32 -08:00
random.php	SECURITY: Move indexed option to table...fixes unindexed boards appearing in search/random	2014-10-07 20:54:00 -07:00
README.md	Fix README.md	2014-10-19 19:41:15 +01:00
search.php	SECURITY: Move indexed option to table...fixes unindexed boards appearing in search/random	2014-10-07 20:54:00 -07:00

README.md

8chan - The infinitely expanding imageboard.

About

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

8chan is a fork of vichan, which 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

PHP >= 5.3
MySQL/MariaDB server
mbstring
PHP GD
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.

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

Download and extract Tinyboard to your web directory or get the latest development version with:
```
git clone git://github.com/ctrlcctrlv/8chan.git
```

 Copy secrets.example.php to secrets.php and edit it.

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.

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:

If you're unsure about how to enable or configure certain features, make sure you have read the comments in inc/config.php.
Check out an official vichan board.
You can join vichan's IRC channel for support irc.6irc.net #vichan-devel

Tinyboard support

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

Tinyboard documentation can be found here.
You can join Tinyboard's IRC channel for support and general queries: irc.datnode.net #tinyboard.
You may find help at tinyboard.org.

Donations

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

Bitcoin:

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

Want to have vichan/8chan 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.

Static Pages

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

$ php faq.php > faq.html

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.