FediBooks/README.md

1.4 KiB

FediBooks

A web UI for creating your very own ebooks bots.

Selfhosting

FediBooks is currently unfinished - many functions don't work yet, and future updates may make major, breaking changes. I don't recommend self-hosting it yet unless you're willing to work through the potential growing pains.

  1. Install python3 and mariadb or mysql. If you're installing on Windows, make sure to check "Add Python to PATH" during Python installation.

  2. Install the requirements, using pip:

# pip3 install -r ./requirements.txt

If this doesn't work, try using pip instead. If it still doesn't work, you might have to install an additional package (for example, python-pip on Arch Linux).

  1. Copy the app/config.sample.json file to app/config.json.

  2. Fill in the app/config.json file.

  3. Run python3 app/setup.py and follow the on-screen prompts.

  4. Open the MySQL prompt (using the mysql command) and type in the following commands:

CREATE DATABASE `fedibooks`;
CREATE USER 'myuser' IDENTIFIED BY 'mypassword';
GRANT ALL PRIVILEGES ON `fedibooks`.* TO 'myuser';
FLUSH PRIVILEGES;
exit

where fedibooks is your database name, myuser is your database username and mypassword is your database user's password.

  1. Run
# mysql -u USERNAME -p DATABASE < db/setup.sql

where USERNAME is your database username and DATABASE is your database name.

  1. Run ./run.sh to start FediBooks.