mirror of
https://github.com/hassio-addons/addon-thelounge.git
synced 2025-05-04 19:11:27 +00:00
✏️ Split add-on documentation
This commit is contained in:
Franck Nijhof
parent
729b4fec1a
commit
d59624d837
3 changed files with 162 additions and 106 deletions
106
README.md
106
README.md
|
|
@ -27,104 +27,10 @@ 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.
|
||||
|
||||
[:books: Read the full add-on documentation][docs]
|
||||
|
||||
![Screenshot][screenshot]
|
||||
|
||||
## 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?
|
||||
|
|
@ -200,25 +106,19 @@ SOFTWARE.
|
|||
[discord-ha]: https://discord.gg/c5DvZ4e
|
||||
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||
[discord]: https://discord.me/hassioaddons
|
||||
[dockerhub]: https://hub.docker.com/r/hassioaddons/thelounge
|
||||
[docs]: https://github.com/hassio-addons/addon-thelounge/blob/master/thelounge/DOCS.md
|
||||
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||||
[forum]: https://community.home-assistant.io/?u=timmo001
|
||||
[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-thelounge/badges/master/pipeline.svg
|
||||
[gitlabci]: https://gitlab.com/hassio-addons/addon-thelounge/pipelines
|
||||
[hass]: https://www.home-assistant.io/
|
||||
[home-assistant]: https://home-assistant.io
|
||||
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
||||
[issue]: https://github.com/hassio-addons/addon-thelounge/issues
|
||||
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
|
||||
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-thelounge.svg
|
||||
[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg
|
||||
[microbadger]: https://microbadger.com/images/hassioaddons/thelounge
|
||||
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
|
||||
[reddit]: https://reddit.com/r/homeassistant
|
||||
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-thelounge.svg
|
||||
[releases]: https://github.com/hassio-addons/addon-thelounge/releases
|
||||
[repository]: https://github.com/hassio-addons/repository
|
||||
[screenshot]: https://raw.githubusercontent.com/hassio-addons/addon-thelounge/master/images/screenshot.png
|
||||
[semver]: http://semver.org/spec/v2.0.0.htm
|
||||
[themes]: https://www.npmjs.com/search?q=keywords%3Athelounge-theme
|
||||
[timmo]: https://github.com/timmo001
|
||||
|
|
|
|||
|
|
@ -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]
|
||||
|
||||
{% if channel == "edge" %}
|
||||
## WARNING! THIS IS AN EDGE VERSION!
|
||||
|
||||
|
|
@ -62,7 +60,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]: {{ repo }}/blob/{{ version }}/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
|
||||
|
|
|
|||
159
thelounge/DOCS.md
Normal file
159
thelounge/DOCS.md
Normal file
|
|
@ -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
|
||||
Loading…
Add table
Add a link
Reference in a new issue