From 6449eed86dae1644dc79029ee25780b9b4434a8a Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 21 Feb 2025 13:01:49 +0000 Subject: [PATCH] Github bot : issues linked to readme --- transmission/README.md | 1 - webtop/README.md | 76 +++++++++++++++++++++++++++++++++++++++++- 2 files changed, 75 insertions(+), 2 deletions(-) mode change 120000 => 100644 webtop/README.md diff --git a/transmission/README.md b/transmission/README.md index 6c5abd9b4..557fbe09b 100644 --- a/transmission/README.md +++ b/transmission/README.md @@ -1,4 +1,3 @@ -## ⚠ Open Issue : [🐛 [Transmission] If defined user and pass, the container start longer and report unhealthy (opened 2025-02-05)](https://github.com/alexbelgium/hassio-addons/issues/1755) by [@myhomeiot](https://github.com/myhomeiot) # Home assistant add-on: Transmission diff --git a/webtop/README.md b/webtop/README.md deleted file mode 120000 index f89d0b987..000000000 --- a/webtop/README.md +++ /dev/null @@ -1 +0,0 @@ -../webtop_kde/README.md \ No newline at end of file diff --git a/webtop/README.md b/webtop/README.md new file mode 100644 index 000000000..b71e18833 --- /dev/null +++ b/webtop/README.md @@ -0,0 +1,75 @@ +# Home assistant add-on: Webtop KDE Alpine + +[![Donate][donation-badge]](https://www.buymeacoffee.com/alexbelgium) +[![Donate][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA) + +![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fwebtop%2Fconfig.json) +![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fwebtop%2Fconfig.json) +![Arch](https://img.shields.io/badge/dynamic/json?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2Fwebtop%2Fconfig.json) + +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9c6cf10bdbba45ecb202d7f579b5be0e)](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade) +[![GitHub Super-Linter](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/weekly-supelinter.yaml?label=Lint%20code%20base)](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml) +[![Builder](https://img.shields.io/github/actions/workflow/status/alexbelgium/hassio-addons/onpush_builder.yaml?label=Builder)](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml) + +[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee%20(no%20paypal)-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white +[paypal-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee%20with%20Paypal-0070BA?logo=paypal&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!_ + +[![Stargazers repo roster for @alexbelgium/hassio-addons](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/.github/stars2.svg)](https://github.com/alexbelgium/hassio-addons/stargazers) + +![downloads evolution](https://raw.githubusercontent.com/alexbelgium/hassio-addons/master/webtop/stats.png) + +## About + +[webtop](https://github.com/webtop/webtop) is a full desktop environments accessible via any modern web browser. +This addon is based on the docker image https://github.com/linuxserver/docker-webtop + +## Configuration + +Webui can be found with ingress or at . The port is by default disabled but can be enabled through the addon options. + +By default the image is based around the abc user and we recommend using this user as all of the init/config is based around it. The default password is also abc . If you want to change this password and require authentication when accessing the interface simply issue passwd inside a gui terminal in the webtop. Then when accessing the web interface use the path: + +http://localhost:3000/?login=true + +Apps installations are not remanent, you need to do it via addon options. Their config, however, is. + +If graphics don't work, use the DRINODE feature to select your graphic device. + +See all potential ENV variables here : https://docs.linuxserver.io/images/docker-webtop#optional-environment-variables + +```yaml +TZ: timezone ; Country/City according to https://manpages.ubuntu.com/manpages/trusty/man3/DateTime::TimeZone::Catalog.3pm.html +additional_apps: engrampa,thunderbird # Allows installation of apps, as they are not persistent +DRINODE: specify a custom graphic device, default is /dev/dri/renderD128 +DNS_servers: 8.8.8.8,1.1.1.1 # Keep blank to use router’s DNS, or set custom DNS to avoid spamming in case of local DNS ad-remover +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 +cifsdomain: "domain" # optional, allow setting the domain for the smb share +``` + +## 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) + [![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](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 + +![illustration](https://www.linuxserver.io/user/pages/content/images/2021/05/menu.png) + +[repository]: https://github.com/alexbelgium/hassio-addons