|Florens eff1549430 Update README.md||7 months ago|
|data||2 years ago|
|docker||2 years ago|
|extra||1 year ago|
|migrations||2 years ago|
|test||2 years ago|
|uchan||1 year ago|
|.dockerignore||2 years ago|
|.env.sample||2 years ago|
|.gitignore||2 years ago|
|Dockerfile||2 years ago|
|LICENSE||4 years ago|
|Makefile||2 years ago|
|README.md||7 months ago|
|alembic.ini||4 years ago|
|assets.sh||2 years ago|
|config.ini.sample||2 years ago|
|docker-compose.yml||2 years ago|
|docker-entrypoint.sh||2 years ago|
|requirements||1 year ago|
|run.py||2 years ago|
|setup.py||2 years ago|
µchan is a modern take on internet messaging board software, also known as a BBS, textboard or imageboard.
It has all the basic features you expect from a message board: boards for different topics, support for attaching images to posts and a system for moderating. µchan is anonymous and requires no account to post.
In addition to the basic features, µchan supports creating boards by everyone, and the moderation interface is extensive and clear. Moderator permissions give extra control over the capabilities of a mod. See the roadmap for a list of features that are implemented.
You can use µchan to set up your own message board. The goal of µchan is to be the go-to software for messaging board software.
A quick rundown of what we support:
This isn’t a full comprehensive list of features, see the demo site for a live instance of µchan. Missing a feature? Request it by creating an issue.
This software is meant to replace older solutions that aren’t of this age anymore. Traditional messaging boards are static: each time a user submits a message it generates new files to update the board. Changing layouts and the likes requires full rebuilds of the site.
µchan takes a modern dynamic approach, and generates pages when they are requested. On top of that is a good caching mechanism, so that responses are delivered just as fast as static files. It can handle the load when your site grows, adding new servers to take up the extra load, there is no single point of failure.
µchan requires multiple services to run. To ease the setup and running of µchan, a docker compose configuration was created, with a manage script.
This setup can be used in production environments. As your site grows, you can adjust the configuration as needed.
Data is stored in the
./data directory, including the database, logs and media storage.
Please report any bugs you find with this tool.
A system with support for Docker, Linux is preferred.
Install Docker, either from your package manager, or follow the instructions from the docker site.
config.ini. Take a good look at the
site_url, the captcha parameters and
.env and adjust the port uchan should be available at.
If you plan to run uchan behind a proxy, for example if you already run a nginx server, and want to put uchan under a separate domain,
then you need to adjust a few parameters to make sure the correct ip is given to uchan.
In the config, change
proxy_fixer_num_proxies to 3. In the varnish config (located at docker/varnish/uchan.vcl)
uncomment the block that adds the ip forwarding. And finally, change the port in .env to something else.
Make sure that port isn’t reachable directly from the outside. After this you can configure your server to forward all requests to localhost
with the specified port, as a proxy.
make upgrade and then
make setup. The setup step will ask for a username and password for the admin account.
docker-compose logs <component> for logs of a component, where component is either
To upgrade to the newest version of µchan, run
git pull origin and then
make upgrade. This pulls the newest version from git, runs a database upgrade and restarts the stack.