diff --git a/README.md b/README.md index 37344429..4eb7517a 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,20 @@ Open source password management solution [:books: Bitwarden RS add-on documentation][addon-doc-bitwarden] +### ✓ [Bookstack][addon-bookstack] + +![Latest Version][bookstack-version-shield] +![Supports armhf Architecture][bookstack-armhf-shield] +![Supports armv7 Architecture][bookstack-armv7-shield] +![Supports aarch64 Architecture][bookstack-aarch64-shield] +![Supports amd64 Architecture][bookstack-amd64-shield] +![Supports i386 Architecture][bookstack-i386-shield] +![Docker Pulls][bookstack-pulls-shield] + +Simple & Free Wiki Software + +[:books: Bookstack add-on documentation][addon-doc-bookstack] + ### ✓ [Example][addon-example] ![Latest Version][example-version-shield] @@ -671,6 +685,7 @@ on the correct GitHub repository matching the add-on. - [Open an issue for the add-on: AirSonos][airsonos-issue] - [Open an issue for the add-on: AppDaemon 4][appdaemon-issue] - [Open an issue for the add-on: Bitwarden RS][bitwarden-issue] +- [Open an issue for the add-on: Bookstack][bookstack-issue] - [Open an issue for the add-on: Example][example-issue] - [Open an issue for the add-on: FTP][ftp-issue] - [Open an issue for the add-on: FlexTV][phlex-issue] @@ -815,6 +830,16 @@ 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.1.0 +[addon-doc-bookstack]: https://github.com/hassio-addons/addon-bookstack/blob/v0.1.0/README.md +[bookstack-issue]: https://github.com/hassio-addons/addon-bookstack/issues +[bookstack-version-shield]: https://img.shields.io/badge/version-v0.1.0-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-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[bookstack-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[bookstack-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [addon-example]: https://github.com/hassio-addons/addon-example/tree/v3.3.0 [addon-doc-example]: https://github.com/hassio-addons/addon-example/blob/v3.3.0/README.md [example-issue]: https://github.com/hassio-addons/addon-example/issues diff --git a/bookstack/CHANGELOG.md b/bookstack/CHANGELOG.md new file mode 100644 index 00000000..7f8a8356 --- /dev/null +++ b/bookstack/CHANGELOG.md @@ -0,0 +1,3 @@ +🎉 Initial add-on release 🎉 + +Questions? Join our Discord server! https://discord.me/hassioaddons \ No newline at end of file diff --git a/bookstack/README.md b/bookstack/README.md new file mode 100644 index 00000000..03d5b580 --- /dev/null +++ b/bookstack/README.md @@ -0,0 +1,31 @@ +# Home Assistant Community Add-on: Bookstack + +[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] + +[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum] + +[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee] + +Bookstack: Simple & Free Wiki Software. + +## About + +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] + +[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg +[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.1.0/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.1.0-blue.svg +[release]: https://github.com/hassio-addons/addon-bookstack/tree/v0.1.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 new file mode 100644 index 00000000..9956a5bc --- /dev/null +++ b/bookstack/config.json @@ -0,0 +1,48 @@ +{ + "name": "Bookstack", + "version": "0.1.0", + "slug": "bookstack", + "description": "Simple & Free Wiki Software", + "url": "https://github.com/hassio-addons/addon-bookstack", + "webui": "[PROTO:ssl]://[HOST]:[PORT:80]", + "startup": "application", + "arch": [ + "aarch64", + "amd64", + "armhf", + "armv7", + "i386" + ], + "boot": "auto", + "hassio_api": true, + "hassio_role": "default", + "services": [ + "mysql:want" + ], + "map": [ + "ssl" + ], + "ports": { + "80/tcp": 2665 + }, + "ports_description": { + "80/tcp": "Web interface" + }, + "options": { + "ssl": false, + "certfile": "fullchain.pem", + "keyfile": "privkey.pem" + }, + "schema": { + "remote_mysql_host": "str?", + "remote_mysql_database": "str?", + "remote_mysql_username": "str?", + "remote_mysql_password": "password?", + "remote_mysql_port": "int?", + "log_level": "list(trace|debug|info|notice|warning|error|fatal)?", + "certfile": "str", + "keyfile": "str", + "ssl": "bool" + }, + "image": "hassioaddons/bookstack-{arch}" +} \ No newline at end of file diff --git a/bookstack/icon.png b/bookstack/icon.png new file mode 100644 index 00000000..2eb3c95e Binary files /dev/null and b/bookstack/icon.png differ diff --git a/bookstack/logo.png b/bookstack/logo.png new file mode 100644 index 00000000..d78615a0 Binary files /dev/null and b/bookstack/logo.png differ