36 lines
1.3 KiB
Markdown
36 lines
1.3 KiB
Markdown
# BookWyrm
|
|
|
|
BookWyrm is a federated social reading platform — a self-hosted alternative to Goodreads, connected to the ActivityPub network.
|
|
|
|
## Dependencies
|
|
|
|
- **PostgreSQL** - Database for storing books, reviews, and user data
|
|
- **Redis** - Used for caching and background job queuing
|
|
- **SMTP** - For account verification and notifications
|
|
|
|
## Configuration
|
|
|
|
Key settings in `config.yaml`:
|
|
|
|
- **domain** - Where BookWyrm will be accessible
|
|
- **storage** - Persistent volume size (default: `2Gi`)
|
|
- **smtp** - Email settings inherited from your Wild Cloud SMTP service
|
|
|
|
## First-Time Setup
|
|
|
|
1. Add and deploy the app:
|
|
```bash
|
|
wild app add bookwyrm
|
|
wild app deploy bookwyrm
|
|
```
|
|
|
|
2. Visit the app URL — on first load, a setup wizard will guide you through creating the admin account and configuring the instance.
|
|
|
|
3. After setup, log in and configure the instance settings (name, description, registration policy) from the admin panel at `/settings/`.
|
|
|
|
## Notes
|
|
|
|
- BookWyrm federates with other BookWyrm instances and Mastodon via ActivityPub — users on other instances can follow and interact with your users
|
|
- Book metadata is imported from OpenLibrary and Inventaire — internet access is required for book search to work
|
|
- The `secretKey` is auto-generated in `secrets.yaml`
|