From ca726eb819d89e25fdbd9833c4ea799cb84809ea Mon Sep 17 00:00:00 2001 From: Tiger Wang Date: Wed, 8 Mar 2023 19:45:48 -0500 Subject: [PATCH] remove unnecessary properties from docker-compose.yml of each app (#24) --- Apps/2FAuth/docker-compose.yml | 7 +- Apps/AdGuardHome/docker-compose.yml | 21 ++---- Apps/AllTubeDownload/docker-compose.yml | 5 +- Apps/Bazarr/docker-compose.yml | 18 ++--- Apps/Calibre-web/docker-compose.yml | 18 ++--- Apps/CouchPotato/docker-compose.yml | 18 ++--- Apps/Deluge/docker-compose.yml | 24 +++--- Apps/Duplicati/docker-compose.yml | 18 ++--- Apps/Emby/docker-compose.yml | 22 +++--- Apps/Embystat/docker-compose.yml | 14 ++-- Apps/FileBrowser/docker-compose.yml | 16 ++-- Apps/Gitea/docker-compose.yml | 16 ++-- Apps/Grafana/docker-compose.yml | 6 +- Apps/HomeAssistant/docker-compose.yml | 10 +-- Apps/Jackett/docker-compose.yml | 18 ++--- Apps/Jellyfin/docker-compose.yml | 32 ++++---- Apps/Lazylibrarian/docker-compose.yml | 20 ++--- Apps/Lidarr/docker-compose.yml | 18 ++--- Apps/Mylar3/docker-compose.yml | 16 ++-- Apps/N8n/docker-compose.yml | 10 +-- Apps/Nextcloud/docker-compose.yml | 12 +-- Apps/NginxProxyManager/docker-compose.yml | 18 ++--- Apps/Node-RED/docker-compose.yml | 8 +- Apps/Nzbget/docker-compose.yml | 20 ++--- Apps/Ombi/docker-compose.yml | 16 ++-- Apps/OpenHAB/docker-compose.yml | 18 ++--- Apps/OpenSpeedTest/docker-compose.yml | 6 +- Apps/PhotoPrism/docker-compose.yml | 16 ++-- Apps/Pihole/docker-compose.yml | 28 +++---- Apps/Plex/docker-compose.yml | 12 +-- Apps/Prowlarr/docker-compose.yml | 14 ++-- Apps/Radarr/docker-compose.yml | 18 ++--- Apps/Readarr/docker-compose.yml | 18 ++--- Apps/Sabnzbd/docker-compose.yml | 18 ++--- Apps/Sickchill/docker-compose.yml | 18 ++--- Apps/Smokeping/docker-compose.yml | 16 ++-- Apps/Sonarr/docker-compose.yml | 18 ++--- Apps/Syncthing/docker-compose.yml | 24 +++--- Apps/TailscaleDaemon/docker-compose.yml | 14 ++-- Apps/Tautulli/docker-compose.yml | 12 +-- Apps/Transmission/docker-compose.yml | 32 ++++---- Apps/Unifi-controller/docker-compose.yml | 40 +++++----- Apps/UptimeKuma/docker-compose.yml | 8 +- Apps/Vaultwarden/docker-compose.yml | 8 +- Apps/VoceChat/docker-compose.yml | 10 +-- Apps/qBittorrent/docker-compose.yml | 18 ++--- CONTRIBUTING.md | 89 +++++++++++++++++++++++ 47 files changed, 469 insertions(+), 387 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/Apps/2FAuth/docker-compose.yml b/Apps/2FAuth/docker-compose.yml index 97ff619..22ba247 100644 --- a/Apps/2FAuth/docker-compose.yml +++ b/Apps/2FAuth/docker-compose.yml @@ -23,14 +23,13 @@ services: index: / port_map: "8000" ports: - - configurable: "no" + - container: "8000" description: en_US: "" - protocol: tcp - shell: sh + volumes: - - configurable: "no" + - container: /2fauth description: en_US: "" diff --git a/Apps/AdGuardHome/docker-compose.yml b/Apps/AdGuardHome/docker-compose.yml index 0a78666..15bf345 100644 --- a/Apps/AdGuardHome/docker-compose.yml +++ b/Apps/AdGuardHome/docker-compose.yml @@ -38,38 +38,33 @@ services: index: / port_map: "3000" ports: - - configurable: "no" + - container: "53" description: en_US: "" - protocol: tcp - - configurable: "no" + - container: "53" description: en_US: "" - protocol: udp - - configurable: "no" + - container: "3000" description: en_US: "" - protocol: tcp - - configurable: "no" + - container: "853" description: en_US: "" - protocol: tcp - - configurable: "no" + - container: "784" description: en_US: "" - protocol: udp - shell: sh + volumes: - - configurable: "no" + - container: /opt/adguardhome/work description: en_US: "" - - configurable: "no" + - container: /opt/adguardhome/conf description: en_US: "" diff --git a/Apps/AllTubeDownload/docker-compose.yml b/Apps/AllTubeDownload/docker-compose.yml index 4ba442c..3e63692 100644 --- a/Apps/AllTubeDownload/docker-compose.yml +++ b/Apps/AllTubeDownload/docker-compose.yml @@ -19,12 +19,11 @@ services: index: / port_map: "80" ports: - - configurable: "no" + - container: "80" description: en_US: "" - protocol: tcp - shell: sh + description: en_US: Easily download videos from YouTube, Dailymotion, Vimeo and other websites. developer: Rudloff diff --git a/Apps/Bazarr/docker-compose.yml b/Apps/Bazarr/docker-compose.yml index 9f17067..efd5590 100644 --- a/Apps/Bazarr/docker-compose.yml +++ b/Apps/Bazarr/docker-compose.yml @@ -31,36 +31,36 @@ services: category: Media container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" port_map: "6767" ports: - - configurable: "no" + - container: "6767" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /movies description: en_US: "" - - configurable: "no" + - container: /tv description: en_US: "" - - configurable: "no" + - container: /config description: en_US: "" diff --git a/Apps/Calibre-web/docker-compose.yml b/Apps/Calibre-web/docker-compose.yml index 9bc701e..7e99c37 100644 --- a/Apps/Calibre-web/docker-compose.yml +++ b/Apps/Calibre-web/docker-compose.yml @@ -29,37 +29,37 @@ services: category: Media container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" - - configurable: "no" + - container: DOCKER_MODS description: en_US: "" index: / port_map: "8083" ports: - - configurable: "no" + - container: "8083" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /config description: en_US: "" - - configurable: "no" + - container: /books description: en_US: "" diff --git a/Apps/CouchPotato/docker-compose.yml b/Apps/CouchPotato/docker-compose.yml index 969c7ea..faad965 100644 --- a/Apps/CouchPotato/docker-compose.yml +++ b/Apps/CouchPotato/docker-compose.yml @@ -31,37 +31,37 @@ services: category: Media container: envs: - - configurable: "yes" + - container: TZ description: en_US: TimeZone - - configurable: "yes" + - container: PUID description: en_US: Run CouchPotato as specified uid. - - configurable: "yes" + - container: PGID description: en_US: Run CouchPotato as specified gid. index: / port_map: "5050" ports: - - configurable: advanced + - container: "5050" description: en_US: WebUI HTTP Port - protocol: tcp - shell: bash + + volumes: - - configurable: "no" + - container: /config description: en_US: CouchPotato config directory. - - configurable: advanced + - container: /movies description: en_US: CouchPotato movies directory. - - configurable: advanced + - container: /downloads description: en_US: CouchPotato downloads directory. diff --git a/Apps/Deluge/docker-compose.yml b/Apps/Deluge/docker-compose.yml index dcc9a33..ac5e08b 100644 --- a/Apps/Deluge/docker-compose.yml +++ b/Apps/Deluge/docker-compose.yml @@ -35,47 +35,47 @@ services: category: Downloader container: envs: - - configurable: "no" + - container: TZ description: en_US: TimeZone - - configurable: "no" + - container: PUID description: en_US: Run Deluge as specified uid. - - configurable: "no" + - container: PGID description: en_US: Run Deluge as specified gid. - - configurable: "no" + - container: DELUGE_LOGLEVEL description: en_US: 'Deluge Log Level ' index: / port_map: "8112" ports: - - configurable: advanced + - container: "8112" description: en_US: WebUI HTTP Port - protocol: tcp - - configurable: advanced + + - container: "6881" description: en_US: Inbound torrent traffic (TCP) - protocol: tcp - - configurable: advanced + + - container: "6881" description: en_US: Inbound torrent traffic (UDP) protocol: udp - shell: bash + volumes: - - configurable: "no" + - container: /config description: en_US: Deluge config directory. - - configurable: advanced + - container: /DATA description: en_US: Deluge Accessible directory. diff --git a/Apps/Duplicati/docker-compose.yml b/Apps/Duplicati/docker-compose.yml index 6558c86..dc2545b 100644 --- a/Apps/Duplicati/docker-compose.yml +++ b/Apps/Duplicati/docker-compose.yml @@ -31,37 +31,37 @@ services: category: Cloud container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" index: / port_map: "8200" ports: - - configurable: "no" + - container: "8200" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /config description: en_US: "" - - configurable: "no" + - container: /backups description: en_US: "" - - configurable: "no" + - container: /source description: en_US: "" diff --git a/Apps/Emby/docker-compose.yml b/Apps/Emby/docker-compose.yml index 160faa9..fe1aef4 100644 --- a/Apps/Emby/docker-compose.yml +++ b/Apps/Emby/docker-compose.yml @@ -40,42 +40,42 @@ services: category: Media container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" index: / port_map: "8096" ports: - - configurable: "no" + - container: "8096" description: en_US: "" - protocol: tcp - - configurable: "no" + + - container: "8920" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /config description: en_US: "" - - configurable: "no" + - container: /data/tvshows description: en_US: "" - - configurable: "no" + - container: /data/movies description: en_US: "" diff --git a/Apps/Embystat/docker-compose.yml b/Apps/Embystat/docker-compose.yml index 9bfd50c..a368c98 100644 --- a/Apps/Embystat/docker-compose.yml +++ b/Apps/Embystat/docker-compose.yml @@ -25,28 +25,28 @@ services: category: Media container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" port_map: "6555" ports: - - configurable: "no" + - container: "6555" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /config description: en_US: "" diff --git a/Apps/FileBrowser/docker-compose.yml b/Apps/FileBrowser/docker-compose.yml index 2c14ca4..a0ffcab 100644 --- a/Apps/FileBrowser/docker-compose.yml +++ b/Apps/FileBrowser/docker-compose.yml @@ -28,33 +28,33 @@ services: category: Cloud container: envs: - - configurable: "no" + - container: TZ description: en_US: TimeZone - - configurable: "no" + - container: PUID description: en_US: Run FileBrowser as specified uid. - - configurable: "no" + - container: PGID description: en_US: Run FileBrowser as specified gid. index: / port_map: "80" ports: - - configurable: advanced + - container: "80" description: en_US: WebUI Port - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /db description: en_US: FileBrowser database directory. - - configurable: advanced + - container: /srv description: en_US: FileBrowser managed directory. diff --git a/Apps/Gitea/docker-compose.yml b/Apps/Gitea/docker-compose.yml index b2c7192..2d204c1 100644 --- a/Apps/Gitea/docker-compose.yml +++ b/Apps/Gitea/docker-compose.yml @@ -27,30 +27,30 @@ services: category: Developer container: envs: - - configurable: advanced + - container: USER_UID description: en_US: The UID (Unix user ID) of the user that runs Gitea - - configurable: advanced + - container: USER_GID description: en_US: The GID (Unix group ID) of the user that runs Gitea index: / port_map: "3000" ports: - - configurable: advanced + - container: "3000" description: en_US: WebUI Port - protocol: tcp - - configurable: advanced + + - container: "22" description: en_US: SSH Port - protocol: tcp - shell: sh + + volumes: - - configurable: advanced + - container: /data description: en_US: Gitea data directory. diff --git a/Apps/Grafana/docker-compose.yml b/Apps/Grafana/docker-compose.yml index 6169f96..575f9f7 100644 --- a/Apps/Grafana/docker-compose.yml +++ b/Apps/Grafana/docker-compose.yml @@ -19,12 +19,12 @@ services: index: / port_map: "3000" ports: - - configurable: "no" + - container: "3000" description: en_US: "" - protocol: tcp - shell: sh + + description: en_US: 'Grafana open source is open source visualization and analytics software.Visualizations: Fast and flexible client side graphs with a multitude of options. Panel plugins offer many different ways to visualize metrics and logs. Dynamic Dashboards: Create dynamic & reusable dashboards with template variables that appear as dropdowns at the top of the dashboard. Explore Metrics: Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side. Explore Logs: Experience the magic of switching from metrics to logs with preserved label filters. Quickly search through all your logs or streaming them live. Alerting: Visually define alert rules for your most important metrics. Grafana will continuously evaluate and send notifications to systems like Slack, PagerDuty, VictorOps, OpsGenie. Mixed Data Sources: Mix different data sources in the same graph! You can specify a data source on a per-query basis. This works for even custom datasources.' developer: grafana diff --git a/Apps/HomeAssistant/docker-compose.yml b/Apps/HomeAssistant/docker-compose.yml index 329e9a4..4f78efd 100644 --- a/Apps/HomeAssistant/docker-compose.yml +++ b/Apps/HomeAssistant/docker-compose.yml @@ -21,23 +21,23 @@ services: category: Home Automation container: envs: - - configurable: "no" + - container: TZ description: en_US: TimeZone - - configurable: "no" + - container: PUID description: en_US: Run HomeAssistant as specified uid. - - configurable: "no" + - container: PGID description: en_US: Run HomeAssistant as specified gid. index: / port_map: "8123" - shell: bash + volumes: - - configurable: "no" + - container: /config description: en_US: HomeAssistant config directory. diff --git a/Apps/Jackett/docker-compose.yml b/Apps/Jackett/docker-compose.yml index 643e4aa..3ee45d2 100644 --- a/Apps/Jackett/docker-compose.yml +++ b/Apps/Jackett/docker-compose.yml @@ -29,37 +29,37 @@ services: category: Network container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" - - configurable: "no" + - container: AUTO_UPDATE description: en_US: "" index: / port_map: "9117" ports: - - configurable: "no" + - container: "9117" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /config description: en_US: "" - - configurable: "no" + - container: /downloads description: en_US: "" diff --git a/Apps/Jellyfin/docker-compose.yml b/Apps/Jellyfin/docker-compose.yml index 1a930ba..3fb6526 100644 --- a/Apps/Jellyfin/docker-compose.yml +++ b/Apps/Jellyfin/docker-compose.yml @@ -48,56 +48,56 @@ services: category: Media container: envs: - - configurable: "no" + - container: TZ description: en_US: TimeZone - - configurable: "no" + - container: PUID description: en_US: Run Jellyfin as specified uid. - - configurable: "no" + - container: PGID description: en_US: Run Jellyfin as specified gid. - - configurable: advanced + - container: JELLYFIN_PublishedServerUrl description: en_US: The autodiscovery response domain or IP address. index: / port_map: "8096" ports: - - configurable: advanced + - container: "8096" description: en_US: WebUI HTTP Port - protocol: tcp - - configurable: advanced + + - container: "8920" description: en_US: WebUI HTTPS Port - protocol: tcp - - configurable: "no" + + - container: "7359" description: en_US: Jellyfin auto-discovery Port - protocol: tcp - - configurable: "no" + + - container: "1900" description: en_US: Jellyfin DLNA Port - protocol: tcp - shell: bash + + volumes: - - configurable: "no" + - container: /config description: en_US: Jellyfin config directory. - - configurable: advanced + - container: /Media description: en_US: Jellyfin Media directory. - - configurable: advanced + - container: /opt/vc/lib description: en_US: OpenMax libs diff --git a/Apps/Lazylibrarian/docker-compose.yml b/Apps/Lazylibrarian/docker-compose.yml index 7291c21..427c4c3 100644 --- a/Apps/Lazylibrarian/docker-compose.yml +++ b/Apps/Lazylibrarian/docker-compose.yml @@ -32,40 +32,40 @@ services: category: Downloader container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" - - configurable: "no" + - container: DOCKER_MODS description: en_US: "" port_map: "5299" ports: - - configurable: "no" + - container: "5299" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /downloads description: en_US: "" - - configurable: "no" + - container: /books description: en_US: "" - - configurable: "no" + - container: /config description: en_US: "" diff --git a/Apps/Lidarr/docker-compose.yml b/Apps/Lidarr/docker-compose.yml index 8b8172d..43df1a8 100644 --- a/Apps/Lidarr/docker-compose.yml +++ b/Apps/Lidarr/docker-compose.yml @@ -31,36 +31,36 @@ services: category: Downloader container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" port_map: "8686" ports: - - configurable: "no" + - container: "8686" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /config description: en_US: "" - - configurable: "no" + - container: /music description: en_US: "" - - configurable: "no" + - container: /downloads description: en_US: "" diff --git a/Apps/Mylar3/docker-compose.yml b/Apps/Mylar3/docker-compose.yml index e038f9a..2767d6d 100644 --- a/Apps/Mylar3/docker-compose.yml +++ b/Apps/Mylar3/docker-compose.yml @@ -30,32 +30,32 @@ services: category: Downloader container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" port_map: "8090" ports: - - configurable: "no" + - container: "8090" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /config description: en_US: "" - - configurable: "no" + - container: /comics description: en_US: "" - - configurable: "no" + - container: /downloads description: en_US: "" diff --git a/Apps/N8n/docker-compose.yml b/Apps/N8n/docker-compose.yml index ad14d54..cb6a3b0 100644 --- a/Apps/N8n/docker-compose.yml +++ b/Apps/N8n/docker-compose.yml @@ -23,21 +23,21 @@ services: category: Utilities container: envs: - - configurable: "no" + - container: TZ description: en_US: TimeZone index: / port_map: "5678" ports: - - configurable: "no" + - container: "5678" description: en_US: web port - protocol: tcp - shell: bash + + volumes: - - configurable: advanced + - container: /home/node/.n8n description: en_US: n8n directory. diff --git a/Apps/Nextcloud/docker-compose.yml b/Apps/Nextcloud/docker-compose.yml index 15e88d6..48542e6 100644 --- a/Apps/Nextcloud/docker-compose.yml +++ b/Apps/Nextcloud/docker-compose.yml @@ -26,19 +26,19 @@ services: index: / port_map: "80" ports: - - configurable: advanced + - container: "80" description: en_US: WebUI HTTP Port - protocol: tcp - - configurable: advanced + + - container: "443" description: en_US: WebUI HTTPS Port - protocol: tcp - shell: bash + + volumes: - - configurable: "no" + - container: /var/www/html description: en_US: Nextcloud config directory. diff --git a/Apps/NginxProxyManager/docker-compose.yml b/Apps/NginxProxyManager/docker-compose.yml index 3e3a5e3..b138aae 100644 --- a/Apps/NginxProxyManager/docker-compose.yml +++ b/Apps/NginxProxyManager/docker-compose.yml @@ -32,28 +32,28 @@ services: index: / port_map: "81" ports: - - configurable: advanced + - container: "80" description: en_US: Nginx HTTP Port - protocol: tcp - - configurable: advanced + + - container: "443" description: en_US: Nginx HTTPS Port - protocol: tcp - - configurable: basic + + - container: "81" description: en_US: WebUI Port - protocol: tcp - shell: sh + + volumes: - - configurable: advanced + - container: /data description: en_US: Nginx Proxy Manager data directory. - - configurable: advanced + - container: /etc/letsencrypt description: en_US: Nginx Proxy Manager letsencrypt directory. diff --git a/Apps/Node-RED/docker-compose.yml b/Apps/Node-RED/docker-compose.yml index ef5db43..f59aade 100644 --- a/Apps/Node-RED/docker-compose.yml +++ b/Apps/Node-RED/docker-compose.yml @@ -23,14 +23,14 @@ services: index: / port_map: "1880" ports: - - configurable: "no" + - container: "1880" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /data description: en_US: "" diff --git a/Apps/Nzbget/docker-compose.yml b/Apps/Nzbget/docker-compose.yml index 75485f6..5e7ca16 100644 --- a/Apps/Nzbget/docker-compose.yml +++ b/Apps/Nzbget/docker-compose.yml @@ -30,40 +30,40 @@ services: category: Downloader container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" - - configurable: "no" + - container: NZBGET_USER description: en_US: "" - - configurable: "no" + - container: NZBGET_PASS description: en_US: "" port_map: "6789" ports: - - configurable: "no" + - container: "6789" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /config description: en_US: "" - - configurable: "no" + - container: /downloads description: en_US: "" diff --git a/Apps/Ombi/docker-compose.yml b/Apps/Ombi/docker-compose.yml index af9c1bb..8f055b7 100644 --- a/Apps/Ombi/docker-compose.yml +++ b/Apps/Ombi/docker-compose.yml @@ -26,32 +26,32 @@ services: category: Media container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" - - configurable: "no" + - container: BASE_URL description: en_US: "" port_map: "3579" ports: - - configurable: "no" + - container: "3579" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /config description: en_US: "" diff --git a/Apps/OpenHAB/docker-compose.yml b/Apps/OpenHAB/docker-compose.yml index 213bc1c..0ff2a26 100644 --- a/Apps/OpenHAB/docker-compose.yml +++ b/Apps/OpenHAB/docker-compose.yml @@ -35,39 +35,39 @@ services: category: Home Automation container: envs: - - configurable: "no" + - container: CRYPTO_POLICY description: en_US: Crypto Policy - - configurable: "no" + - container: PUID description: en_US: Run OpenHAB as specified uid. - - configurable: "no" + - container: PGID description: en_US: Run OpenHAB as specified gid. index: / port_map: "8080" - shell: bash + volumes: - - configurable: "no" + - container: /etc/localtime description: en_US: Ties the time of the container to the host's time, read only so the container cannot change the host's time. - - configurable: "no" + - container: /etc/timezone description: en_US: Ties the timezone of the container to the host's time zone, read only so the container cannot change the host's time zone. - - configurable: "no" + - container: /opt/openhab/addons description: en_US: Only needed if installing addons unavailable via UI or the Karaf Console. - - configurable: "no" + - container: /opt/openhab/conf description: en_US: 'Location of the conf folder for openHAB configurations (Note: you must create these folders on the host before running the container).' - - configurable: "no" + - container: /opt/openhab/userdata description: en_US: Location for logs, cache, persistence databases, etc. diff --git a/Apps/OpenSpeedTest/docker-compose.yml b/Apps/OpenSpeedTest/docker-compose.yml index a8bb4ea..b91acd2 100644 --- a/Apps/OpenSpeedTest/docker-compose.yml +++ b/Apps/OpenSpeedTest/docker-compose.yml @@ -19,12 +19,12 @@ services: index: / port_map: "3000" ports: - - configurable: "no" + - container: "3000" description: en_US: "" - protocol: tcp - shell: sh + + description: en_US: An application for launching HTML5 Network Speed Test Server. You can test download & upload speed from any device within your network with a web browser that is IE10 or new. developer: OpenSpeedTest diff --git a/Apps/PhotoPrism/docker-compose.yml b/Apps/PhotoPrism/docker-compose.yml index 37e7b7e..242ca1d 100644 --- a/Apps/PhotoPrism/docker-compose.yml +++ b/Apps/PhotoPrism/docker-compose.yml @@ -28,33 +28,33 @@ services: category: Gallery container: envs: - - configurable: "no" + - container: TZ description: en_US: TimeZone - - configurable: basic + - container: PHOTOPRISM_UPLOAD_NSFW description: en_US: true or false, is it possible to upload NSFW - - configurable: basic + - container: PHOTOPRISM_ADMIN_PASSWORD description: en_US: The password of admin index: / port_map: "2342" ports: - - configurable: advanced + - container: "2342" description: en_US: WebUI HTTP Port - protocol: tcp - shell: bash + + volumes: - - configurable: "no" + - container: /photoprism/storage description: en_US: PhotoPrism storage directory. - - configurable: advanced + - container: /photoprism/originals description: en_US: PhotoPrism originals directory. diff --git a/Apps/Pihole/docker-compose.yml b/Apps/Pihole/docker-compose.yml index e4f8247..7eceaaf 100644 --- a/Apps/Pihole/docker-compose.yml +++ b/Apps/Pihole/docker-compose.yml @@ -41,57 +41,57 @@ services: category: Network container: envs: - - configurable: "no" + - container: TZ description: en_US: TimeZone - - configurable: basic + - container: WEBPASSWORD description: en_US: Pi-hole admin password - - configurable: advanced + - container: VIRTUAL_HOST description: en_US: Pi-hole Custom Hostname - - configurable: advanced + - container: PROXY_LOCATION description: en_US: Pi-hole PROXY_LOCATION index: /admin port_map: "80" ports: - - configurable: advanced + - container: "80" description: en_US: WebUI HTTP Port - protocol: tcp - - configurable: "no" + + - container: "53" description: en_US: Pihole DNS port - protocol: tcp - - configurable: "no" + + - container: "53" description: en_US: Pihole DNS port protocol: udp - - configurable: "no" + - container: "67" description: en_US: Pihole DHCP IPv4 port protocol: udp - - configurable: "no" + - container: "547" description: en_US: Pihole DHCP IPv6 port protocol: udp - shell: bash + volumes: - - configurable: "no" + - container: /etc/pihole description: en_US: Pi-hole /etc/pihole directory. - - configurable: "no" + - container: /etc/dnsmasq.d description: en_US: Pi-hole /etc/dnsmasq.d directory. diff --git a/Apps/Plex/docker-compose.yml b/Apps/Plex/docker-compose.yml index bc6b0a5..90e7c5e 100644 --- a/Apps/Plex/docker-compose.yml +++ b/Apps/Plex/docker-compose.yml @@ -27,27 +27,27 @@ services: category: Media container: envs: - - configurable: "no" + - container: PUID description: en_US: Run Plex as specified uid. - - configurable: "no" + - container: PGID description: en_US: Run Plex as specified gid. - - configurable: "no" + - container: VERSION description: en_US: Let Docker handle the Plex Version index: /web/index.html port_map: "32400" - shell: bash + volumes: - - configurable: "no" + - container: /config description: en_US: Plex config directory. - - configurable: advanced + - container: /Media description: en_US: Plex Media directory. diff --git a/Apps/Prowlarr/docker-compose.yml b/Apps/Prowlarr/docker-compose.yml index b6898d3..499ea77 100644 --- a/Apps/Prowlarr/docker-compose.yml +++ b/Apps/Prowlarr/docker-compose.yml @@ -25,28 +25,28 @@ services: category: Downloader container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" port_map: "9696" ports: - - configurable: "no" + - container: "9696" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /config description: en_US: "" diff --git a/Apps/Radarr/docker-compose.yml b/Apps/Radarr/docker-compose.yml index ba8fb0c..4ff5b80 100644 --- a/Apps/Radarr/docker-compose.yml +++ b/Apps/Radarr/docker-compose.yml @@ -31,37 +31,37 @@ services: category: Media container: envs: - - configurable: "no" + - container: TZ description: en_US: TimeZone - - configurable: "no" + - container: PUID description: en_US: Run Radarr as specified uid. - - configurable: "no" + - container: PGID description: en_US: Run Radarr as specified gid. index: / port_map: "7878" ports: - - configurable: advanced + - container: "7878" description: en_US: WebUI HTTP Port - protocol: tcp - shell: bash + + volumes: - - configurable: "no" + - container: /config description: en_US: Radarr config directory. - - configurable: advanced + - container: /movies description: en_US: Radarr movies directory. - - configurable: advanced + - container: /downloads description: en_US: Radarr downloads directory. diff --git a/Apps/Readarr/docker-compose.yml b/Apps/Readarr/docker-compose.yml index 1878ce8..8dee0c0 100644 --- a/Apps/Readarr/docker-compose.yml +++ b/Apps/Readarr/docker-compose.yml @@ -31,36 +31,36 @@ services: category: Media container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" port_map: "8787" ports: - - configurable: "no" + - container: "8787" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /config description: en_US: "" - - configurable: "no" + - container: /books description: en_US: "" - - configurable: "no" + - container: /downloads description: en_US: "" diff --git a/Apps/Sabnzbd/docker-compose.yml b/Apps/Sabnzbd/docker-compose.yml index 2244424..7cbbe90 100644 --- a/Apps/Sabnzbd/docker-compose.yml +++ b/Apps/Sabnzbd/docker-compose.yml @@ -31,36 +31,36 @@ services: category: Media container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" port_map: "8080" ports: - - configurable: "no" + - container: "8080" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /incomplete-downloads description: en_US: "" - - configurable: "no" + - container: /config description: en_US: "" - - configurable: "no" + - container: /downloads description: en_US: "" diff --git a/Apps/Sickchill/docker-compose.yml b/Apps/Sickchill/docker-compose.yml index 73c4fe7..ceac1dd 100644 --- a/Apps/Sickchill/docker-compose.yml +++ b/Apps/Sickchill/docker-compose.yml @@ -31,36 +31,36 @@ services: category: Media container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" port_map: "8081" ports: - - configurable: "no" + - container: "8081" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /config description: en_US: "" - - configurable: "no" + - container: /downloads description: en_US: "" - - configurable: "no" + - container: /tv description: en_US: "" diff --git a/Apps/Smokeping/docker-compose.yml b/Apps/Smokeping/docker-compose.yml index dbdc6e3..6477e72 100644 --- a/Apps/Smokeping/docker-compose.yml +++ b/Apps/Smokeping/docker-compose.yml @@ -28,32 +28,32 @@ services: category: Network container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" port_map: "80" ports: - - configurable: "no" + - container: "80" description: en_US: "" - protocol: tcp - shell: sh + + volumes: - - configurable: "no" + - container: /config description: en_US: "" - - configurable: "no" + - container: /data description: en_US: "" diff --git a/Apps/Sonarr/docker-compose.yml b/Apps/Sonarr/docker-compose.yml index 773c277..d710247 100644 --- a/Apps/Sonarr/docker-compose.yml +++ b/Apps/Sonarr/docker-compose.yml @@ -31,37 +31,37 @@ services: category: Media container: envs: - - configurable: "no" + - container: TZ description: en_US: TimeZone - - configurable: "no" + - container: PUID description: en_US: Run Sonarr as specified uid. - - configurable: "no" + - container: PGID description: en_US: Run Sonarr as specified gid. index: / port_map: "8989" ports: - - configurable: advanced + - container: "8989" description: en_US: WebUI HTTP Port - protocol: tcp - shell: bash + + volumes: - - configurable: "no" + - container: /config description: en_US: Sonarr config directory. - - configurable: advanced + - container: /tv description: en_US: Sonarr tv directory. - - configurable: advanced + - container: /downloads description: en_US: Sonarr downloads directory. diff --git a/Apps/Syncthing/docker-compose.yml b/Apps/Syncthing/docker-compose.yml index c6b0fba..abd68ee 100644 --- a/Apps/Syncthing/docker-compose.yml +++ b/Apps/Syncthing/docker-compose.yml @@ -37,48 +37,48 @@ services: category: Backup container: envs: - - configurable: "no" + - container: TZ description: en_US: TimeZone - - configurable: "no" + - container: PUID description: en_US: Run Syncthing as specified uid. - - configurable: "no" + - container: PGID description: en_US: Run Syncthing as specified gid. index: / port_map: "8384" ports: - - configurable: advanced + - container: "8384" description: en_US: WebUI HTTP Port - protocol: tcp - - configurable: "no" + + - container: "22000" description: en_US: Syncthing listening Port (TCP) - protocol: tcp - - configurable: "no" + + - container: "22000" description: en_US: Syncthing listening Port (UDP) protocol: udp - - configurable: "no" + - container: "21027" description: en_US: Syncthing protocol discovery Port (TCP) protocol: udp - shell: bash + volumes: - - configurable: "no" + - container: /config description: en_US: Syncthing config directory. - - configurable: advanced + - container: /DATA description: en_US: Syncthing Accessible Directory. diff --git a/Apps/TailscaleDaemon/docker-compose.yml b/Apps/TailscaleDaemon/docker-compose.yml index c909741..6d52f34 100644 --- a/Apps/TailscaleDaemon/docker-compose.yml +++ b/Apps/TailscaleDaemon/docker-compose.yml @@ -31,30 +31,30 @@ services: category: Network container: envs: - - configurable: advanced + - container: TS_AUTH_ONCE description: en_US: if true, only attempt to log in if not already logged in. If false, forcibly log in every time the container starts. - - configurable: advanced + - container: TS_EXTRA_ARGS description: en_US: extra arguments to 'tailscale up'. - - configurable: advanced + - container: TS_STATE_DIR description: en_US: the directory in which to store tailscaled state. The data should persist across container restarts. port_map: "80" - shell: sh + volumes: - - configurable: "no" + - container: /dev/net/tun description: en_US: "" - - configurable: "no" + - container: /var/lib description: en_US: "" - - configurable: "no" + - container: /var/lib/tailscale description: en_US: "" diff --git a/Apps/Tautulli/docker-compose.yml b/Apps/Tautulli/docker-compose.yml index ee14571..17a3d54 100644 --- a/Apps/Tautulli/docker-compose.yml +++ b/Apps/Tautulli/docker-compose.yml @@ -24,29 +24,29 @@ services: category: Media container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" index: / port_map: "8181" ports: - - configurable: "no" + - container: "8181" description: en_US: "" protocol: "" - shell: bash + volumes: - - configurable: "no" + - container: /config description: en_US: "" diff --git a/Apps/Transmission/docker-compose.yml b/Apps/Transmission/docker-compose.yml index c9a9043..ecc53ef 100644 --- a/Apps/Transmission/docker-compose.yml +++ b/Apps/Transmission/docker-compose.yml @@ -41,63 +41,63 @@ services: category: Network container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: TZ description: en_US: "" - - configurable: "no" + - container: TRANSMISSION_WEB_HOME description: en_US: "" - - configurable: "no" + - container: USER description: en_US: "" - - configurable: "no" + - container: PASS description: en_US: "" - - configurable: "no" + - container: PEERPORT description: en_US: "" index: / port_map: "9091" ports: - - configurable: "no" + - container: "9091" description: en_US: "" - protocol: tcp - - configurable: "no" + + - container: "51413" description: en_US: "" - protocol: tcp - - configurable: "no" + + - container: "51413" description: en_US: "" protocol: udp - shell: sh + volumes: - - configurable: "no" + - container: /config description: en_US: "" - - configurable: "no" + - container: /downloads description: en_US: "" - - configurable: "no" + - container: /watch description: en_US: "" diff --git a/Apps/Unifi-controller/docker-compose.yml b/Apps/Unifi-controller/docker-compose.yml index d074367..26635fd 100644 --- a/Apps/Unifi-controller/docker-compose.yml +++ b/Apps/Unifi-controller/docker-compose.yml @@ -50,73 +50,73 @@ services: category: Network container: envs: - - configurable: "no" + - container: PUID description: en_US: "" - - configurable: "no" + - container: PGID description: en_US: "" - - configurable: "no" + - container: MEM_LIMIT description: en_US: "" - - configurable: "no" + - container: MEM_STARTUP description: en_US: "" index: / port_map: "8080" ports: - - configurable: "no" + - container: "3478" description: en_US: "" protocol: udp - - configurable: "no" + - container: "10001" description: en_US: "" protocol: udp - - configurable: "no" + - container: "8080" description: en_US: "" - protocol: tcp - - configurable: "no" + + - container: "8443" description: en_US: "" - protocol: tcp - - configurable: "no" + + - container: "1900" description: en_US: "" protocol: udp - - configurable: "no" + - container: "8843" description: en_US: "" - protocol: tcp - - configurable: "no" + + - container: "8880" description: en_US: "" - protocol: tcp - - configurable: "no" + + - container: "6789" description: en_US: "" - protocol: tcp - - configurable: "no" + + - container: "5514" description: en_US: "" protocol: udp - shell: sh + volumes: - - configurable: "no" + - container: /config description: en_US: "" diff --git a/Apps/UptimeKuma/docker-compose.yml b/Apps/UptimeKuma/docker-compose.yml index 0299ed1..8bb8a82 100644 --- a/Apps/UptimeKuma/docker-compose.yml +++ b/Apps/UptimeKuma/docker-compose.yml @@ -23,14 +23,14 @@ services: index: / port_map: "3001" ports: - - configurable: advanced + - container: "3001" description: en_US: WebUI Port - protocol: tcp - shell: sh + + volumes: - - configurable: advanced + - container: /app/data description: en_US: Uptime Kuma data directory. diff --git a/Apps/Vaultwarden/docker-compose.yml b/Apps/Vaultwarden/docker-compose.yml index 41e751c..045de7c 100644 --- a/Apps/Vaultwarden/docker-compose.yml +++ b/Apps/Vaultwarden/docker-compose.yml @@ -23,14 +23,14 @@ services: index: / port_map: "80" ports: - - configurable: advanced + - container: "80" description: en_US: WebUI HTTP Port - protocol: tcp - shell: bash + + volumes: - - configurable: "no" + - container: /data description: en_US: Vaultwarden data directory. diff --git a/Apps/VoceChat/docker-compose.yml b/Apps/VoceChat/docker-compose.yml index 7096a4a..07d8ba7 100644 --- a/Apps/VoceChat/docker-compose.yml +++ b/Apps/VoceChat/docker-compose.yml @@ -23,21 +23,21 @@ services: category: Chat container: envs: - - configurable: "yes" + - container: TZ description: en_US: TimeZone index: / port_map: "3000" ports: - - configurable: advanced + - container: "3000" description: en_US: WebUI HTTP Port - protocol: tcp - shell: bash + + volumes: - - configurable: "no" + - container: /home/vocechat-server/data description: en_US: VoceChat Data diff --git a/Apps/qBittorrent/docker-compose.yml b/Apps/qBittorrent/docker-compose.yml index 34d9810..dab091a 100644 --- a/Apps/qBittorrent/docker-compose.yml +++ b/Apps/qBittorrent/docker-compose.yml @@ -29,37 +29,37 @@ services: category: Downloader container: envs: - - configurable: "no" + - container: TZ description: en_US: TimeZone - - configurable: "no" + - container: PUID description: en_US: Run qBittorrent as specified uid. - - configurable: "no" + - container: PGID description: en_US: Run qBittorrent as specified gid. - - configurable: "no" + - container: UMASK description: en_US: Run qBittorrent as specified UMASK. index: / port_map: "8080" ports: - - configurable: advanced + - container: "8080" description: en_US: WebUI HTTP Port - protocol: tcp - shell: bash + + volumes: - - configurable: "no" + - container: /config description: en_US: qBittorrent config directory. - - configurable: advanced + - container: /DATA description: en_US: qBittorrent Accessible directory. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c1e5c0b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,89 @@ +# Contributing to CasaOS AppStore + +This document describes how to contribute an app to CasaOS AppStore. + +## Guidelines + +A CasaOS App is a Docker Compose app, or a *compose app*. + +Each directory under [Apps](Apps) correspond to a CasaOS App. The directory should contain at least a `docker-compose.yml` file: + +- It should be a valid [Docker Compose file](https://docs.docker.com/compose/compose-file/). + +- The `name` property is used as the *store App ID*, which should be unique across all apps. + + For example, in the [`docker-compose.yml` of Syncthing](Apps/Syncthing/docker-compose.yml#L1), its store App ID is `syncthing`: + + ```yaml + name: syncthing + services: + syncthing: + image: linuxserver/syncthing:latest + ... + ``` + +- CasaOS specific metadata, also called *store info*, are stored under [extension](https://docs.docker.com/compose/compose-file/#extension) property `x-casaos` at two positions. + + 1. Service level + + A `docker-compose.yml` file can contain one or more `services`. Each [service](https://docs.docker.com/compose/compose-file/#services-top-level-element) can have its own store info. + + For the same example, at the buttom of the `syncthing` service in the [`docker-compose.yml` of Syncthing](Apps/Syncthing/docker-compose.yml) + + ```yaml + x-casaos: + author: CasaOS Team + category: Backup + container: # see Container store info (`x-casaos.container`) below + ... + description: # multiple locales are supported + en_US: Syncthing is a continuous file synchronization program. It synchronizes files between two or more computers in real time, safely protected from prying eyes. Your data is your data alone and you deserve to choose where it is stored, whether it is shared with some third party, and how it's transmitted over the internet. + developer: Syncthing + icon: https://cdn.jsdelivr.net/gh/IceWhaleTech/CasaOS-AppStore@main/Apps/Syncthing/icon.png + tagline: # multiple locales are supported + en_US: Free, secure, and distributed file synchronisation tool. + thumbnail: https://cdn.jsdelivr.net/gh/IceWhaleTech/CasaOS-AppStore@main/Apps/Jellyfin/thumbnail.jpg + title: # multiple locales are supported + en_US: Syncthing + + ``` + + 1. Compose app level + + For the same example, at the bottome of the [`docker-compose.yml` of Syncthing](Apps/Syncthing/docker-compose.yml) + + ```yaml + x-casaos: + architectures: # a list of architectures that the app supports + - amd64 + - arm + - arm64 + main_app: syncthing # the name of the main service under `services` + ``` + +- Container store info (`x-casaos.container`) + + ```yaml + x-casaos: + ... + container: + index: / # the index page for web UI, e.g. index.html + port_map: "8384" # the port for web UI + envs: # description of each environment variable + ... + - container: PUID + description: + en_US: Run Syncthing as specified uid. + ports: # description of each port + - container: "8384" + description: + en_US: WebUI HTTP Port + ... + volumes: # description of each volume + - container: /config + description: + en_US: Syncthing config directory. + - container: /DATA + description: + en_US: Syncthing Accessible Directory. + ```