lynnesbian/FediBooks
lynnesbian
/
FediBooks
mirror of https://github.com/Lynnesbian/FediBooks/
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge pull request #37 from knuxify/add-selfhosting-guide 

Add selfhosting guide
This commit is contained in:
Lynne Megido 2020-01-08 09:06:41 +10:00 committed by GitHub
parent 200897c5d7 cb39b4cfea
commit ca824cc7b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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. Copy the ``app/config.sample.json`` file to ``app/config.json``.
4. Fill in the ``app/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.