mirror of
https://github.com/nickyeoman/docker-compose-cookbooks.git
synced 2026-09-03 18:36:22 +00:00
complete all stack READMEs to the 9-section template
Existing content preserved and reordered to the canonical section order; missing sections generated from each stack's compose data (ports, volumes, env vars, image links). Fixes copy-paste errors in Dockhand sections (qbittorrent pointed at archivebox; invokeai/thunderbird said SERVICENAME) and persistant->persistent typos in gatus. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
@@ -12,6 +12,63 @@ BookStack is a self-hosted wiki platform for organizing and storing documentatio
|
||||
- **Documentation:** [Docs](https://www.bookstackapp.com/docs/)
|
||||
- **Reverse Proxy Port:** `8080`
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Start the container: `docker compose up -d`
|
||||
2. Open http://localhost:8080 in your browser
|
||||
3. Follow the initial setup wizard to configure the application
|
||||
|
||||
## Environment Variable Notes
|
||||
|
||||
BOOKSTACK_APP_KEY – default: ChangeThisPassword
|
||||
BOOKSTACK_APP_TIMEZONE – default: America/Vancouver
|
||||
BOOKSTACK_APP_URL – default: http://localhost:8080
|
||||
BOOKSTACK_DB_DATABASE – default: bookstack
|
||||
BOOKSTACK_DB_PASSWORD – default: ChangeThisPassword
|
||||
BOOKSTACK_DB_USERNAME – default: dbuser
|
||||
BOOKSTACK_REVISION_LIMIT – default: false
|
||||
BOOKSTACK_PORT – default: 8080
|
||||
MARIADB_ROOT_PASSWORD – default: ChangeThisPassword
|
||||
|
||||
## Volume Notes
|
||||
|
||||
/var/www/bookstack/storage/uploads – host path /data/bookstack/uploads
|
||||
/var/www/bookstack/public/uploads – host path /data/bookstack/public
|
||||
/var/lib/mysql – host path /data/bookstack/db
|
||||
|
||||
## Network Notes
|
||||
|
||||
Requires proxy network
|
||||
|
||||
## Docker Run
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name bookstack \
|
||||
-p 8080:8080 \
|
||||
-v /data/bookstack/uploads:/var/www/bookstack/storage/uploads \
|
||||
-v /data/bookstack/public:/var/www/bookstack/public/uploads \
|
||||
-v /data/bookstack/db:/var/lib/mysql \
|
||||
solidnerd/bookstack:latest
|
||||
```
|
||||
|
||||
See compose.yaml for the full set of environment variables.
|
||||
|
||||
## Additional Notes / Gotchas
|
||||
|
||||
Nothing specific to this stack so far.
|
||||
|
||||
## Dockhand Stack, Deploy from Git
|
||||
|
||||
Cookbooks Repository
|
||||
stackname: bookstack
|
||||
Compose file path: bookstack/compose.yaml
|
||||
Additional env file (optional): bookstack/sample.env
|
||||
|
||||
Then "Load" bookstack/sample.env into the Environmental variables in dockhand
|
||||
|
||||
Create the Stack
|
||||
|
||||
## Notes
|
||||
|
||||
### APP_KEY
|
||||
|
||||
Reference in New Issue
Block a user