diff --git a/README.md b/README.md index a04747fe2..e289568e1 100644 --- a/README.md +++ b/README.md @@ -746,10 +746,10 @@ SOFTWARE. [appdaemon-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [appdaemon-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [appdaemon-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-bookstack]: https://github.com/hassio-addons/addon-bookstack/tree/a33fdf7 -[addon-doc-bookstack]: https://github.com/hassio-addons/addon-bookstack/blob/a33fdf7/README.md +[addon-bookstack]: https://github.com/hassio-addons/addon-bookstack/tree/c8f542a +[addon-doc-bookstack]: https://github.com/hassio-addons/addon-bookstack/blob/c8f542a/README.md [bookstack-issue]: https://github.com/hassio-addons/addon-bookstack/issues -[bookstack-version-shield]: https://img.shields.io/badge/version-a33fdf7-blue.svg +[bookstack-version-shield]: https://img.shields.io/badge/version-c8f542a-blue.svg [bookstack-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [bookstack-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [bookstack-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg diff --git a/bookstack/CHANGELOG.md b/bookstack/CHANGELOG.md index fca62f124..f860c2364 100644 --- a/bookstack/CHANGELOG.md +++ b/bookstack/CHANGELOG.md @@ -1,4 +1,11 @@ # Changelog since v0.12.1 +- ✨ Add options for setting and displaying Appkey (#136) + +* ✨ Add show_appkey option + +* ✨ Add ability to set appkey on startup + +* 📚 Update Documentation for new options - Bump creyD/prettier_action from 3.3 to 4.0 (#134) Bumps [creyD/prettier_action](https://github.com/creyD/prettier_action) from 3.3 to 4.0. diff --git a/bookstack/DOCS.md b/bookstack/DOCS.md index de937d7da..0b3700be9 100644 --- a/bookstack/DOCS.md +++ b/bookstack/DOCS.md @@ -89,6 +89,16 @@ Only applies if a remote MYSQL database is used, the password of the above user. Only applies if a remote MYSQL database is used, the port that the database server is listening on. +### Option: `show_appkey` + +If set to `true`, will show the currently configured appkey in the addon logs. +This should be recorded in case of a restore. + +### Option: `appkey` + +Allows the appkey to be defined by the user, in case of restoring from another +system. Will automatically be removed from config on first run if set. + ### Option: `envvars` This allows the setting of Environment Variables to control Bookstack diff --git a/bookstack/README.md b/bookstack/README.md index 8ff167615..0cb6dc21d 100644 --- a/bookstack/README.md +++ b/bookstack/README.md @@ -42,6 +42,6 @@ If you are more interested in stable releases of our add-ons: [forum]: https://community.home-assistant.io/?u=frenck [maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg -[release-shield]: https://img.shields.io/badge/version-a33fdf7-blue.svg -[release]: https://github.com/hassio-addons/addon-bookstack/tree/a33fdf7 +[release-shield]: https://img.shields.io/badge/version-c8f542a-blue.svg +[release]: https://github.com/hassio-addons/addon-bookstack/tree/c8f542a [screenshot]: https://github.com/hassio-addons/addon-bookstack/raw/main/images/screenshot.png \ No newline at end of file diff --git a/bookstack/config.json b/bookstack/config.json index 8236b2dfd..0c4bf2f06 100644 --- a/bookstack/config.json +++ b/bookstack/config.json @@ -1,6 +1,6 @@ { "name": "Bookstack", - "version": "a33fdf7", + "version": "c8f542a", "slug": "bookstack", "description": "Simple & Free Wiki Software", "url": "https://github.com/hassio-addons/addon-bookstack", @@ -37,6 +37,8 @@ "remote_mysql_username": "str?", "remote_mysql_password": "password?", "remote_mysql_port": "int?", + "show_appkey": "bool?", + "appkey": "str?", "log_level": "list(trace|debug|info|notice|warning|error|fatal)?", "certfile": "str", "keyfile": "str",