44 lines
960 B
Markdown
44 lines
960 B
Markdown
|
# Bookstack
|
||
|
|
|
||
|
|
Sets up and manages a [Bookstack](https://www.bookstackapp.com/) 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=...
|
||
|
|
```
|