lynnesbian/FediBooks
lynnesbian/FediBooks
1
0
Fork 0
mirror of https://github.com/Lynnesbian/FediBooks/ synced 2024-11-25 08:38:59 +00:00
Code Issues Releases Wiki Activity

docs: add basic selfhosting guide

Browse source
This commit is contained in:
knuxify 2019-12-30 14:21:42 +01:00
parent 200897c5d7
commit 49457d8a62
1 changed files with 42 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -1,2 +1,44 @@
# FediBooks
A web UI for creating your very own ebooks bots.
# Selfhosting
1. Install ``python3`` and ``mariadb``. 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).
3. Go to the ``app`` directory and copy the config.sample.json file to ``config.json``.
4. Fill in the newly created ``config.json`` file.
5. Run ``python3 app/setup.py`` and follow the on-screen prompts.
6. Open the MySQL prompt (using the ``mysql`` command) and type in the following commands:
```
CREATE DATABASE `fedibooks`;
CREATE USER 'myuser' IDENTIFIED BY 'mypassword';
GRANT USAGE ON *.* TO 'myuser'@localhost IDENTIFIED BY 'mypassword';
GRANT ALL privileges ON `fedibooks`.* TO 'myuser'@localhost;
FLUSH PRIVILEGES;
exit
```
where ``fedibooks`` is your database name, ``myuser`` is your database username and ``mypassword`` is your database user's password.
7. Run
```
# mysql -u USERNAME -p DATABASE < db/setup.sql
```
where USERNAME is your database username and DATABASE is your database name.
8. Run ``./run.sh`` to start FediBooks.