diff --git a/README.md b/README.md index 9cf4d8cf..a3989909 100644 --- a/README.md +++ b/README.md @@ -811,10 +811,10 @@ SOFTWARE. [bitwarden-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg [bitwarden-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [bitwarden-i386-shield]: https://img.shields.io/badge/i386-no-red.svg -[addon-bookstack]: https://github.com/hassio-addons/addon-bookstack/tree/v0.7.0 -[addon-doc-bookstack]: https://github.com/hassio-addons/addon-bookstack/blob/v0.7.0/README.md +[addon-bookstack]: https://github.com/hassio-addons/addon-bookstack/tree/v0.8.0 +[addon-doc-bookstack]: https://github.com/hassio-addons/addon-bookstack/blob/v0.8.0/README.md [bookstack-issue]: https://github.com/hassio-addons/addon-bookstack/issues -[bookstack-version-shield]: https://img.shields.io/badge/version-v0.7.0-blue.svg +[bookstack-version-shield]: https://img.shields.io/badge/version-v0.8.0-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 f9152eab..1e8ad7f7 100644 --- a/bookstack/CHANGELOG.md +++ b/bookstack/CHANGELOG.md @@ -1,10 +1,22 @@ -Maintenance release: +## What’s changed -- ⬆ Update Bookstack to v0.31.3 -- ⬆ Update php to 7.3.26-r0 +## ✨ New features -Questions? Join our Discord server! https://discord.me/hassioaddons +- ✨ Add envvars option to configuration @sinclairpaul (#32) -[Full Changelog][changelog] +## 🧰 Maintenance -[changelog]: https://github.com/hassio-addons/addon-bookstack/compare/v0.6.4...v0.7.0 \ No newline at end of file +- 🔨 Update CI @sinclairpaul (#25) +- 📚 Update year @sinclairpaul (#27) +- 🔨 Remove no longer needed gitlab config @sinclairpaul (#29) +- 📚 Update Code of Conduct @sinclairpaul (#28) +- Fix add-on description extraction @frenck (#33) + +## 📚 Documentation + +- 📚 Documentation updates @sinclairpaul (#31) +- 📚 Fix commit activity @sinclairpaul (#34) + +## ⬆️ Dependency updates + +- ⬆ Update image to 9.0.1 and package dependencies @sinclairpaul (#30) diff --git a/bookstack/DOCS.md b/bookstack/DOCS.md index 7426dabd..f56a3883 100644 --- a/bookstack/DOCS.md +++ b/bookstack/DOCS.md @@ -25,6 +25,9 @@ log_level: info ssl: false certfile: fullchain.pem keyfile: privkey.pem +envvars: + - name: SESSION_COOKIE_NAME + value: bookstack_session ``` **Note**: _This is just an example, don't copy and paste it! Create your own!_ @@ -39,7 +42,7 @@ dealing with an unknown issue. Possible values are: - `debug`: Shows detailed debug information. - `info`: Normal (usually) interesting events. - `warning`: Exceptional occurrences that are not errors. -- `error`: Runtime errors that do not require immediate action. +- `error`: Runtime errors that do not require immediate action. - `fatal`: Something went terribly wrong. Add-on becomes unusable. Please note that each level automatically includes log messages from a @@ -91,6 +94,27 @@ 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: `envvars` + +This allows the setting of Environment Variables to control Bookstack +configuration as documented at: + + + +**Note**: _Changing these options can possibly cause issues with you instance. +USE AT YOUR OWN RISK!_ + +These are case sensitive and any items set by specific configuration will take +precedence. + +#### Sub-option: `name` + +The name of the environment variable to set. + +#### Sub-option: `value` + +The value of the environment variable to set. + ## Database usage By default, Bookstack will automatically use and configure the Home Assistant @@ -106,16 +130,15 @@ that there is no easy upgrade path between the two options. ## Changelog & Releases This repository keeps a change log using [GitHub's releases][releases] -functionality. The format of the log is based on -[Keep a Changelog][keepchangelog]. +functionality. Releases are based on [Semantic Versioning][semver], and use the format -of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented based on the following: -- ``MAJOR``: Incompatible or major changes. -- ``MINOR``: Backwards-compatible new features and enhancements. -- ``PATCH``: Backwards-compatible bugfixes and package updates. +- `MAJOR`: Incompatible or major changes. +- `MINOR`: Backwards-compatible new features and enhancements. +- `PATCH`: Backwards-compatible bugfixes and package updates. ## Support @@ -143,7 +166,7 @@ check [the contributor's page][contributors]. MIT License -Copyright (c) 2019-2020 Paul Sinclair +Copyright (c) 2019-2021 Paul Sinclair Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -170,7 +193,6 @@ SOFTWARE. [forum]: https://community.home-assistant.io/t/community-hass-io-xxxxx/xxxxx [sinclairpaul]: https://github.com/sinclairpaul [issue]: https://github.com/hassio-addons/addon-bookstack/issues -[keepchangelog]: http://keepachangelog.com/en/1.0.0/ [reddit]: https://reddit.com/r/homeassistant [releases]: https://github.com/hassio-addons/addon-bookstack/releases [semver]: http://semver.org/spec/v2.0.0 diff --git a/bookstack/README.md b/bookstack/README.md index df961a3f..5d6b0835 100644 --- a/bookstack/README.md +++ b/bookstack/README.md @@ -37,8 +37,8 @@ If you are more interested in stable releases of our add-ons: [discord]: https://discord.me/hassioaddons [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/?u=frenck -[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg +[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-v0.7.0-blue.svg -[release]: https://github.com/hassio-addons/addon-bookstack/tree/v0.7.0 +[release-shield]: https://img.shields.io/badge/version-v0.8.0-blue.svg +[release]: https://github.com/hassio-addons/addon-bookstack/tree/v0.8.0 [screenshot]: https://github.com/hassio-addons/addon-bookstack/raw/master/images/screenshot.png \ No newline at end of file diff --git a/bookstack/config.json b/bookstack/config.json index be51bbcd..0b0f7827 100644 --- a/bookstack/config.json +++ b/bookstack/config.json @@ -1,12 +1,11 @@ { "name": "Bookstack", - "version": "0.7.0", + "version": "0.8.0", "slug": "bookstack", "description": "Simple & Free Wiki Software", "url": "https://github.com/hassio-addons/addon-bookstack", "webui": "[PROTO:ssl]://[HOST]:[PORT:80]", "init": false, - "startup": "application", "arch": [ "aarch64", "amd64", @@ -14,9 +13,7 @@ "armv7", "i386" ], - "boot": "auto", "hassio_api": true, - "hassio_role": "default", "services": [ "mysql:want" ], @@ -30,6 +27,7 @@ "80/tcp": "Web interface" }, "options": { + "envvars": [], "ssl": false, "certfile": "fullchain.pem", "keyfile": "privkey.pem" @@ -44,7 +42,13 @@ "log_level": "list(trace|debug|info|notice|warning|error|fatal)?", "certfile": "str", "keyfile": "str", - "ssl": "bool" + "ssl": "bool", + "envvars": [ + { + "name": "str", + "value": "str" + } + ] }, - "image": "hassioaddons/bookstack-{arch}" + "image": "ghcr.io/hassio-addons/bookstack/{arch}" } \ No newline at end of file