mirror of
https://github.com/hassio-addons/addon-foldingathome.git
synced 2025-05-04 11:21:25 +00:00
✏️ Split add-on documentation
This commit is contained in:
Franck Nijhof
parent
85bfabcdd5
commit
65580fdd2b
3 changed files with 154 additions and 86 deletions
85
README.md
85
README.md
|
|
@ -38,84 +38,7 @@ Join the Home Assistant Folding@home team! (id: 247478)
|
|||
|
||||
Team stats: <https://stats.foldingathome.org/team/247478>
|
||||
|
||||
## 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 "Folding@home" add-on in the add-on store.
|
||||
1. Install the "Folding@home" add-on.
|
||||
1. Start the "Folding@home" add-on.
|
||||
1. Check the logs of the "Folding@home" to see if everything went well.
|
||||
1. Open the Web UI.
|
||||
|
||||
**Note**: By default, the add-on joins the Home Assistant team (id: 247478).
|
||||
|
||||
Team stats: <https://stats.foldingathome.org/team/247478>
|
||||
|
||||
## Configuration
|
||||
|
||||
**Note**: _Remember to restart the add-on when the configuration is changed._
|
||||
|
||||
Example add-on configuration:
|
||||
|
||||
```yaml
|
||||
log_level: info
|
||||
```
|
||||
|
||||
### 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.
|
||||
|
||||
## Embedding into Home Assistant
|
||||
|
||||
It is possible to embed the Folding@home interface directly into Home Assistant,
|
||||
allowing you to access it through the Home Assistant frontend.
|
||||
|
||||
Home Assistant provides the `panel_iframe` integration, for these purposes.
|
||||
|
||||
Example configuration:
|
||||
|
||||
```yaml
|
||||
panel_iframe:
|
||||
foldingathome:
|
||||
title: Folding@home
|
||||
icon: mdi:bacteria-outline
|
||||
url: http://addres.to.your.hass.io:7396
|
||||
```
|
||||
|
||||
## Known issues and limitations
|
||||
|
||||
- This add-on only runs on 64-bits intel-based computers. Folding@home does
|
||||
not support ARM devices (e.g., a Raspberry Pi).
|
||||
|
||||
## 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.
|
||||
[:books: Read the full add-on documentation][docs]
|
||||
|
||||
## Support
|
||||
|
||||
|
|
@ -187,10 +110,10 @@ SOFTWARE.
|
|||
[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-foldingathome.svg
|
||||
[commits]: https://github.com/hassio-addons/addon-foldingathome/commits/master
|
||||
[contributors]: https://github.com/hassio-addons/addon-foldingathome/graphs/contributors
|
||||
[create-db]: https://github.com/hassio-addons/addon-influxdb#integrating-into-home-assistant
|
||||
[discord-ha]: https://discord.gg/c5DvZ4e
|
||||
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||
[discord]: https://discord.me/hassioaddons
|
||||
[docs]: https://github.com/hassio-addons/addon-foldingathome/blob/master/foldingathome/DOCS.md
|
||||
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
||||
[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-folding-home/180496?u=frenck
|
||||
[frenck]: https://github.com/frenck
|
||||
|
|
@ -198,11 +121,8 @@ SOFTWARE.
|
|||
[github-sponsors]: https://github.com/sponsors/frenck
|
||||
[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-foldingathome/badges/master/pipeline.svg
|
||||
[gitlabci]: https://gitlab.com/hassio-addons/addon-foldingathome/pipelines
|
||||
[home-assistant]: https://home-assistant.io
|
||||
[i386-shield]: https://img.shields.io/badge/i386-no-red.svg
|
||||
[influxdb-addon]: https://github.com/hassio-addons/addon-influxdb
|
||||
[issue]: https://github.com/hassio-addons/addon-foldingathome/issues
|
||||
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
|
||||
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-foldingathome.svg
|
||||
[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg
|
||||
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
|
||||
|
|
@ -212,4 +132,3 @@ SOFTWARE.
|
|||
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-foldingathome.svg
|
||||
[releases]: https://github.com/hassio-addons/addon-foldingathome/releases
|
||||
[repository]: https://github.com/hassio-addons/repository
|
||||
[semver]: http://semver.org/spec/v2.0.0.htm
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue