kevinveenbirkenbach/computer-playbook
1
0
Fork 0
mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2025-09-09 03:37:37 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
188b09850355e1c9f4dc60fafedd86ea4352b908
computer-playbook/roles/web-app-bookwyrm
History
Kevin Veen-Birkenbach bc56940e55 Implement initial BookWyrm role 
- Removed obsolete TODO.md
- Added config/main.yml with service, feature, CSP, and registration settings
- Added schema/main.yml defining vaulted SECRET_KEY (alphanumeric)
- Added tasks/main.yml to load stateful stack
- Added Dockerfile.j2 ensuring data/media dirs
- Added docker-compose.yml.j2 with application, worker, redis, volumes
- Added env.j2 with registration, secrets, DB, Redis, OIDC support
- Extended vars/main.yml with BookWyrm variables and OIDC, Docker, Redis settings
- Updated meta/main.yml with logo and run_after dependencies

Ref: https://chatgpt.com/share/68b6c060-3a0c-800f-89f8-e114a16a4a80
2025-09-02 12:03:11 +02:00
..
config
Implement initial BookWyrm role
2025-09-02 12:03:11 +02:00
meta
Implement initial BookWyrm role
2025-09-02 12:03:11 +02:00
schema
Implement initial BookWyrm role
2025-09-02 12:03:11 +02:00
tasks
Implement initial BookWyrm role
2025-09-02 12:03:11 +02:00
templates
Implement initial BookWyrm role
2025-09-02 12:03:11 +02:00
vars
Implement initial BookWyrm role
2025-09-02 12:03:11 +02:00
README.md
Add README.md files for web-app-bookwyrm, web-app-postmarks, and web-app-socialhome roles
2025-09-02 11:52:34 +02:00

README.md

BookWyrm

Description

Host your own social reading platform with BookWyrm. This role deploys BookWyrm via Docker Compose, wires domains and ports, and offers optional OIDC integration so your readers can sign in through your central identity provider.

Overview

This role provisions a BookWyrm application stack with Docker. It supports PostgreSQL and Redis, sets sensible environment defaults, and exposes an application container plus a dedicated Celery worker. A reverse proxy (provided elsewhere in your stack) fronts the service for public access.

Features

  • Fully Dockerized Deployment: Builds and runs BookWyrm containers (app + worker) using Docker Compose.
  • Production-friendly Settings: Environment templating for database, Redis, and security-relevant settings (e.g., SECRET_KEY).
  • Optional OIDC: Can integrate with your OIDC provider (e.g., Keycloak) directly or behind oauth2-proxy (depending on your flavor).
  • Volumes for Data & Media: Persistent volumes for BookWyrm data and media assets.
  • Redis & Celery Worker: Background tasks processed by Celery; Redis used for broker and cache.
  • Desktop Integration Hooks: Compatible with your Web App Desktop listing when the role includes this README.
  • Matomo/CSS/Desktop Flags: Standard feature flags are available for consistent theming/analytics across apps in your ecosystem.

Further Resources