mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-09 17:31:03 +01:00
188 lines
7.0 KiB
Markdown
188 lines
7.0 KiB
Markdown
# Home Assistant Community Add-on: Spotweb
|
|
|
|
[Spotweb][spotweb] is a decentralized usenet community based on the [Spotnet][spotnet] protocol. Please support the developers of this software at
|
|
[spotweb].
|
|
|
|
## Installation
|
|
|
|
The installation of this add-on is pretty straightforward and not different in
|
|
comparison to installing any other Home Assistant add-on.
|
|
|
|
1. [Add my Hass.io add-ons repository][repository] to your Hass.io instance.
|
|
1. Make sure that the MariaDB addon is installed or use a remote MySQL server.
|
|
1. Install the Spotweb add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
1. Carefully configure the add-on to your preferences, see the official documentation for for that.
|
|
|
|
This addon will automatically configure and create the database. These steps can be skipped following the official documentation.
|
|
All you have to do: enter your usenet server details and your download client (eg: nzbget).
|
|
|
|
## Configuration Spotweb
|
|
|
|
The official documentation mentions:
|
|
Please run 'http://yourdomain.com/install.php' from within your browser before attempting anything further with Spotweb and make sure all items are checked 'OK'.
|
|
These steps can be skipped as this addon will automatically configure and create the database.
|
|
|
|
All you have to do: enter your usenet server details and your download client (eg: nzbget).
|
|
|
|
**Note**: Spots are retrieved via an hourly cron job. It can take up to an hour before the spots start appearing.
|
|
Depending on the specs of your system, it can take more than 24 hours before all spots are retrieved.
|
|
|
|
## Configuration Addon
|
|
|
|
**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
|
|
```
|
|
|
|
**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: `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.
|
|
|
|
## Database usage
|
|
|
|
By default, spotweb 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
|
|
|
|
When configuring the download client (NZB handling), 'addon_62c7908d_nzbget_docker' is automatically filled in as hostname of nzbget.
|
|
You'll have to lookup the correct hostname of your nzbget addon. It is usually 'local-nzbget'.
|
|
|
|
## 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 [Wouter Coppens][woutercoppens].
|
|
|
|
For a full list of all authors and contributors,
|
|
check [the contributor's page][contributors].
|
|
|
|
## License
|
|
|
|
MIT License
|
|
|
|
Copyright (c) 2021 Wouter Coppens
|
|
|
|
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.
|
|
|
|
[spotnet]: https://github.com/spotnet/spotnet/wiki
|
|
[spotweb]: https://github.com/spotweb/spotweb
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|
|
[contributors]: https://github.com/alexbelgium/spotweb/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
|
|
[woutercoppens]: https://github.com/woutercoppens
|
|
[issue]: https://github.com/alexbelgium/hassio-addons/issues
|
|
[reddit]: https://reddit.com/r/homeassistant
|
|
[releases]: https://github.com/alexbelgium/hassio-addons/releases
|
|
[semver]: http://semver.org/spec/v2.0.0
|