bookwyrm/README.md

174 lines
9.9 KiB
Markdown
Raw Normal View History

2020-06-28 22:47:36 +00:00
# BookWyrm
2020-01-27 05:52:24 +00:00
2020-01-27 22:16:56 +00:00
Social reading and reviewing, decentralized with ActivityPub
2020-01-28 02:59:49 +00:00
2020-02-20 22:57:23 +00:00
## Contents
2021-02-08 01:11:30 +00:00
- [Joining BookWyrm](#joining-bookwyrm)
2021-02-13 01:29:05 +00:00
- [Contributing](#contributing)
- [About BookWyrm](#about-bookwyrm)
2020-02-20 22:57:23 +00:00
- [What it is and isn't](#what-it-is-and-isnt)
- [The role of federation](#the-role-of-federation)
- [Features](#features)
- [Setting up the developer environment](#setting-up-the-developer-environment)
2020-12-09 22:49:47 +00:00
- [Installing in Production](#installing-in-production)
2020-03-07 20:41:22 +00:00
- [Book data](#book-data)
2020-02-20 22:57:23 +00:00
2021-02-08 01:11:30 +00:00
## Joining BookWyrm
BookWyrm is still a young piece of software, and isn't at the level of stability and feature-richness that you'd find in a production-ready application. But it does what it says on the box! If you'd like to join an instance, you can check out the [instances](https://github.com/mouse-reeve/bookwyrm/blob/main/instances.md) list.
2021-02-12 23:31:12 +00:00
You can request an invite to https://bookwyrm.social by [email](mailto:mousereeve@riseup.net), [Mastodon direct message](https://friend.camp/@tripofmice), or [Twitter direct message](https://twitter.com/tripofmice).
2021-02-08 01:11:30 +00:00
2021-02-13 01:29:05 +00:00
## Contributing
There are many ways you can contribute to this project, regardless of your level of technical expertise.
### Feedback and feature requests
Please feel encouraged and welcome to point out bugs, suggestions, feature requests, and ideas for how things ought to work using [GitHub issues](https://github.com/mouse-reeve/bookwyrm/issues).
### Code contributions
Code contributons are gladly welcomed! If you're not sure where to start, take a look at the ["Good first issue"](https://github.com/mouse-reeve/bookwyrm/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) tag. Because BookWyrm is a small project, there isn't a lot of formal structure, but there is a huge capacity for one-on-one support, which can look like asking questions as you go, pair programming, video chats, et cetera, so please feel free to reach out.
If you have questions about the project or contributing, you can seet up a video call during BookWyrm ["office hours"](https://calendly.com/mouse-reeve/30min).
### Financial Support
BookWyrm is an ad-free passion project with no intentions of seeking out venture funding or corporate financial relationships. If you want to help keep the project going, you can donate to the [Patreon](https://www.patreon.com/bookwyrm), or make a one time gift via [PayPal](https://paypal.me/oulipo).
## About BookWyrm
2020-02-26 10:04:20 +00:00
### What it is and isn't
2020-06-28 22:47:36 +00:00
BookWyrm is a platform for social reading! You can use it to track what you're reading, review books, and follow your friends. It isn't primarily meant for cataloguing or as a datasource for books, but it does do both of those things to some degree.
### The role of federation
2021-02-08 01:11:30 +00:00
BookWyrm is built on [ActivityPub](http://activitypub.rocks/). With ActivityPub, it inter-operates with different instances of BookWyrm, and other ActivityPub compliant services, like Mastodon. This means you can run an instance for your book club, and still follow your friend who posts on a server devoted to 20th century Russian speculative fiction. It also means that your friend on mastodon can read and comment on a book review that you post on your BookWyrm instance.
2021-02-08 01:11:30 +00:00
Federation makes it possible to have small, self-determining communities, in contrast to the monolithic service you find on GoodReads or Twitter. An instance can be focused on a particular interest, be just for a group of friends, or anything else that brings people together. Each community can choose which other instances they want to federate with, and moderate and run their community autonomously. Check out https://runyourown.social/ to get a sense of the philosophy and logistics behind small, high-trust social networks.
### Features
2021-02-08 01:11:30 +00:00
Since the project is still in its early stages, the features are growing every day, and there is plenty of room for suggestions and ideas. Open an [issue](https://github.com/mouse-reeve/bookwyrm/issues) to get the conversation going!
2020-04-24 19:19:19 +00:00
- Posting about books
- Compose reviews, with or without ratings, which are aggregated in the book page
- Compose other kinds of statuses about books, such as:
- Comments on a book
- Quotes or excerpts
- Reply to statuses
2021-02-08 01:11:30 +00:00
- View aggregate reviews of a book across connected BookWyrm instances
- Differentiate local and federated reviews and rating in your activity feed
- Track reading activity
2020-04-24 19:19:19 +00:00
- Shelve books on default "to-read," "currently reading," and "read" shelves
- Create custom shelves
2021-02-08 01:11:30 +00:00
- Store started reading/finished reading dates, as well as progress updates along the way
2020-04-24 19:19:19 +00:00
- Update followers about reading activity (optionally, and with granular privacy controls)
2021-02-08 01:11:30 +00:00
- Create lists of books which can be open to submissions from anyone, curated, or only edited by the creator
- Federation with ActivityPub
2020-04-24 19:19:19 +00:00
- Broadcast and receive user statuses and activity
2021-02-08 01:11:30 +00:00
- Share book data between instances to create a networked database of metadata
2020-04-24 19:19:19 +00:00
- Identify shared books across instances and aggregate related content
2020-06-28 22:47:36 +00:00
- Follow and interact with users across BookWyrm instances
2021-02-08 01:11:30 +00:00
- Inter-operate with non-BookWyrm ActivityPub services (currently, Mastodon is supported)
2020-02-20 18:53:10 +00:00
- Granular privacy controls
2021-02-08 01:11:30 +00:00
- Private, followers-only, and public privacy levels for posting, shelves, and lists
- Option for users to manually approve followers
2020-03-11 19:14:33 +00:00
- Allow blocking and flagging for moderation
2021-02-13 01:29:05 +00:00
### The Tech Stack
Web backend
- [Django](https://www.djangoproject.com/) web server
- [PostgreSQL](https://www.postgresql.org/) database
- [ActivityPub](http://activitypub.rocks/) federation
- [Celery](http://celeryproject.org/) task queuing
- [Redis](https://redis.io/) task backend
Front end
- Django templates
- [Bulma.io](https://bulma.io/) css framework
- Vanilla JavaScript, in moderation
Deployment
- [Docker](https://www.docker.com/) and docker-compose
- [Gunicorn](https://gunicorn.org/) web runner
- [Flower](https://github.com/mher/flower) celery monitoring
- [Nginx](https://nginx.org/en/) HTTP server
2020-01-28 02:59:49 +00:00
## Setting up the developer environment
Set up the environment file:
``` bash
cp .env.example .env
```
2020-04-24 19:19:19 +00:00
For most testing, you'll want to use ngrok. Remember to set the DOMAIN in `.env` to your ngrok domain.
2020-11-02 21:00:11 +00:00
You'll have to install the Docker and docker-compose. When you're ready, run:
```bash
docker-compose build
docker-compose run --rm web python manage.py migrate
docker-compose run --rm web python manage.py initdb
2021-01-20 22:17:30 +00:00
docker-compose up
2020-11-02 21:00:11 +00:00
```
2020-12-13 04:25:58 +00:00
Once the build is complete, you can access the instance at `localhost:1333`
2020-11-02 21:00:11 +00:00
## Installing in Production
This project is still young and isn't, at the momoment, very stable, so please procede with caution when running in production.
2021-02-22 06:49:52 +00:00
2020-11-02 21:00:11 +00:00
### Server setup
- Get a domain name and set up DNS for your server
- Set your server up with appropriate firewalls for running a web application (this instruction set is tested again Ubuntu 20.04)
2021-02-22 06:49:52 +00:00
- Set up an email service (such as mailgun) and the appropriate SMTP/DNS settings
2020-11-02 21:00:11 +00:00
- Install Docker and docker-compose
2021-02-22 06:49:52 +00:00
2020-11-02 21:00:11 +00:00
### Install and configure BookWyrm
2021-02-22 06:49:52 +00:00
The `production` branch of BookWyrm contains a number of tools not on the `main` branch that are suited for running in production, such as `docker-compose` changes to update the default commands or configuration of containers, and indivudal changes to container config to enable things like SSL or regular backups.
Instructions for running BookWyrm in production:
2020-11-02 21:00:11 +00:00
- Get the application code:
`git clone git@github.com:mouse-reeve/bookwyrm.git`
- Switch to the `production` branch
`git checkout production`
- Create your environment variables file
`cp .env.example .env`
2021-02-22 06:49:52 +00:00
- Add your domain, email address, SMTP credentials
2020-11-02 21:00:11 +00:00
- Set a secure redis password and secret key
2021-02-08 01:11:30 +00:00
- Set a secure database password for postgres
2020-12-06 19:15:40 +00:00
- Update your nginx configuration in `nginx/default.conf`
2020-11-02 21:00:11 +00:00
- Replace `your-domain.com` with your domain name
2021-02-22 06:49:52 +00:00
- Run the application (this should also set up a Certbot ssl cert for your domain) with
`docker-compose up --build`, and make sure all the images build successfully
2020-11-02 21:00:11 +00:00
- When docker has built successfully, stop the process with `CTRL-C`
- Comment out the `command: certonly...` line in `docker-compose.yml`
2021-02-22 06:49:52 +00:00
- Run docker-compose in the background with: `docker-compose up -d`
- Initialize the database with: `./bw-dev initdb`
- Set up schedule backups with cron that runs that `docker-compose exec db pg_dump -U <databasename>` and saves the backup to a safe location
Congrats! You did it, go to your domain and enjoy the fruits of your labors.
2020-11-02 21:00:11 +00:00
### Configure your instance
2021-02-22 06:49:52 +00:00
- Register a user account in the application UI
2020-11-02 21:00:11 +00:00
- Make your account a superuser (warning: do *not* use django's `createsuperuser` command)
- On your server, open the django shell
2020-12-06 19:15:40 +00:00
`./bw-dev shell`
2020-11-02 21:00:11 +00:00
- Load your user and make it a superuser
```python
from bookwyrm import models
user = models.User.objects.get(id=1)
user.is_staff = True
user.is_superuser = True
user.save()
```
2021-02-08 01:11:30 +00:00
- Go to the site settings (`/settings/site-settings` on your domain) and configure your instance name, description, code of conduct, and toggle whether registration is open on your instance
2020-01-28 20:58:32 +00:00
2020-03-07 20:41:22 +00:00
## Book data
2021-02-08 01:11:30 +00:00
The application is set up to share book and author data between instances, and get book data from arbitrary outside sources. Right now, the only connector is to OpenLibrary, but other connectors could be written.
2020-03-07 20:41:22 +00:00
2020-04-24 19:19:19 +00:00
There are three concepts in the book data model:
- `Book`, an abstract, high-level concept that could mean either a `Work` or an `Edition`. No data is saved as a `Book`, it serves as shared model for `Work` and `Edition`
- `Work`, the theoretical umbrella concept of a book that encompasses every edition of the book, and
- `Edition`, a concrete, actually published version of a book
2020-03-07 20:41:22 +00:00
2020-04-24 19:19:19 +00:00
Whenever a user interacts with a book, they are interacting with a specific edition. Every work has a default edition, but the user can select other editions. Reviews aggregated for all editions of a work when you view an edition's page.