mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-11 10:21:02 +01:00
68 lines
3.9 KiB
Markdown
68 lines
3.9 KiB
Markdown
# Home assistant add-on: Webtrees
|
|
|
|
[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
|
|
|
|
|
|
|
|
|
|
[](https://github.com/marketplace/actions/super-linter)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
## About
|
|
|
|
[webtrees](http://www.webtrees.net) is the web's leading online collaborative genealogy application.
|
|
|
|
This addon is based on the docker image https://github.com/NathanVaughn/webtrees-docker
|
|
|
|
## Configuration
|
|
|
|
Webui can be found at <http://your-ip:PORT>.
|
|
The default username/password : described in the startup log (admin:mybadpassword), please change it as soon as possible from the users admin page (yoursite:yourport/index.php?route=%2Fadmin%2Fadmin-users).
|
|
|
|
Options can be configured through two ways :
|
|
|
|
- Addon options
|
|
|
|
```yaml
|
|
LANG: "en-US" # Default language for webtrees
|
|
BASE_URL: "http://192.168.178.69" # The url with which you access webtrees
|
|
DB_TYPE: "sqlite" # Your database type : sqlite for automatic configuration, or external for manual config
|
|
CONFIG_LOCATION: location of the config.yaml (see below)
|
|
localdisks: sda1 #put the hardware name of your drive to mount separated by commas, or its label. Ex: sda1, sdb1, MYNAS...
|
|
networkdisks: "//SERVER/SHARE" # optional, list of smb servers to mount, separated by commas
|
|
cifsusername: "username" # optional, smb username, same for all smb shares
|
|
cifspassword: "password" # optional, smb password
|
|
```
|
|
|
|
- Config.yaml
|
|
|
|
Custom env variables can be added to the config.yaml file referenced in the addon options. Full env variables can be found here : https://github.com/linuxserver/docker-paperless-ng. It must be entered in a valid yaml format, that is verified at launch of the addon.
|
|
|
|
## Installation
|
|
|
|
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
|
|
|
|
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
1. Install this add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Set the add-on options to your preferences
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
1. Open the webUI and adapt the software options
|
|
|
|
## Support
|
|
|
|
Create an issue on github
|
|
|
|
## Illustration
|
|
|
|
|