🎉 Release of add-on Matrix 0.10.0

README.md

@@ -996,10 +996,10 @@ SOFTWARE.
 [mqtt-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
 [mqtt-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
 [mqtt-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
-[addon-matrix]: https://github.com/hassio-addons/addon-matrix/tree/v0.9.0
+[addon-matrix]: https://github.com/hassio-addons/addon-matrix/tree/v0.10.0
-[addon-doc-matrix]: https://github.com/hassio-addons/addon-matrix/blob/v0.9.0/README.md
+[addon-doc-matrix]: https://github.com/hassio-addons/addon-matrix/blob/v0.10.0/README.md
 [matrix-issue]: https://github.com/hassio-addons/addon-matrix/issues
-[matrix-version-shield]: https://img.shields.io/badge/version-v0.9.0-blue.svg
+[matrix-version-shield]: https://img.shields.io/badge/version-v0.10.0-blue.svg
 [matrix-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/matrix-armhf.svg
 [matrix-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
 [matrix-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg

matrix/CHANGELOG.md

@@ -2,18 +2,16 @@
 
 ## Changes
 
-- :books: Update add-on documentation to use new YAML configuration format
+- ⬆ Upgrades musl-dev to 1.1.24-r2
-- :hammer: Re-branding
+- 🔨 Disable Docker init
-- :hammer: Update add-on config with new password & list features
+- 🔨 Implement OCI image specification on labels
-- :hammer: Updates for upstream Supervisor changes
+- ⬆ Updates matrix-synapse to v1.14.0 (#52)
-- :arrow_up: Upgrades postgresql-dev to 12.2-r0
+- ⬆ Upgrades add-on base image to v5.2.1
-- :arrow_up: Upgrades libpq to 12.2-r0
+- ✏ Split add-on documentation
-- :arrow_up: Upgrades riot-web to v1.5.10
+- ⬆ Upgrades riot-web to v1.6.2
-- :arrow_up: Updates matrix-synapse to v1.11.0 (#45)
-- :arrow_up: Upgrades add-on base image to v5.0.2
 
 [Full Changelog][changelog]
 
-[changelog]: https://github.com/hassio-addons/addon-matrix/compare/v0.8.0...v0.9.0
+[changelog]: https://github.com/hassio-addons/addon-matrix/compare/v0.9.0...v0.10.0
-[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-matrix/badges/v0.9.0/pipeline.svg
+[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-matrix/badges/v0.10.0/pipeline.svg
 [gitlabci]: https://gitlab.com/hassio-addons/addon-matrix/pipelines

matrix/DOCS.md

@@ -0,0 +1,167 @@
+# Home Assistant Community Add-on: Matrix
+
+Matrix is a secure and decentralized communication platform served as an
+in-house and open-source alternative for platfoms like Discord or Slack. You
+can connect via your own [clients][clients], or via the Riot web client
+provided from this add-on.
+
+## 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 "Matrix" add-on in the Supervisor add-on store and install it.
+1. Set your `server_name` as the hostname of the instance you will be using.
+ This is an important step for integrating other services later.
+1. Start the "Matrix" add-on.
+1. Check the logs of the "Matrix" add-on to see if everything went well.
+1. Click "Open Web UI".
+1. You can then register via the message that appears at the top of the app.
+1. Change the server address to your own via "Custom server" and set the
+ "Home server URL" to yours. By default this will be
+ `https://yourservername:8448`. You can check this by navigating to this URL
+ and you will be presented with a welcome message.
+
+## Configuration
+
+**Note**: _Remember to restart the add-on when the configuration is changed._
+
+Example add-on configuration:
+
+```yaml
+log_level: info
+ssl: true
+certfile: fullchain.pem
+keyfile: privkey.pem
+server_name: yourddns_url.com
+```
+
+**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.
+
+These log level also affects the log levels of the Matrix.
+
+### Option: `ssl`
+
+Enables/Disables SSL (HTTPS) on the IDE. 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: `server_name`
+
+This is the hostname of your server. Set this to the host that you will be
+connecting to with your clients without the port and without the
+`http://` or`https://`. For example: if your domain name is
+`home-assistant.io` set your `server_name` to this.
+
+**Note**: _You should only set this once. You will likely have to reinstall the
+ addon to change this after the fact, losing all your rooms and users._
+
+### Option: `leave_front_door_open`
+
+Adding this option to the add-on configuration allows you to disable HA
+authentication on the Riot interface by setting it to `true` and leaving the
+username and password empty.
+
+**Note**: _We STRONGLY suggest, not to use this, even if this add-on is
+only exposed to your internal network. USE AT YOUR OWN RISK!_
+
+## 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 [Timmo][timmo].
+
+For a full list of all authors and contributors,
+check [the contributor's page][contributors].
+
+## License
+
+MIT License
+
+Copyright (c) 2019-2020 Timmo
+
+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.
+
+[clients]: https://matrix.org/docs/projects/try-matrix-now.html
+[contributors]: https://github.com/hassio-addons/addon-matrix/graphs/contributors
+[discord-ha]: https://discord.gg/c5DvZ4e
+[discord]: https://discord.me/hassioaddons
+[forum]: https://community.home-assistant.io
+[issue]: https://github.com/hassio-addons/addon-matrix/issues
+[keepchangelog]: http://keepachangelog.com/en/1.0.0/
+[reddit]: https://reddit.com/r/homeassistant
+[releases]: https://github.com/hassio-addons/addon-matrix/releases
+[semver]: http://semver.org/spec/v2.0.0.html
+[timmo]: https://github.com/timmo001

matrix/README.md

@@ -15,8 +15,6 @@ Matrix is a secure and decentralized communication platform served as an
  can connect via your own [clients][clients], or via the Riot web client
  provided from this add-on.
 
-[Click here for the full documentation][docs]
-
 ![Screenshot][screenshot]
 
 ## WARNING! THIS IS A BETA VERSION!
@@ -39,12 +37,11 @@ If you are more interested in stable releases of our add-ons:
 [buymeacoffee]: https://www.buymeacoffee.com/timmo
 [discord-shield]: https://img.shields.io/discord/478094546522079232.svg
 [discord]: https://discord.me/hassioaddons
-[docs]: https://github.com/hassio-addons/addon-matrix/blob/v0.9.0/README.md
 [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
 [forum]: https://community.home-assistant.io
 [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.9.0-blue.svg
+[release-shield]: https://img.shields.io/badge/version-v0.10.0-blue.svg
-[release]: https://github.com/hassio-addons/addon-matrix/tree/v0.9.0
+[release]: https://github.com/hassio-addons/addon-matrix/tree/v0.10.0
 [screenshot]: https://github.com/hassio-addons/addon-matrix/raw/master/images/screenshot.png
 [clients]: https://matrix.org/docs/projects/try-matrix-now.html

matrix/config.json

@@ -1,6 +1,6 @@
 {
   "name": "Matrix",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "slug": "matrix",
   "description": "A secure and decentralized communication platform.",
   "url": "https://github.com/hassio-addons/addon-matrix",
@@ -17,6 +17,7 @@
     "armv7",
     "i386"
   ],
+  "init": false,
   "boot": "auto",
   "hassio_api": true,
   "hassio_role": "default",