BookStack is a simple and free, self-hosted, easy-to-use wiki platform for organising and storing information.
You can one-click-deploy this project to balena using the button below:
Alternatively, deployment can be carried out by manually creating a balenaCloud account and application, flashing a device, downloading the project and pushing it via either Git or the balena CLI.
Application envionment variables apply to all services within the application, and can be applied fleet-wide to apply to multiple devices.
| Name | Example | Purpose |
|---|---|---|
TZ |
America/Toronto |
(optional) inform services of the timezone in your location |
MYSQL_ROOT_PASSWORD |
******** |
password that will be set for the MariaDB root account |
APP_URL |
https://<UUID>.balena-devices.com |
for specifying the url your application will be accessed on (required for correct operation of reverse proxy) |
Connect to http://<device-ip>:80 or enable the Public device URL in the dashboard to begin using BookStack.
The default username is admin@admin.com with the password of password.
Ensure you change the password and email address for the default username.
https://www.bookstackapp.com/docs/
Redis an in-memory key-value database that can be used to improve the performance of applications via memory caching, where frequently-requested objects are stored in memory for faster retrieval. I'm not a expert beyond setting it up, but some form of memory caching is recommended for a small performance bump in applications like BookStack and Nextcloud. It is completely optional though, so feel free to remove it from your setup.
https://www.bookstackapp.com/docs/admin/cache-session-config/
The mysqldump service will run every hour and take a snapshot of the mysql database.
This will provide an alternate database recovery method in case of data corruption from power loss, etc.
https://mariadb.com/kb/en/mysqldump/#restoring
I use Duplicati on most of my devices as a way to ensure I have offsite backups of the data in case of SD card corruption or other data loss. It also makes it convenient to migrate the data to a new device or memory card if needed.
Check out the duplicati branch of this repo for an example of adding a Duplicati service.
https://github.com/klutchell/balena-bookstack/tree/duplicati
Please open an issue or submit a pull request with any features, fixes, or changes.