marc/spadinastan
Archived
1
0
Fork 0
Code Issues 2 Pull requests Projects 1 Releases Packages Wiki Activity
This repository has been archived on 2024-07-19. You can view files and clone it, but cannot push or open issues or pull requests.
spadinastan/services/bookstack/README.md
Marc Cataford 92d8d3672d
feat(services): bookstack (#33) 
* feat(bookstack): working example bookstack instance

* build(taskfiles): add Taskfile to handle start+stop

* fix: ensure that network exists without erroring

* chore(git): ignore Task bin

* docs: notes on volumes, task commands

* build(taskfiles): add build command, centralized user-supplied env

* refactor(taskfiles): split away internal tasks

* refactor(taskfiles): move environment variables into shared env.yml
2023-12-15 12:40:14 -05:00

960 B
Raw Permalink Blame History

Bookstack

Sets up and manages a Bookstack instance.

Getting started

  • start.sh starts the database and application.
  • stop.sh stops the database and application.
  • build.sh builds images for the database and application and should be run before starting anything.

Any commitable constant can be defined in constants.sh and will be injected in all of the scripts above.

The task commands should be used to interact with the service.

Volumes

This expects two volumes to exist at $APP_DATA_DIR: bookstack-app and bookstack-db.

Note on dotenv files

dotenv files are expected to exist at $ENV_FILE_DIR under bookstack-db.env and bookstack-app.env.

See reference:

# bookstack-db-env

MARIADB_USER=...
MARIADB_PASSWORD=...
MARIADB_ROOT_PASSWORD=...
MARIADB_DATABASE=...

# bookstack-app.env

DB_PORT=...
DB_USER=...
DB_PASS=...
DB_DATABASE=...
DB_HOST=...
APP_URL=...