mirror of
https://github.com/Lynnesbian/FediBooks/
synced 2024-11-25 16:48:58 +00:00
Compare commits
6 commits
200897c5d7
...
00369be990
Author | SHA1 | Date | |
---|---|---|---|
00369be990 | |||
|
116b313269 | ||
ca824cc7b0 | |||
|
cb39b4cfea | ||
|
49457d8a62 | ||
|
5b8bf3dc32 |
2 changed files with 45 additions and 1 deletions
44
README.md
44
README.md
|
@ -1,2 +1,46 @@
|
|||
# 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).
|
||||
|
||||
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.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
Mastodon.py==1.5.0
|
||||
markovify==0.8.0
|
||||
beautifulsoup4==4.8.1
|
||||
beautifulsoup4==4.8.2
|
||||
requests==2.22.0
|
||||
Flask==1.1.1
|
||||
flask-mysqldb==0.2.0
|
||||
|
|
Loading…
Reference in a new issue