🎉 Release of add-on Bookstack 0.4.3

README.md

@@ -836,10 +836,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.4.2
+[addon-bookstack]: https://github.com/hassio-addons/addon-bookstack/tree/v0.4.3
-[addon-doc-bookstack]: https://github.com/hassio-addons/addon-bookstack/blob/v0.4.2/README.md
+[addon-doc-bookstack]: https://github.com/hassio-addons/addon-bookstack/blob/v0.4.3/README.md
 [bookstack-issue]: https://github.com/hassio-addons/addon-bookstack/issues
-[bookstack-version-shield]: https://img.shields.io/badge/version-v0.4.2-blue.svg
+[bookstack-version-shield]: https://img.shields.io/badge/version-v0.4.3-blue.svg
 [bookstack-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/bookstack-armhf.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/CHANGELOG.md

@@ -1,9 +1,13 @@
 Maintenance Release
 
-- ⬆Update Bookstack to v0.29.3
+- ⬆ Upgrades add-on base image to v7.2.0
+- 🔨 Implement OCI image specification on labels
+- ⬆ Upgrades php7 to 7.3.18-r0
+- ⬆ Upgrades mariadb-client to 10.4.13-r0
+- ✏ Split add-on documentation
 
 Questions? Join our Discord server! https://discord.me/hassioaddons
 
 [Full Changelog][changelog]
 
-[changelog]: https://github.com/hassio-addons/addon-bookstack/compare/v0.4.1...v0.4.2
+[changelog]: https://github.com/hassio-addons/addon-bookstack/compare/v0.4.2...v0.4.3

bookstack/DOCS.md

@@ -0,0 +1,176 @@
+# Home Assistant Community Add-on: Bookstack
+
+BookStack is a simple, self-hosted, easy-to-use platform for organising and
+storing information. Please support the developers of this software at
+[Bookstack].
+
+## Installation
+
+The installation of this add-on is pretty straightforward and not different in
+comparison to installing any other Home Assistant add-on.
+
+1. Search for the "bookstack" add-on in the add-on store and install it.
+1. Start the "bookstack" add-on
+1. Check the logs of the "bookstack" add-on to see if everything went well.
+1. Default login information is admin@admin.com/password.
+
+## Configuration
+
+**Note**: _Remember to restart the add-on when the configuration is changed._
+
+Example add-on configuration:
+
+```yaml
+log_level: info
+ssl: false
+certfile: fullchain.pem
+keyfile: privkey.pem
+```
+
+**Note**: _This is just an example, don't copy and paste it! Create your own!_
+
+### Option: `log_level`
+
+The `log_level` option controls the level of log output by the addon and can
+be changed to be more or less verbose, which might be useful when you are
+dealing with an unknown issue. Possible values are:
+
+- `trace`: Show every detail, like all called internal functions.
+- `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.
+- `fatal`: Something went terribly wrong. Add-on becomes unusable.
+
+Please note that each level automatically includes log messages from a
+more severe level, e.g., `debug` also shows `info` messages. By default,
+the `log_level` is set to `info`, which is the recommended setting unless
+you are troubleshooting.
+
+### Option: `ssl`
+
+Enables/Disables SSL (HTTPS) on the web interface of Bookstack
+Panel. Set it `true` to enable it, `false` otherwise.
+
+### Option: `certfile`
+
+The certificate file to use for SSL.
+
+**Note**: _The file MUST be stored in `/ssl/`, which is the default_
+
+### Option: `keyfile`
+
+The private key file to use for SSL.
+
+**Note**: _The file MUST be stored in `/ssl/`, which is the default_
+
+### Option: `proxy_host`
+
+If using a reverse proxy, the domain configured for example
+`https://www.example.com`.
+
+### Option: `remote_mysql_host`
+
+If using an external database, the hostname/address for the MYSQL/MariaDB
+database.
+
+### Option: `remote_mysql_database`
+
+Only applies if a remote MYSQL database is used, the name of the database.
+
+### Option: `remote_mysql_username`
+
+Only applies if a remote MYSQL database is used, the username with permissions.
+
+### Option: `remote_mysql_password`
+
+Only applies if a remote MYSQL database is used, the password of the above user.
+
+### Option: `remote_mysql_port`
+
+Only applies if a remote MYSQL database is used, the port that the database
+server is listening on.
+
+## Database usage
+
+By default, Bookstack will automatically use and configure the Home Assistant
+MariaDB addon which should be installed prior to startup, this can be changed
+within the configuration to use an external MySql/MariaDB Database. Please note
+that there is no easy upgrade path between the two options.
+
+## Known issues and limitations
+
+- SMTP support is disabled.
+- Ingress will not function due to the way the application stores image files.
+
+## 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].
+
+Releases are based on [Semantic Versioning][semver], and use the format
+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.
+
+## Support
+
+Got questions?
+
+You have several options to get them answered:
+
+- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on
+  support and feature requests.
+- The [Home Assistant Discord chat server][discord-ha] for general Home
+  Assistant discussions and questions.
+- The Home Assistant [Community Forum][forum].
+- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
+
+You could also [open an issue here][issue] GitHub.
+
+## Authors & contributors
+
+The original setup of this repository is by [Paul Sinclair][sinclairpaul].
+
+For a full list of all authors and contributors,
+check [the contributor's page][contributors].
+
+## License
+
+MIT License
+
+Copyright (c) 2019-2020 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+[bookstack]: https://www.bookstackapp.com/
+[contributors]: https://github.com/hassio-addons/addon-bookstack/graphs/contributors
+[discord-ha]: https://discord.gg/c5DvZ4e
+[discord]: https://discord.me/hassioaddons
+[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

bookstack/README.md

@@ -13,8 +13,6 @@ Bookstack: Simple & Free Wiki Software.
 BookStack is a simple, self-hosted, easy-to-use platform for organising and
 storing information.
 
-[Click here for the full documentation][docs]
-
 ![Bookstack screenshot][screenshot]
 
 ## WARNING! THIS IS A BETA VERSION!
@@ -37,11 +35,10 @@ If you are more interested in stable releases of our add-ons:
 [buymeacoffee]: https://www.buymeacoffee.com/sinclairpaul
 [discord-shield]: https://img.shields.io/discord/478094546522079232.svg
 [discord]: https://discord.me/hassioaddons
-[docs]: https://github.com/hassio-addons/addon-bookstack/blob/v0.4.2/README.md
 [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
 [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
-[release-shield]: https://img.shields.io/badge/version-v0.4.2-blue.svg
+[release-shield]: https://img.shields.io/badge/version-v0.4.3-blue.svg
-[release]: https://github.com/hassio-addons/addon-bookstack/tree/v0.4.2
+[release]: https://github.com/hassio-addons/addon-bookstack/tree/v0.4.3
 [screenshot]: https://github.com/hassio-addons/addon-bookstack/raw/master/images/screenshot.png

bookstack/config.json

@@ -1,6 +1,6 @@
 {
   "name": "Bookstack",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "slug": "bookstack",
   "description": "Simple & Free Wiki Software",
   "url": "https://github.com/hassio-addons/addon-bookstack",