diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index e31f3a8..81e4173 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -168,7 +168,7 @@ jobs: file: ${{ needs.information.outputs.target }}/Dockerfile cache-from: | type=local,src=/tmp/.docker-cache - ghcr.io/hassio-addons/${{ needs.information.outputs.slug }}/${{ matrix.architecture }}:edge + ghcr.io/erik73/${{ needs.information.outputs.slug }}/${{ matrix.architecture }}:edge cache-to: type=local,mode=max,dest=/tmp/.docker-cache platforms: ${{ steps.flags.outputs.platform }} build-args: | diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index 1190d75..6042fff 100644 --- a/.github/workflows/deploy.yaml +++ b/.github/workflows/deploy.yaml @@ -111,14 +111,14 @@ jobs: push: true # yamllint disable rule:line-length tags: | - ghcr.io/hassio-addons/${{ needs.information.outputs.slug }}/${{ matrix.architecture }}:${{ needs.information.outputs.environment }} - ghcr.io/hassio-addons/${{ needs.information.outputs.slug }}/${{ matrix.architecture }}:${{ needs.information.outputs.version }} + ghcr.io/erik73/${{ needs.information.outputs.slug }}/${{ matrix.architecture }}:${{ needs.information.outputs.environment }} + ghcr.io/erik73/${{ needs.information.outputs.slug }}/${{ matrix.architecture }}:${{ needs.information.outputs.version }} # yamllint enable rule:line-length context: ${{ needs.information.outputs.target }} file: ${{ needs.information.outputs.target }}/Dockerfile cache-from: | type=local,src=/tmp/.docker-cache - ghcr.io/hassio-addons/${{ needs.information.outputs.slug }}/${{ matrix.architecture }}:edge + ghcr.io/erik73/${{ needs.information.outputs.slug }}/${{ matrix.architecture }}:edge cache-to: type=local,mode=max,dest=/tmp/.docker-cache platforms: ${{ steps.flags.outputs.platform }} build-args: | @@ -145,7 +145,7 @@ jobs: uses: peter-evans/repository-dispatch@v1.1.3 with: token: ${{ secrets.DISPATCH_TOKEN }} - repository: hassio-addons/repository-edge + repository: erik73/repository-edge event-type: update client-payload: > { @@ -171,7 +171,7 @@ jobs: uses: peter-evans/repository-dispatch@v1.1.3 with: token: ${{ secrets.DISPATCH_TOKEN }} - repository: hassio-addons/repository-beta + repository: erik73/repository-beta event-type: update client-payload: > { @@ -195,7 +195,7 @@ jobs: uses: peter-evans/repository-dispatch@v1.1.3 with: token: ${{ secrets.DISPATCH_TOKEN }} - repository: hassio-addons/repository + repository: erik73/repository event-type: update client-payload: > { diff --git a/steve/.README.j2 b/steve/.README.j2 new file mode 100644 index 0000000..f7d11da --- /dev/null +++ b/steve/.README.j2 @@ -0,0 +1,67 @@ +# 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. + +![Bookstack screenshot][screenshot] + +{% if channel == "edge" %} +## WARNING! THIS IS AN EDGE VERSION! + +This Home Assistant Add-ons repository contains edge builds of add-ons. +Edge builds add-ons are based upon the latest development version. + +- They may not work at all. +- They might stop working at any time. +- They could have a negative impact on your system. + +This repository was created for: + +- Anybody willing to test. +- Anybody interested in trying out upcoming add-ons or add-on features. +- Developers. + +If you are more interested in stable releases of our add-ons: + + + +{% endif %} +{% if channel == "beta" %} +## WARNING! THIS IS A BETA VERSION! + +This Home Assistant Add-ons repository contains beta releases of add-ons. + +- They might stop working at any time. +- They could have a negative impact on your system. + +This repository was created for: + +- Anybody willing to test. +- Anybody interested in trying out upcoming add-ons or add-on features. + +If you are more interested in stable releases of our add-ons: + + + +{% endif %} +[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 +[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/2021.svg +[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg +[release-shield]: https://img.shields.io/badge/version-{{ version }}-blue.svg +[release]: {{ repo }}/tree/{{ version }} +[screenshot]: https://github.com/hassio-addons/addon-bookstack/raw/master/images/screenshot.png diff --git a/steve/DOCS.md b/steve/DOCS.md new file mode 100644 index 0000000..f56a388 --- /dev/null +++ b/steve/DOCS.md @@ -0,0 +1,198 @@ +# 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 +envvars: + - name: SESSION_COOKIE_NAME + value: bookstack_session +``` + +**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. + +### 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 +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. + +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-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 +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 +[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/steve/README.md b/steve/README.md deleted file mode 100644 index 6ebbd04..0000000 --- a/steve/README.md +++ /dev/null @@ -1,16 +0,0 @@ -# Home Assistant Add-on: SteVe - -SteVe OCPP server for mobile charging stations (Wallbox) supporting the OCPP protocol - -![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] -![Project Stage][project-stage-shield] - -## About - -Important: This addon requires that the MariaDB addon is installed and running! - -This addon is experimental, and provides the SteVe OCPP backend server for HomeAssistant - -[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg -[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg -[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg diff --git a/steve/config.json b/steve/config.json index fe7ef54..677813f 100644 --- a/steve/config.json +++ b/steve/config.json @@ -23,6 +23,12 @@ "httpport": "str", "admin_user": "str", "admin_password": "str", - "log_level": "list(trace|debug|info|notice|warning|error|fatal)?" + "log_level": "list(trace|debug|info|notice|warning|error|fatal)?", + "envvars": [ + { + "name": "str", + "value": "str" + } + ] } }