Toto

An open source tool written in python to create imageboards

Website | Download | Source Code

---

Table of contents

• Requirements
• Installation
• Admin account setup
• Configuration
• Screenshots
• Contributing
• Report a bug/issue

Requirements

• Python >= 3.10
• A MongoDB instance with an empty database

Installation

Cloning from github

First, clone the source code

$ git https://github.com/malinest/Toto.git Toto && cd Toto

Create a python virtual enviroment for the app to run

$ python3 -m venv toto-venv && source toto-venv/bin/activate

Then install the requirements

$ pip3 install -r requirements.txt

Once the installation finished, open the configutation file located at Toto/config.ini and fill the following fields with your database info:

URL = YourMongoDBConnectionString
DATABASE_NAME = YourDatabase
SECRET_KEY = A random string

This is the minimal configuration needed for Toto to run

Once finished you can run Toto by typing this on your console

$ gunicorn -w 4 "Toto.toto:create_app()" --bind ip:port

As with all python wsgi applications it's highly recommended to place gunicorn behind a reverse proxy

Admin account setup

The first thing you will need to do after running the application is to create an admin account to start adding boards to your site, to do that, access the main page from your browser and navigate to /user/register and create a new user.

Once created, go to into your database and into the newly created Users collection, there you will find your user, set it's is_admin value to true and you're done.

Now go back to the main page of the site and navigate to /users/login and login as your admin user, from now on you canstart adding new boards and perform any administrative tasks with this user.

Configuration

Toto includes a configuration file that is used to modify some behaviour of the program:

Name	Description	Example
Database
URL	mongodb connection uri	example
DATABASE_NAME	Full name of the database	TotoDB
Logging
LOG_LEVEL	Log level of the logger on the terminal	DEBUG
LOG_FILE	Name of the generated log file	Toto.log
LOG_FOLDER	Location where the logs will be stored	/var/log/Toto
Flask
SECRET_KEY	This is the key that is used by flask to sign the session cookies, so make it something secure and private	9233dbf7cc629fa5c5de72a657a079f4

Screenshots

Contributing

All contributions are welcome, if you would like to contribute code please open a pull request and we will review it asap.

Report an issue

Found an issue? Or maybe got a feature request? If so please open an issue on our repository and we will have a look at it