adil
/
CasaOS-Store
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

remove unnecessary properties from docker-compose.yml of each app (#24)

This commit is contained in:
Tiger Wang 2023-03-08 19:45:48 -05:00 committed by GitHub
parent acd70c00e5
commit ca726eb819
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
47 changed files with 469 additions and 387 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Apps/2FAuth/docker-compose.yml
View File

@ -23,14 +23,13 @@ services:
index: / index: /
port_map: "8000" port_map: "8000"
ports: ports:
- configurable: "no" -
container: "8000" container: "8000"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /2fauth container: /2fauth
description: description:
en_US: "" en_US: ""

21
Apps/AdGuardHome/docker-compose.yml
View File

@ -38,38 +38,33 @@ services:
index: / index: /
port_map: "3000" port_map: "3000"
ports: ports:
- configurable: "no" -
container: "53" container: "53"
description: description:
en_US: "" en_US: ""
protocol: tcp -
- configurable: "no"
container: "53" container: "53"
description: description:
en_US: "" en_US: ""
protocol: udp -
- configurable: "no"
container: "3000" container: "3000"
description: description:
en_US: "" en_US: ""
protocol: tcp -
- configurable: "no"
container: "853" container: "853"
description: description:
en_US: "" en_US: ""
protocol: tcp -
- configurable: "no"
container: "784" container: "784"
description: description:
en_US: "" en_US: ""
protocol: udp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /opt/adguardhome/work container: /opt/adguardhome/work
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /opt/adguardhome/conf container: /opt/adguardhome/conf
description: description:
en_US: "" en_US: ""

5
Apps/AllTubeDownload/docker-compose.yml
View File

@ -19,12 +19,11 @@ services:
index: / index: /
port_map: "80" port_map: "80"
ports: ports:
- configurable: "no" -
container: "80" container: "80"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
description: description:
en_US: Easily download videos from YouTube, Dailymotion, Vimeo and other websites. en_US: Easily download videos from YouTube, Dailymotion, Vimeo and other websites.
developer: Rudloff developer: Rudloff

18
Apps/Bazarr/docker-compose.yml
View File

@ -31,36 +31,36 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
port_map: "6767" port_map: "6767"
ports: ports:
- configurable: "no" -
container: "6767" container: "6767"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /movies container: /movies
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /tv container: /tv
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""

18
Apps/Calibre-web/docker-compose.yml
View File

@ -29,37 +29,37 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: DOCKER_MODS container: DOCKER_MODS
description: description:
en_US: "" en_US: ""
index: / index: /
port_map: "8083" port_map: "8083"
ports: ports:
- configurable: "no" -
container: "8083" container: "8083"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /books container: /books
description: description:
en_US: "" en_US: ""

18
Apps/CouchPotato/docker-compose.yml
View File

@ -31,37 +31,37 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "yes" -
container: TZ container: TZ
description: description:
en_US: TimeZone en_US: TimeZone
- configurable: "yes" -
container: PUID container: PUID
description: description:
en_US: Run CouchPotato as specified uid. en_US: Run CouchPotato as specified uid.
- configurable: "yes" -
container: PGID container: PGID
description: description:
en_US: Run CouchPotato as specified gid. en_US: Run CouchPotato as specified gid.
index: / index: /
port_map: "5050" port_map: "5050"
ports: ports:
- configurable: advanced -
container: "5050" container: "5050"
description: description:
en_US: WebUI HTTP Port en_US: WebUI HTTP Port
protocol: tcp
shell: bash
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: CouchPotato config directory. en_US: CouchPotato config directory.
- configurable: advanced -
container: /movies container: /movies
description: description:
en_US: CouchPotato movies directory. en_US: CouchPotato movies directory.
- configurable: advanced -
container: /downloads container: /downloads
description: description:
en_US: CouchPotato downloads directory. en_US: CouchPotato downloads directory.

24
Apps/Deluge/docker-compose.yml
View File

@ -35,47 +35,47 @@ services:
category: Downloader category: Downloader
container: container:
envs: envs:
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: TimeZone en_US: TimeZone
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: Run Deluge as specified uid. en_US: Run Deluge as specified uid.
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: Run Deluge as specified gid. en_US: Run Deluge as specified gid.
- configurable: "no" -
container: DELUGE_LOGLEVEL container: DELUGE_LOGLEVEL
description: description:
en_US: 'Deluge Log Level ' en_US: 'Deluge Log Level '
index: / index: /
port_map: "8112" port_map: "8112"
ports: ports:
- configurable: advanced -
container: "8112" container: "8112"
description: description:
en_US: WebUI HTTP Port en_US: WebUI HTTP Port
protocol: tcp
- configurable: advanced -
container: "6881" container: "6881"
description: description:
en_US: Inbound torrent traffic (TCP) en_US: Inbound torrent traffic (TCP)
protocol: tcp
- configurable: advanced -
container: "6881" container: "6881"
description: description:
en_US: Inbound torrent traffic (UDP) en_US: Inbound torrent traffic (UDP)
protocol: udp protocol: udp
shell: bash
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: Deluge config directory. en_US: Deluge config directory.
- configurable: advanced -
container: /DATA container: /DATA
description: description:
en_US: Deluge Accessible directory. en_US: Deluge Accessible directory.

18
Apps/Duplicati/docker-compose.yml
View File

@ -31,37 +31,37 @@ services:
category: Cloud category: Cloud
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
index: / index: /
port_map: "8200" port_map: "8200"
ports: ports:
- configurable: "no" -
container: "8200" container: "8200"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /backups container: /backups
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /source container: /source
description: description:
en_US: "" en_US: ""

22
Apps/Emby/docker-compose.yml
View File

@ -40,42 +40,42 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
index: / index: /
port_map: "8096" port_map: "8096"
ports: ports:
- configurable: "no" -
container: "8096" container: "8096"
description: description:
en_US: "" en_US: ""
protocol: tcp
- configurable: "no" -
container: "8920" container: "8920"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /data/tvshows container: /data/tvshows
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /data/movies container: /data/movies
description: description:
en_US: "" en_US: ""

14
Apps/Embystat/docker-compose.yml
View File

@ -25,28 +25,28 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
port_map: "6555" port_map: "6555"
ports: ports:
- configurable: "no" -
container: "6555" container: "6555"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""

16
Apps/FileBrowser/docker-compose.yml
View File

@ -28,33 +28,33 @@ services:
category: Cloud category: Cloud
container: container:
envs: envs:
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: TimeZone en_US: TimeZone
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: Run FileBrowser as specified uid. en_US: Run FileBrowser as specified uid.
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: Run FileBrowser as specified gid. en_US: Run FileBrowser as specified gid.
index: / index: /
port_map: "80" port_map: "80"
ports: ports:
- configurable: advanced -
container: "80" container: "80"
description: description:
en_US: WebUI Port en_US: WebUI Port
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /db container: /db
description: description:
en_US: FileBrowser database directory. en_US: FileBrowser database directory.
- configurable: advanced -
container: /srv container: /srv
description: description:
en_US: FileBrowser managed directory. en_US: FileBrowser managed directory.

16
Apps/Gitea/docker-compose.yml
View File

@ -27,30 +27,30 @@ services:
category: Developer category: Developer
container: container:
envs: envs:
- configurable: advanced -
container: USER_UID container: USER_UID
description: description:
en_US: The UID (Unix user ID) of the user that runs Gitea en_US: The UID (Unix user ID) of the user that runs Gitea
- configurable: advanced -
container: USER_GID container: USER_GID
description: description:
en_US: The GID (Unix group ID) of the user that runs Gitea en_US: The GID (Unix group ID) of the user that runs Gitea
index: / index: /
port_map: "3000" port_map: "3000"
ports: ports:
- configurable: advanced -
container: "3000" container: "3000"
description: description:
en_US: WebUI Port en_US: WebUI Port
protocol: tcp
- configurable: advanced -
container: "22" container: "22"
description: description:
en_US: SSH Port en_US: SSH Port
protocol: tcp
shell: sh
volumes: volumes:
- configurable: advanced -
container: /data container: /data
description: description:
en_US: Gitea data directory. en_US: Gitea data directory.

6
Apps/Grafana/docker-compose.yml
View File

@ -19,12 +19,12 @@ services:
index: / index: /
port_map: "3000" port_map: "3000"
ports: ports:
- configurable: "no" -
container: "3000" container: "3000"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
description: 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.' 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 developer: grafana

10
Apps/HomeAssistant/docker-compose.yml
View File

@ -21,23 +21,23 @@ services:
category: Home Automation category: Home Automation
container: container:
envs: envs:
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: TimeZone en_US: TimeZone
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: Run HomeAssistant as specified uid. en_US: Run HomeAssistant as specified uid.
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: Run HomeAssistant as specified gid. en_US: Run HomeAssistant as specified gid.
index: / index: /
port_map: "8123" port_map: "8123"
shell: bash
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: HomeAssistant config directory. en_US: HomeAssistant config directory.

18
Apps/Jackett/docker-compose.yml
View File

@ -29,37 +29,37 @@ services:
category: Network category: Network
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: AUTO_UPDATE container: AUTO_UPDATE
description: description:
en_US: "" en_US: ""
index: / index: /
port_map: "9117" port_map: "9117"
ports: ports:
- configurable: "no" -
container: "9117" container: "9117"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /downloads container: /downloads
description: description:
en_US: "" en_US: ""

32
Apps/Jellyfin/docker-compose.yml
View File

@ -48,56 +48,56 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: TimeZone en_US: TimeZone
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: Run Jellyfin as specified uid. en_US: Run Jellyfin as specified uid.
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: Run Jellyfin as specified gid. en_US: Run Jellyfin as specified gid.
- configurable: advanced -
container: JELLYFIN_PublishedServerUrl container: JELLYFIN_PublishedServerUrl
description: description:
en_US: The autodiscovery response domain or IP address. en_US: The autodiscovery response domain or IP address.
index: / index: /
port_map: "8096" port_map: "8096"
ports: ports:
- configurable: advanced -
container: "8096" container: "8096"
description: description:
en_US: WebUI HTTP Port en_US: WebUI HTTP Port
protocol: tcp
- configurable: advanced -
container: "8920" container: "8920"
description: description:
en_US: WebUI HTTPS Port en_US: WebUI HTTPS Port
protocol: tcp
- configurable: "no" -
container: "7359" container: "7359"
description: description:
en_US: Jellyfin auto-discovery Port en_US: Jellyfin auto-discovery Port
protocol: tcp
- configurable: "no" -
container: "1900" container: "1900"
description: description:
en_US: Jellyfin DLNA Port en_US: Jellyfin DLNA Port
protocol: tcp
shell: bash
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: Jellyfin config directory. en_US: Jellyfin config directory.
- configurable: advanced -
container: /Media container: /Media
description: description:
en_US: Jellyfin Media directory. en_US: Jellyfin Media directory.
- configurable: advanced -
container: /opt/vc/lib container: /opt/vc/lib
description: description:
en_US: OpenMax libs en_US: OpenMax libs

20
Apps/Lazylibrarian/docker-compose.yml
View File

@ -32,40 +32,40 @@ services:
category: Downloader category: Downloader
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: DOCKER_MODS container: DOCKER_MODS
description: description:
en_US: "" en_US: ""
port_map: "5299" port_map: "5299"
ports: ports:
- configurable: "no" -
container: "5299" container: "5299"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /downloads container: /downloads
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /books container: /books
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""

18
Apps/Lidarr/docker-compose.yml
View File

@ -31,36 +31,36 @@ services:
category: Downloader category: Downloader
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
port_map: "8686" port_map: "8686"
ports: ports:
- configurable: "no" -
container: "8686" container: "8686"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /music container: /music
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /downloads container: /downloads
description: description:
en_US: "" en_US: ""

16
Apps/Mylar3/docker-compose.yml
View File

@ -30,32 +30,32 @@ services:
category: Downloader category: Downloader
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
port_map: "8090" port_map: "8090"
ports: ports:
- configurable: "no" -
container: "8090" container: "8090"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /comics container: /comics
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /downloads container: /downloads
description: description:
en_US: "" en_US: ""

10
Apps/N8n/docker-compose.yml
View File

@ -23,21 +23,21 @@ services:
category: Utilities category: Utilities
container: container:
envs: envs:
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: TimeZone en_US: TimeZone
index: / index: /
port_map: "5678" port_map: "5678"
ports: ports:
- configurable: "no" -
container: "5678" container: "5678"
description: description:
en_US: web port en_US: web port
protocol: tcp
shell: bash
volumes: volumes:
- configurable: advanced -
container: /home/node/.n8n container: /home/node/.n8n
description: description:
en_US: n8n directory. en_US: n8n directory.

12
Apps/Nextcloud/docker-compose.yml
View File

@ -26,19 +26,19 @@ services:
index: / index: /
port_map: "80" port_map: "80"
ports: ports:
- configurable: advanced -
container: "80" container: "80"
description: description:
en_US: WebUI HTTP Port en_US: WebUI HTTP Port
protocol: tcp
- configurable: advanced -
container: "443" container: "443"
description: description:
en_US: WebUI HTTPS Port en_US: WebUI HTTPS Port
protocol: tcp
shell: bash
volumes: volumes:
- configurable: "no" -
container: /var/www/html container: /var/www/html
description: description:
en_US: Nextcloud config directory. en_US: Nextcloud config directory.

18
Apps/NginxProxyManager/docker-compose.yml
View File

@ -32,28 +32,28 @@ services:
index: / index: /
port_map: "81" port_map: "81"
ports: ports:
- configurable: advanced -
container: "80" container: "80"
description: description:
en_US: Nginx HTTP Port en_US: Nginx HTTP Port
protocol: tcp
- configurable: advanced -
container: "443" container: "443"
description: description:
en_US: Nginx HTTPS Port en_US: Nginx HTTPS Port
protocol: tcp
- configurable: basic -
container: "81" container: "81"
description: description:
en_US: WebUI Port en_US: WebUI Port
protocol: tcp
shell: sh
volumes: volumes:
- configurable: advanced -
container: /data container: /data
description: description:
en_US: Nginx Proxy Manager data directory. en_US: Nginx Proxy Manager data directory.
- configurable: advanced -
container: /etc/letsencrypt container: /etc/letsencrypt
description: description:
en_US: Nginx Proxy Manager letsencrypt directory. en_US: Nginx Proxy Manager letsencrypt directory.

8
Apps/Node-RED/docker-compose.yml
View File

@ -23,14 +23,14 @@ services:
index: / index: /
port_map: "1880" port_map: "1880"
ports: ports:
- configurable: "no" -
container: "1880" container: "1880"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /data container: /data
description: description:
en_US: "" en_US: ""

20
Apps/Nzbget/docker-compose.yml
View File

@ -30,40 +30,40 @@ services:
category: Downloader category: Downloader
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: NZBGET_USER container: NZBGET_USER
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: NZBGET_PASS container: NZBGET_PASS
description: description:
en_US: "" en_US: ""
port_map: "6789" port_map: "6789"
ports: ports:
- configurable: "no" -
container: "6789" container: "6789"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /downloads container: /downloads
description: description:
en_US: "" en_US: ""

16
Apps/Ombi/docker-compose.yml
View File

@ -26,32 +26,32 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: BASE_URL container: BASE_URL
description: description:
en_US: "" en_US: ""
port_map: "3579" port_map: "3579"
ports: ports:
- configurable: "no" -
container: "3579" container: "3579"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""

18
Apps/OpenHAB/docker-compose.yml
View File

@ -35,39 +35,39 @@ services:
category: Home Automation category: Home Automation
container: container:
envs: envs:
- configurable: "no" -
container: CRYPTO_POLICY container: CRYPTO_POLICY
description: description:
en_US: Crypto Policy en_US: Crypto Policy
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: Run OpenHAB as specified uid. en_US: Run OpenHAB as specified uid.
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: Run OpenHAB as specified gid. en_US: Run OpenHAB as specified gid.
index: / index: /
port_map: "8080" port_map: "8080"
shell: bash
volumes: volumes:
- configurable: "no" -
container: /etc/localtime container: /etc/localtime
description: 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. 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 container: /etc/timezone
description: 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. 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 container: /opt/openhab/addons
description: description:
en_US: Only needed if installing addons unavailable via UI or the Karaf Console. en_US: Only needed if installing addons unavailable via UI or the Karaf Console.
- configurable: "no" -
container: /opt/openhab/conf container: /opt/openhab/conf
description: description:
en_US: 'Location of the conf folder for openHAB configurations (Note: you must create these folders on the host before running the container).' 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 container: /opt/openhab/userdata
description: description:
en_US: Location for logs, cache, persistence databases, etc. en_US: Location for logs, cache, persistence databases, etc.

6
Apps/OpenSpeedTest/docker-compose.yml
View File

@ -19,12 +19,12 @@ services:
index: / index: /
port_map: "3000" port_map: "3000"
ports: ports:
- configurable: "no" -
container: "3000" container: "3000"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
description: 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. 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 developer: OpenSpeedTest

16
Apps/PhotoPrism/docker-compose.yml
View File

@ -28,33 +28,33 @@ services:
category: Gallery category: Gallery
container: container:
envs: envs:
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: TimeZone en_US: TimeZone
- configurable: basic -
container: PHOTOPRISM_UPLOAD_NSFW container: PHOTOPRISM_UPLOAD_NSFW
description: description:
en_US: true or false, is it possible to upload NSFW en_US: true or false, is it possible to upload NSFW
- configurable: basic -
container: PHOTOPRISM_ADMIN_PASSWORD container: PHOTOPRISM_ADMIN_PASSWORD
description: description:
en_US: The password of admin en_US: The password of admin
index: / index: /
port_map: "2342" port_map: "2342"
ports: ports:
- configurable: advanced -
container: "2342" container: "2342"
description: description:
en_US: WebUI HTTP Port en_US: WebUI HTTP Port
protocol: tcp
shell: bash
volumes: volumes:
- configurable: "no" -
container: /photoprism/storage container: /photoprism/storage
description: description:
en_US: PhotoPrism storage directory. en_US: PhotoPrism storage directory.
- configurable: advanced -
container: /photoprism/originals container: /photoprism/originals
description: description:
en_US: PhotoPrism originals directory. en_US: PhotoPrism originals directory.

28
Apps/Pihole/docker-compose.yml
View File

@ -41,57 +41,57 @@ services:
category: Network category: Network
container: container:
envs: envs:
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: TimeZone en_US: TimeZone
- configurable: basic -
container: WEBPASSWORD container: WEBPASSWORD
description: description:
en_US: Pi-hole admin password en_US: Pi-hole admin password
- configurable: advanced -
container: VIRTUAL_HOST container: VIRTUAL_HOST
description: description:
en_US: Pi-hole Custom Hostname en_US: Pi-hole Custom Hostname
- configurable: advanced -
container: PROXY_LOCATION container: PROXY_LOCATION
description: description:
en_US: Pi-hole PROXY_LOCATION en_US: Pi-hole PROXY_LOCATION
index: /admin index: /admin
port_map: "80" port_map: "80"
ports: ports:
- configurable: advanced -
container: "80" container: "80"
description: description:
en_US: WebUI HTTP Port en_US: WebUI HTTP Port
protocol: tcp
- configurable: "no" -
container: "53" container: "53"
description: description:
en_US: Pihole DNS port en_US: Pihole DNS port
protocol: tcp
- configurable: "no" -
container: "53" container: "53"
description: description:
en_US: Pihole DNS port en_US: Pihole DNS port
protocol: udp protocol: udp
- configurable: "no" -
container: "67" container: "67"
description: description:
en_US: Pihole DHCP IPv4 port en_US: Pihole DHCP IPv4 port
protocol: udp protocol: udp
- configurable: "no" -
container: "547" container: "547"
description: description:
en_US: Pihole DHCP IPv6 port en_US: Pihole DHCP IPv6 port
protocol: udp protocol: udp
shell: bash
volumes: volumes:
- configurable: "no" -
container: /etc/pihole container: /etc/pihole
description: description:
en_US: Pi-hole /etc/pihole directory. en_US: Pi-hole /etc/pihole directory.
- configurable: "no" -
container: /etc/dnsmasq.d container: /etc/dnsmasq.d
description: description:
en_US: Pi-hole /etc/dnsmasq.d directory. en_US: Pi-hole /etc/dnsmasq.d directory.

12
Apps/Plex/docker-compose.yml
View File

@ -27,27 +27,27 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: Run Plex as specified uid. en_US: Run Plex as specified uid.
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: Run Plex as specified gid. en_US: Run Plex as specified gid.
- configurable: "no" -
container: VERSION container: VERSION
description: description:
en_US: Let Docker handle the Plex Version en_US: Let Docker handle the Plex Version
index: /web/index.html index: /web/index.html
port_map: "32400" port_map: "32400"
shell: bash
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: Plex config directory. en_US: Plex config directory.
- configurable: advanced -
container: /Media container: /Media
description: description:
en_US: Plex Media directory. en_US: Plex Media directory.

14
Apps/Prowlarr/docker-compose.yml
View File

@ -25,28 +25,28 @@ services:
category: Downloader category: Downloader
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
port_map: "9696" port_map: "9696"
ports: ports:
- configurable: "no" -
container: "9696" container: "9696"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""

18
Apps/Radarr/docker-compose.yml
View File

@ -31,37 +31,37 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: TimeZone en_US: TimeZone
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: Run Radarr as specified uid. en_US: Run Radarr as specified uid.
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: Run Radarr as specified gid. en_US: Run Radarr as specified gid.
index: / index: /
port_map: "7878" port_map: "7878"
ports: ports:
- configurable: advanced -
container: "7878" container: "7878"
description: description:
en_US: WebUI HTTP Port en_US: WebUI HTTP Port
protocol: tcp
shell: bash
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: Radarr config directory. en_US: Radarr config directory.
- configurable: advanced -
container: /movies container: /movies
description: description:
en_US: Radarr movies directory. en_US: Radarr movies directory.
- configurable: advanced -
container: /downloads container: /downloads
description: description:
en_US: Radarr downloads directory. en_US: Radarr downloads directory.

18
Apps/Readarr/docker-compose.yml
View File

@ -31,36 +31,36 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
port_map: "8787" port_map: "8787"
ports: ports:
- configurable: "no" -
container: "8787" container: "8787"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /books container: /books
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /downloads container: /downloads
description: description:
en_US: "" en_US: ""

18
Apps/Sabnzbd/docker-compose.yml
View File

@ -31,36 +31,36 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
port_map: "8080" port_map: "8080"
ports: ports:
- configurable: "no" -
container: "8080" container: "8080"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /incomplete-downloads container: /incomplete-downloads
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /downloads container: /downloads
description: description:
en_US: "" en_US: ""

18
Apps/Sickchill/docker-compose.yml
View File

@ -31,36 +31,36 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
port_map: "8081" port_map: "8081"
ports: ports:
- configurable: "no" -
container: "8081" container: "8081"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /downloads container: /downloads
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /tv container: /tv
description: description:
en_US: "" en_US: ""

16
Apps/Smokeping/docker-compose.yml
View File

@ -28,32 +28,32 @@ services:
category: Network category: Network
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
port_map: "80" port_map: "80"
ports: ports:
- configurable: "no" -
container: "80" container: "80"
description: description:
en_US: "" en_US: ""
protocol: tcp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /data container: /data
description: description:
en_US: "" en_US: ""

18
Apps/Sonarr/docker-compose.yml
View File

@ -31,37 +31,37 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: TimeZone en_US: TimeZone
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: Run Sonarr as specified uid. en_US: Run Sonarr as specified uid.
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: Run Sonarr as specified gid. en_US: Run Sonarr as specified gid.
index: / index: /
port_map: "8989" port_map: "8989"
ports: ports:
- configurable: advanced -
container: "8989" container: "8989"
description: description:
en_US: WebUI HTTP Port en_US: WebUI HTTP Port
protocol: tcp
shell: bash
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: Sonarr config directory. en_US: Sonarr config directory.
- configurable: advanced -
container: /tv container: /tv
description: description:
en_US: Sonarr tv directory. en_US: Sonarr tv directory.
- configurable: advanced -
container: /downloads container: /downloads
description: description:
en_US: Sonarr downloads directory. en_US: Sonarr downloads directory.

24
Apps/Syncthing/docker-compose.yml
View File

@ -37,48 +37,48 @@ services:
category: Backup category: Backup
container: container:
envs: envs:
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: TimeZone en_US: TimeZone
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: Run Syncthing as specified uid. en_US: Run Syncthing as specified uid.
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: Run Syncthing as specified gid. en_US: Run Syncthing as specified gid.
index: / index: /
port_map: "8384" port_map: "8384"
ports: ports:
- configurable: advanced -
container: "8384" container: "8384"
description: description:
en_US: WebUI HTTP Port en_US: WebUI HTTP Port
protocol: tcp
- configurable: "no" -
container: "22000" container: "22000"
description: description:
en_US: Syncthing listening Port (TCP) en_US: Syncthing listening Port (TCP)
protocol: tcp
- configurable: "no" -
container: "22000" container: "22000"
description: description:
en_US: Syncthing listening Port (UDP) en_US: Syncthing listening Port (UDP)
protocol: udp protocol: udp
- configurable: "no" -
container: "21027" container: "21027"
description: description:
en_US: Syncthing protocol discovery Port (TCP) en_US: Syncthing protocol discovery Port (TCP)
protocol: udp protocol: udp
shell: bash
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: Syncthing config directory. en_US: Syncthing config directory.
- configurable: advanced -
container: /DATA container: /DATA
description: description:
en_US: Syncthing Accessible Directory. en_US: Syncthing Accessible Directory.

14
Apps/TailscaleDaemon/docker-compose.yml
View File

@ -31,30 +31,30 @@ services:
category: Network category: Network
container: container:
envs: envs:
- configurable: advanced -
container: TS_AUTH_ONCE container: TS_AUTH_ONCE
description: 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. 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 container: TS_EXTRA_ARGS
description: description:
en_US: extra arguments to 'tailscale up'. en_US: extra arguments to 'tailscale up'.
- configurable: advanced -
container: TS_STATE_DIR container: TS_STATE_DIR
description: description:
en_US: the directory in which to store tailscaled state. The data should persist across container restarts. en_US: the directory in which to store tailscaled state. The data should persist across container restarts.
port_map: "80" port_map: "80"
shell: sh
volumes: volumes:
- configurable: "no" -
container: /dev/net/tun container: /dev/net/tun
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /var/lib container: /var/lib
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /var/lib/tailscale container: /var/lib/tailscale
description: description:
en_US: "" en_US: ""

12
Apps/Tautulli/docker-compose.yml
View File

@ -24,29 +24,29 @@ services:
category: Media category: Media
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
index: / index: /
port_map: "8181" port_map: "8181"
ports: ports:
- configurable: "no" -
container: "8181" container: "8181"
description: description:
en_US: "" en_US: ""
protocol: "" protocol: ""
shell: bash
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""

32
Apps/Transmission/docker-compose.yml
View File

@ -41,63 +41,63 @@ services:
category: Network category: Network
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: TRANSMISSION_WEB_HOME container: TRANSMISSION_WEB_HOME
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: USER container: USER
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PASS container: PASS
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PEERPORT container: PEERPORT
description: description:
en_US: "" en_US: ""
index: / index: /
port_map: "9091" port_map: "9091"
ports: ports:
- configurable: "no" -
container: "9091" container: "9091"
description: description:
en_US: "" en_US: ""
protocol: tcp
- configurable: "no" -
container: "51413" container: "51413"
description: description:
en_US: "" en_US: ""
protocol: tcp
- configurable: "no" -
container: "51413" container: "51413"
description: description:
en_US: "" en_US: ""
protocol: udp protocol: udp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /downloads container: /downloads
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: /watch container: /watch
description: description:
en_US: "" en_US: ""

40
Apps/Unifi-controller/docker-compose.yml
View File

@ -50,73 +50,73 @@ services:
category: Network category: Network
container: container:
envs: envs:
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: MEM_LIMIT container: MEM_LIMIT
description: description:
en_US: "" en_US: ""
- configurable: "no" -
container: MEM_STARTUP container: MEM_STARTUP
description: description:
en_US: "" en_US: ""
index: / index: /
port_map: "8080" port_map: "8080"
ports: ports:
- configurable: "no" -
container: "3478" container: "3478"
description: description:
en_US: "" en_US: ""
protocol: udp protocol: udp
- configurable: "no" -
container: "10001" container: "10001"
description: description:
en_US: "" en_US: ""
protocol: udp protocol: udp
- configurable: "no" -
container: "8080" container: "8080"
description: description:
en_US: "" en_US: ""
protocol: tcp
- configurable: "no" -
container: "8443" container: "8443"
description: description:
en_US: "" en_US: ""
protocol: tcp
- configurable: "no" -
container: "1900" container: "1900"
description: description:
en_US: "" en_US: ""
protocol: udp protocol: udp
- configurable: "no" -
container: "8843" container: "8843"
description: description:
en_US: "" en_US: ""
protocol: tcp
- configurable: "no" -
container: "8880" container: "8880"
description: description:
en_US: "" en_US: ""
protocol: tcp
- configurable: "no" -
container: "6789" container: "6789"
description: description:
en_US: "" en_US: ""
protocol: tcp
- configurable: "no" -
container: "5514" container: "5514"
description: description:
en_US: "" en_US: ""
protocol: udp protocol: udp
shell: sh
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: "" en_US: ""

8
Apps/UptimeKuma/docker-compose.yml
View File

@ -23,14 +23,14 @@ services:
index: / index: /
port_map: "3001" port_map: "3001"
ports: ports:
- configurable: advanced -
container: "3001" container: "3001"
description: description:
en_US: WebUI Port en_US: WebUI Port
protocol: tcp
shell: sh
volumes: volumes:
- configurable: advanced -
container: /app/data container: /app/data
description: description:
en_US: Uptime Kuma data directory. en_US: Uptime Kuma data directory.

8
Apps/Vaultwarden/docker-compose.yml
View File

@ -23,14 +23,14 @@ services:
index: / index: /
port_map: "80" port_map: "80"
ports: ports:
- configurable: advanced -
container: "80" container: "80"
description: description:
en_US: WebUI HTTP Port en_US: WebUI HTTP Port
protocol: tcp
shell: bash
volumes: volumes:
- configurable: "no" -
container: /data container: /data
description: description:
en_US: Vaultwarden data directory. en_US: Vaultwarden data directory.

10
Apps/VoceChat/docker-compose.yml
View File

@ -23,21 +23,21 @@ services:
category: Chat category: Chat
container: container:
envs: envs:
- configurable: "yes" -
container: TZ container: TZ
description: description:
en_US: TimeZone en_US: TimeZone
index: / index: /
port_map: "3000" port_map: "3000"
ports: ports:
- configurable: advanced -
container: "3000" container: "3000"
description: description:
en_US: WebUI HTTP Port en_US: WebUI HTTP Port
protocol: tcp
shell: bash
volumes: volumes:
- configurable: "no" -
container: /home/vocechat-server/data container: /home/vocechat-server/data
description: description:
en_US: VoceChat Data en_US: VoceChat Data

18
Apps/qBittorrent/docker-compose.yml
View File

@ -29,37 +29,37 @@ services:
category: Downloader category: Downloader
container: container:
envs: envs:
- configurable: "no" -
container: TZ container: TZ
description: description:
en_US: TimeZone en_US: TimeZone
- configurable: "no" -
container: PUID container: PUID
description: description:
en_US: Run qBittorrent as specified uid. en_US: Run qBittorrent as specified uid.
- configurable: "no" -
container: PGID container: PGID
description: description:
en_US: Run qBittorrent as specified gid. en_US: Run qBittorrent as specified gid.
- configurable: "no" -
container: UMASK container: UMASK
description: description:
en_US: Run qBittorrent as specified UMASK. en_US: Run qBittorrent as specified UMASK.
index: / index: /
port_map: "8080" port_map: "8080"
ports: ports:
- configurable: advanced -
container: "8080" container: "8080"
description: description:
en_US: WebUI HTTP Port en_US: WebUI HTTP Port
protocol: tcp
shell: bash
volumes: volumes:
- configurable: "no" -
container: /config container: /config
description: description:
en_US: qBittorrent config directory. en_US: qBittorrent config directory.
- configurable: advanced -
container: /DATA container: /DATA
description: description:
en_US: qBittorrent Accessible directory. en_US: qBittorrent Accessible directory.

89
CONTRIBUTING.md Normal file
View File

@ -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.
```