Mirror of https://github.com/Lynnesbian/FediBooks/ https://fedibooks.com

Go to file

Lynne Megido 33b72d8e4c fixed a silly but rather bad bug\ni'm pretty sure i'm gonna stop working on fedibooks, and everything else i do relating to fedi. writing complex webapps to (rather poorly) interface with decentralised, half-standardised social networking platforms really isn't for me, and much of this code is honestly pretty awful. i have no idea why i did some of this stuff - for example, writing an object to interface with the outbox json would have been a LOT cleaner than what i'm currently doing. fedibooks really doesn't work well at all, and its biggest flaw is, of course, the fact that it can't interact with any instances using authenticated fetch. while i may fix minor bugs from time to time, i can pretty much guarantee that one's never getting fixed. i'm not shutting down fedibooks.com or anything like that - and if i ever do, i'll give advance warning - but don't expect any new features here, or in mstdn-ebooks, OCRbot, et al. but hey, at least it's fixed now.		2020-05-27 19:39:15 +10:00
.github	i don't know why it was broken but now it isn't	2019-09-01 16:26:14 +10:00
.vscode	added vscode settings	2019-09-18 21:39:16 +10:00
app	fixed a silly but rather bad bug\ni'm pretty sure i'm gonna stop working on fedibooks, and everything else i do relating to fedi. writing complex webapps to (rather poorly) interface with decentralised, half-standardised social networking platforms really isn't for me, and much of this code is honestly pretty awful. i have no idea why i did some of this stuff - for example, writing an object to interface with the outbox json would have been a LOT cleaner than what i'm currently doing. fedibooks really doesn't work well at all, and its biggest flaw is, of course, the fact that it can't interact with any instances using authenticated fetch. while i may fix minor bugs from time to time, i can pretty much guarantee that one's never getting fixed. i'm not shutting down fedibooks.com or anything like that - and if i ever do, i'll give advance warning - but don't expect any new features here, or in mstdn-ebooks, OCRbot, et al. but hey, at least it's fixed now.	2020-05-27 19:39:15 +10:00
db	provide webfinger and actor info with rsa key for secure fetch	2020-03-18 16:41:32 +10:00
.gitignore	some more groundwork for HTTP signatures	2020-04-11 17:14:53 +10:00
LICENSE	Initial commit	2019-08-27 20:22:06 +10:00
README.md	better mysql instructions	2020-01-20 12:02:22 +10:00
logo.png	new logo	2019-09-19 07:53:29 +10:00
requirements.txt	Bump cryptography from 2.9 to 2.9.2	2020-04-23 19:15:18 +00:00
run.sh	reorganised directory structure	2019-09-18 13:04:44 +10:00

README.md

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.

Install python3 and mariadb or mysql. If you're installing on Windows, make sure to check "Add Python to PATH" during Python installation.
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).

Copy the app/config.sample.json file to app/config.json.
Fill in the app/config.json file.
Run python3 app/setup.py and follow the on-screen prompts.
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.

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

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

Run ./run.sh to start FediBooks.