Imageboard software for the 21st century
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
blueprints
build-helpers
doc
model
templates
test
.gitignore
Dockerfile
LICENSE.md
Pipfile
Pipfile.lock
README.md
app.py
bootstrap.py
customjsonencoder.py
docker-compose.yml
nocache.py
outputmixin.py
pipenv_requirements.txt
requirements.txt
shared.py

README.md

Maniwani - an anonymous imageboard for the 21st century

Maniwani is a work-in-progress imageboard implementation using Flask.

Where does the name come from? I could tell you, but by that point you'd have been torn to pieces.

Features

  • Per-thread auto-generated IDs, with avatars! (IDs done, avatars planned)
  • Markdown support in posts
  • Download all media files in a thread (planned)
  • Push notification support for new posts/threads with Javascript enabled (planned)
  • Graceful UI degradation if Javascript is not enabled
  • REST API for 3rd-party clients
  • Global WebM audio support, muted by default but user-configurable (user settings not yet done)

Installation

Please note that Maniwani is currently pre-alpha software and not ready to be run in a production environment. Deploy to any Internet-facing servers at your own risk!

With Docker - standalone development image

In this directory, run the following to build a development Docker image:

docker build -t maniwani-dev --target dev .

To run your new instance, then type:

docker run -p 5000:5000 maniwani-dev

Point your web browser at http://127.0.0.1:5000 to view your new installation. Note that running Maniwani in this way will not save any data after the container is closed. This Docker method is intended to easily see what Maniwani is capable of, as well as serve as a quick and easily-replicated testbed.

With Docker - production image and environment

It is also possible through docker-compose to spin up an environment very similar to what one might use in production for Maniwani (uWSGI in addition to Postgres and Minio), though for the time being this setup is Linux-only and requires docker-compose. In this directory, type:

docker-compose build
docker-compose up -d
docker-compose run maniwani bootstrap

The last command will only need to be run once per clean installation of the production environment. If you ever want to remove all database and storage data, remove the compose-data directory, though you'll likely need root permissions to do so since some subdirectories are created by other users. At this point, you can use the normal docker-compose start and docker-compose stop to start and stop the production environment, navigating to http://127.0.0.1:5000 as per usual to view Maniwani.

As a final sidenote, this method will run all of your computer's traffic through a local DNS proxy while active, as otherwise it would not be possible to view attachments, since the local S3 server would be unreachable via hostname. If you want to audit the DNS proxy code (which is an open-source 3rd-party container), feel free to do so at https://github.com/mageddo/dns-proxy-server .

Without Docker

Python 3.4+ is required for installation, but I currently use 3.6 for developing Maniwani; if you're having problems with 3.4, file a bug report, but also try 3.6 if you can.

As Maniwani uses Pipenv, simply run pipenv install to grab all requirements (except for ffmpeg - see the "Notes on ffmpeg" section) and create a new virtualenv. After that, run pipenv run python bootstrap.py to initialize the database and set some initial options. Lastly, run pipenv run flask run from this directory and point your web browser at http://127.0.0.1:5000 to view your new Maniwani installation. If you ever want to wipe the database clean, that's currently handled by removing test.db and re-running the bootstrap.py script.

Notes on ffmpeg

Installing ffmpeg can either be done with your system's package manager if you do not already have it installed, or you can use the ffmpeg_bootstrap.py script to grab a static build of ffmpeg like so, assuming you are in the same directory as the script itself:

python3 ffmpeg_bootstrap.py
cp ffmpeg-stub-config.cfg ../maniwani.cfg
echo MANIWANI_CFG=maniwani.cfg > ../.env

Screenshots

Front page aggregating all boards:

Front page

Viewing a thread:

Thread view

Board index (images are pulled from the most recent OP in each board):

Board index

Thread gallery mode:

Gallery mode

Board catalog view, also showing off responsive mode:

Board catalog