mirror of
https://github.com/hassio-addons/repository-edge.git
synced 2025-05-04 11:11:25 +00:00
⬆️ Updating add-on Folding@home to 65580fd
This commit is contained in:
parent
e48bd0ca84
commit
1cf9ba692b
5 changed files with 159 additions and 9 deletions
|
@ -926,10 +926,10 @@ SOFTWARE.
|
|||
[phlex-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
||||
[phlex-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
||||
[phlex-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
||||
[addon-foldingathome]: https://github.com/hassio-addons/addon-foldingathome/tree/85bfabc
|
||||
[addon-doc-foldingathome]: https://github.com/hassio-addons/addon-foldingathome/blob/85bfabc/README.md
|
||||
[addon-foldingathome]: https://github.com/hassio-addons/addon-foldingathome/tree/65580fd
|
||||
[addon-doc-foldingathome]: https://github.com/hassio-addons/addon-foldingathome/blob/65580fd/README.md
|
||||
[foldingathome-issue]: https://github.com/hassio-addons/addon-foldingathome/issues
|
||||
[foldingathome-version-shield]: https://img.shields.io/badge/version-85bfabc-blue.svg
|
||||
[foldingathome-version-shield]: https://img.shields.io/badge/version-65580fd-blue.svg
|
||||
[foldingathome-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/foldingathome-amd64.svg
|
||||
[foldingathome-aarch64-shield]: https://img.shields.io/badge/aarch64-no-red.svg
|
||||
[foldingathome-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
# Changelog since v0.1.1
|
||||
- ✏ Split add-on documentation
|
||||
- ⬆ Upgrades fahclient to 7.6.13
|
||||
- 🔨 Implement OCI image specification on labels
|
||||
- ⬆ Upgrades add-on base image to v3.2.0
|
||||
|
|
152
foldingathome/DOCS.md
Normal file
152
foldingathome/DOCS.md
Normal file
|
@ -0,0 +1,152 @@
|
|||
# Home Assistant Community Add-on: Folding@home
|
||||
|
||||
Folding@home (FAH or F@h) is a distributed computing project for performing
|
||||
molecular dynamics simulations of protein dynamics. Its initial focus was on
|
||||
protein folding but has shifted to more biomedical problems, such as Alzheimer's
|
||||
disease, cancer, Ebola and the coronavirus.
|
||||
|
||||
The project uses the idle processing resources of personal computers owned by
|
||||
volunteers who have installed the software on their systems.
|
||||
|
||||
Now you can donate the idle time of your Home Assistant instance to the
|
||||
Folding@home project, helping to fight these diseases.
|
||||
|
||||
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.
|
||||
|
||||
## 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 [Franck Nijhof][frenck].
|
||||
|
||||
For a full list of all authors and contributors,
|
||||
check [the contributor's page][contributors].
|
||||
|
||||
## License
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020 Franck Nijhof
|
||||
|
||||
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-foldingathome/graphs/contributors
|
||||
[discord-ha]: https://discord.gg/c5DvZ4e
|
||||
[discord]: https://discord.me/hassioaddons
|
||||
[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-folding-home/180496?u=frenck
|
||||
[frenck]: https://github.com/frenck
|
||||
[issue]: https://github.com/hassio-addons/addon-foldingathome/issues
|
||||
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
|
||||
[reddit]: https://reddit.com/r/homeassistant
|
||||
[releases]: https://github.com/hassio-addons/addon-foldingathome/releases
|
||||
[semver]: http://semver.org/spec/v2.0.0.htm
|
|
@ -21,8 +21,6 @@ Folding@home project, helping to fight these diseases.
|
|||
|
||||
Join the Home Assistant Folding@home team! (id: 247478)
|
||||
|
||||
[Click here for the full documentation][docs]
|
||||
|
||||
![Folding@home in the Home Assistant Frontend][screenshot]
|
||||
|
||||
## WARNING! THIS IS AN EDGE VERSION!
|
||||
|
@ -46,7 +44,6 @@ If you are more interested in stable releases of our add-ons:
|
|||
|
||||
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
||||
[discord]: https://discord.me/hassioaddons
|
||||
[docs]: https://github.com/hassio-addons/addon-foldingathome/blob/85bfabc/README.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
|
||||
[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
|
||||
|
@ -55,6 +52,6 @@ If you are more interested in stable releases of our add-ons:
|
|||
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
|
||||
[patreon]: https://www.patreon.com/frenck
|
||||
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
|
||||
[release-shield]: https://img.shields.io/badge/version-85bfabc-blue.svg
|
||||
[release]: https://github.com/hassio-addons/addon-foldingathome/tree/85bfabc
|
||||
[release-shield]: https://img.shields.io/badge/version-65580fd-blue.svg
|
||||
[release]: https://github.com/hassio-addons/addon-foldingathome/tree/65580fd
|
||||
[screenshot]: https://github.com/hassio-addons/addon-foldingathome/raw/master/images/screenshot.png
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "Folding@home",
|
||||
"version": "85bfabc",
|
||||
"version": "65580fd",
|
||||
"slug": "foldingathome",
|
||||
"description": "Fighting disease with a world wide distributed super computer",
|
||||
"url": "https://github.com/hassio-addons/addon-foldingathome",
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue