diff --git a/README.md b/README.md index 79947ae1..c4382e50 100644 --- a/README.md +++ b/README.md @@ -1106,10 +1106,10 @@ SOFTWARE. [tautulli-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [tautulli-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [tautulli-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-thelounge]: https://github.com/hassio-addons/addon-thelounge/tree/v0.9.1 -[addon-doc-thelounge]: https://github.com/hassio-addons/addon-thelounge/blob/v0.9.1/README.md +[addon-thelounge]: https://github.com/hassio-addons/addon-thelounge/tree/v0.9.2 +[addon-doc-thelounge]: https://github.com/hassio-addons/addon-thelounge/blob/v0.9.2/README.md [thelounge-issue]: https://github.com/hassio-addons/addon-thelounge/issues -[thelounge-version-shield]: https://img.shields.io/badge/version-v0.9.1-blue.svg +[thelounge-version-shield]: https://img.shields.io/badge/version-v0.9.2-blue.svg [thelounge-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/thelounge-armhf.svg [thelounge-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [thelounge-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/thelounge/CHANGELOG.md b/thelounge/CHANGELOG.md index dc3e98be..414c07e5 100644 --- a/thelounge/CHANGELOG.md +++ b/thelounge/CHANGELOG.md @@ -2,11 +2,12 @@ ## Changes -- :arrow_up: Upgrades add-on base image to v7.0.3 -- :arrow_up: Upgrades The Lounge to 4.1.0 +- ⬆ Upgrades add-on base image to v7.2.0 +- 🔨 Implement OCI image specification on labels +- ✏ Split add-on documentation [Full Changelog][changelog] -[changelog]: https://github.com/hassio-addons/addon-thelounge/compare/v0.9.0...v0.9.1 -[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-thelounge/badges/v0.9.1/pipeline.svg +[changelog]: https://github.com/hassio-addons/addon-thelounge/compare/v0.9.1...v0.9.2 +[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-thelounge/badges/v0.9.2/pipeline.svg [gitlabci]: https://gitlab.com/hassio-addons/addon-thelounge/pipelines diff --git a/thelounge/DOCS.md b/thelounge/DOCS.md new file mode 100644 index 00000000..f864d5c4 --- /dev/null +++ b/thelounge/DOCS.md @@ -0,0 +1,159 @@ +# Home Assistant Community Add-on: The Lounge + +A self-hosted web IRC client that uses a modern and sleek interface with +support for theming, push notifications, link previews, file uploads and +more. Fully cross-platform and mobile friendly. + +## 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 "The Lounge" add-on in the Supervisor add-on store + and install it. +1. Configure the "The Lounge" add-on. (See below) +1. Start the "The Lounge" add-on. +1. Check the logs of the "The Lounge" add-on to see it in action. +1. Click "Open Web UI". + +## 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 +default_theme: default +themes: + - thelounge-theme-material +users: + - hassio +``` + +### 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 app. 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: `default_theme` + +The default theme for each user. The pre-installed themes are `default` and + `morning`. You can add more using the next option. + +**Note**: _The theme can still be changed in the settings of the app_ + +### Option: `themes` + +A list of themes to install which can be found in the [npm registry][themes]. + Use the name of the package. (refer to the example above) + +### Option: `users` + +A list of users to setup. At first, these will use the default password + `hassio`. **Make sure you change your password as soon as you login!** + +## 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] on 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. + +[contributors]: https://github.com/hassio-addons/addon-thelounge/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/?u=timmo001 +[issue]: https://github.com/hassio-addons/addon-thelounge/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-thelounge/releases +[semver]: http://semver.org/spec/v2.0.0.htm +[themes]: https://www.npmjs.com/search?q=keywords%3Athelounge-theme +[timmo]: https://github.com/timmo001 diff --git a/thelounge/README.md b/thelounge/README.md index 4f7c3c85..91350b7f 100644 --- a/thelounge/README.md +++ b/thelounge/README.md @@ -16,8 +16,6 @@ A self-hosted web IRC client that uses a modern and sleek interface with ![Screenshot][screenshot] -[Click here for the full documentation][docs] - ## WARNING! THIS IS A BETA VERSION! This Home Assistant Add-ons repository contains beta releases of add-ons. @@ -39,7 +37,6 @@ 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-thelounge/blob/v0.9.1/README.md [forest-theme]: https://raw.githubusercontent.com/timmo001/thelounge/master/docs/resources/forest-theme.png [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/?u=timmo001 @@ -48,7 +45,7 @@ If you are more interested in stable releases of our add-ons: [midnight-theme]: https://raw.githubusercontent.com/timmo001/thelounge/master/docs/resources/midnight-theme.png [more-info-light]: https://raw.githubusercontent.com/timmo001/thelounge/master/docs/resources/more-info-light.png [project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg -[release-shield]: https://img.shields.io/badge/version-v0.9.1-blue.svg -[release]: https://github.com/hassio-addons/addon-thelounge/tree/v0.9.1 +[release-shield]: https://img.shields.io/badge/version-v0.9.2-blue.svg +[release]: https://github.com/hassio-addons/addon-thelounge/tree/v0.9.2 [screenshot]: https://raw.githubusercontent.com/hassio-addons/addon-thelounge/master/images/screenshot.png [thelounge]: https://github.com/timmo001/thelounge \ No newline at end of file diff --git a/thelounge/config.json b/thelounge/config.json index f37d8fc3..6368dd66 100644 --- a/thelounge/config.json +++ b/thelounge/config.json @@ -1,6 +1,6 @@ { "name": "The Lounge", - "version": "0.9.1", + "version": "0.9.2", "slug": "thelounge", "description": "A self-hosted web IRC client", "url": "https://github.com/hassio-addons/addon-thelounge",