move `port_map`, `index`, `hostname`, `scheme` from container level `x-casaos` to root level `x-casaos` (#35)

Signed-off-by: Tiger Wang <tigerwang@outlook.com>
2023-04-26 20:35:07 -04:00 · 2023-04-26 20:35:07 -04:00 · fc5e69ed99
parent 261a45b607
commit fc5e69ed99
46 changed files with 81 additions and 82 deletions
--- a/Apps/2FAuth/docker-compose.yml
+++ b/Apps/2FAuth/docker-compose.yml
@ -17,8 +17,6 @@ services:
        source: /DATA/AppData/$AppID
        target: /2fauth
    x-casaos:
-      index: /
-      port_map: "8000"
      ports:
        - container: "8000"
          description:
@ -74,3 +72,5 @@ x-casaos:
  tips: {}
  title:
    en_us: 2FAuth
+  index: /
+  port_map: "8000"
--- a/Apps/AdGuardHome/docker-compose.yml
+++ b/Apps/AdGuardHome/docker-compose.yml
@ -32,8 +32,6 @@ services:
        source: /DATA/AppData/$AppID/opt/adguardhome/conf
        target: /opt/adguardhome/conf
    x-casaos:
-      index: /
-      port_map: "3001"
      ports:
        - container: "53"
          description:
@ -106,3 +104,5 @@ x-casaos:
  tips: {}
  title:
    en_us: AdGuard Home
+  index: /
+  port_map: "3001"
--- a/Apps/AllTubeDownload/docker-compose.yml
+++ b/Apps/AllTubeDownload/docker-compose.yml
@ -13,8 +13,6 @@ services:
        protocol: tcp
    restart: always
    x-casaos:
-      index: /
-      port_map: "10480"
      ports:
        - container: "80"
          description:
@ -65,3 +63,5 @@ x-casaos:
  title:
    en_us: AllTube Download
    zh_cn: AllTube 下载
+  index: /
+  port_map: "10480"
--- a/Apps/Bazarr/docker-compose.yml
+++ b/Apps/Bazarr/docker-compose.yml
@ -37,7 +37,6 @@ services:
        - container: TZ
          description:
            en_us: ""
-      port_map: "6767"
      ports:
        - container: "6767"
          description:
@ -100,3 +99,4 @@ x-casaos:
  tips: {}
  title:
    en_us: Bazarr
+  port_map: "6767"
--- a/Apps/Calibre-web/docker-compose.yml
+++ b/Apps/Calibre-web/docker-compose.yml
@ -38,8 +38,6 @@ services:
        - container: DOCKER_MODS
          description:
            en_us: ""
-      index: /
-      port_map: "8083"
      ports:
        - container: "8083"
          description:
@ -107,3 +105,5 @@ x-casaos:
        | `admin`    | `admin123` |
  title:
    en_us: Calibre-web
+  index: /
+  port_map: "8083"
--- a/Apps/CouchPotato/docker-compose.yml
+++ b/Apps/CouchPotato/docker-compose.yml
@ -40,8 +40,6 @@ services:
          description:
            en_us: Run CouchPotato as specified gid.
            zh_cn: 以指定的gid运行CouchPotato
-      index: /
-      port_map: "5050"
      ports:
        - container: "5050"
          description:
@ -109,3 +107,5 @@ x-casaos:
  tips: {}
  title:
    en_us: CouchPotato
+  index: /
+  port_map: "5050"
--- a/Apps/Deluge/docker-compose.yml
+++ b/Apps/Deluge/docker-compose.yml
@ -48,8 +48,6 @@ services:
          description:
            en_us: Deluge Log Level
            zh_cn: Deluge 日志级别
-      index: /
-      port_map: "8112"
      ports:
        - container: "8112"
          description:
@ -152,3 +150,5 @@ x-casaos:
        请确保在使用 Deluge 时使用正确的路径。
  title:
    en_us: Deluge
+  index: /
+  port_map: "8112"
--- a/Apps/Duplicati/docker-compose.yml
+++ b/Apps/Duplicati/docker-compose.yml
@ -37,8 +37,6 @@ services:
        - container: TZ
          description:
            en_us: ""
-      index: /
-      port_map: "8200"
      ports:
        - container: "8200"
          description:
@ -99,3 +97,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Duplicati
+  index: /
+  port_map: "8200"
--- a/Apps/Emby/docker-compose.yml
+++ b/Apps/Emby/docker-compose.yml
@ -46,8 +46,6 @@ services:
        - container: TZ
          description:
            en_us: ""
-      index: /
-      port_map: "8096"
      ports:
        - container: "8096"
          description:
@ -113,3 +111,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Emby
+  index: /
+  port_map: "8096"
--- a/Apps/Embystat/docker-compose.yml
+++ b/Apps/Embystat/docker-compose.yml
@ -31,7 +31,6 @@ services:
        - container: TZ
          description:
            en_us: ""
-      port_map: "6555"
      ports:
        - container: "6555"
          description:
@ -87,3 +86,4 @@ x-casaos:
  tips: {}
  title:
    en_us: Embystat
+  port_map: "6555"
--- a/Apps/FileBrowser/docker-compose.yml
+++ b/Apps/FileBrowser/docker-compose.yml
@ -37,8 +37,6 @@ services:
          description:
            en_us: Run FileBrowser as specified gid.
            zh_cn: 以指定的组ID运行FileBrowser
-      index: /
-      port_map: "10180"
      ports:
        - container: "80"
          description:
@ -113,3 +111,5 @@ x-casaos:
        | `admin`    | `admin`    |
  title:
    en_us: FileBrowser
+  index: /
+  port_map: "10180"
--- a/Apps/Gitea/docker-compose.yml
+++ b/Apps/Gitea/docker-compose.yml
@ -32,8 +32,6 @@ services:
          description:
            en_us: The GID (Unix group ID) of the user that runs Gitea
            zh_cn: Gitea 运行的用户的 GID（Unix 组 ID）
-      index: /
-      port_map: "3002"
      ports:
        - container: "3000"
          description:
@ -103,3 +101,5 @@ x-casaos:
        安装应用后，注册的第一个账号将成为管理员账号。
  title:
    en_us: Gitea
+  index: /
+  port_map: "3002"
--- a/Apps/Grafana/docker-compose.yml
+++ b/Apps/Grafana/docker-compose.yml
@ -13,8 +13,6 @@ services:
        protocol: tcp
    restart: always
    x-casaos:
-      index: /
-      port_map: "3003"
      ports:
        - container: "3000"
          description:
@ -101,3 +99,5 @@ x-casaos:
        | `admin`    | `admin`    |
  title:
    en_us: Grafana
+  index: /
+  port_map: "3003"
--- a/Apps/HomeAssistant/docker-compose.yml
+++ b/Apps/HomeAssistant/docker-compose.yml
@ -30,8 +30,6 @@ services:
          description:
            en_us: Run HomeAssistant as specified gid.
            zh_cn: 以指定的gid运行HomeAssistant
-      index: /
-      port_map: "8123"

      volumes:
        - container: /config
@ -85,3 +83,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Home Assistant
+  index: /
+  port_map: "8123"
--- a/Apps/Jackett/docker-compose.yml
+++ b/Apps/Jackett/docker-compose.yml
@ -38,8 +38,6 @@ services:
        - container: AUTO_UPDATE
          description:
            en_us: ""
-      index: /
-      port_map: "9117"
      ports:
        - container: "9117"
          description:
@ -98,3 +96,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Jackett
+  index: /
+  port_map: "9117"
--- a/Apps/Jellyfin/docker-compose.yml
+++ b/Apps/Jellyfin/docker-compose.yml
@ -61,8 +61,6 @@ services:
          description:
            en_us: The autodiscovery response domain or IP address.
            zh_cn: 自动发现响应域名或IP地址
-      index: /
-      port_map: "8096"
      ports:
        - container: "8096"
          description:
@ -145,3 +143,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Jellyfin
+  index: /
+  port_map: "8096"
--- a/Apps/Lazylibrarian/docker-compose.yml
+++ b/Apps/Lazylibrarian/docker-compose.yml
@ -41,7 +41,6 @@ services:
        - container: DOCKER_MODS
          description:
            en_us: ""
-      port_map: "5299"
      ports:
        - container: "5299"
          description:
@ -103,4 +102,4 @@ x-casaos:
  tips: {}
  title:
    en_us: Lazylibrarian
-    zh_cn: Lazylibrarian
+  port_map: "5299"
--- a/Apps/Lidarr/docker-compose.yml
+++ b/Apps/Lidarr/docker-compose.yml
@ -37,7 +37,6 @@ services:
        - container: TZ
          description:
            en_us: ""
-      port_map: "8686"
      ports:
        - container: "8686"
          description:
@ -99,3 +98,4 @@ x-casaos:
  tips: {}
  title:
    en_us: Lidarr
+  port_map: "8686"
--- a/Apps/Mylar3/docker-compose.yml
+++ b/Apps/Mylar3/docker-compose.yml
@ -33,7 +33,6 @@ services:
        - container: PGID
          description:
            en_us: ""
-      port_map: "8090"
      ports:
        - container: "8090"
          description:
@ -96,3 +95,4 @@ x-casaos:
  tips: {}
  title:
    en_us: Mylar3
+  port_map: "8090"
--- a/Apps/N8n/docker-compose.yml
+++ b/Apps/N8n/docker-compose.yml
@ -24,8 +24,6 @@ services:
          description:
            en_us: TimeZone
            zh_cn: 时区
-      index: /
-      port_map: "5678"
      ports:
        - container: "5678"
          description:
@ -83,3 +81,5 @@ x-casaos:
  tips: {}
  title:
    en_us: n8n
+  index: /
+  port_map: "5678"
--- a/Apps/Nextcloud/docker-compose.yml
+++ b/Apps/Nextcloud/docker-compose.yml
@ -20,8 +20,6 @@ services:
        source: /DATA/AppData/$AppID/var/www/html
        target: /var/www/html
    x-casaos:
-      index: /
-      port_map: "10080"
      ports:
        - container: "80"
          description:
@ -88,3 +86,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Nextcloud
+  index: /
+  port_map: "10080"
--- a/Apps/NginxProxyManager/docker-compose.yml
+++ b/Apps/NginxProxyManager/docker-compose.yml
@ -26,8 +26,6 @@ services:
        source: /DATA/AppData/$AppID/etc/letsencrypt
        target: /etc/letsencrypt
    x-casaos:
-      index: /
-      port_map: "81"
      ports:
        - container: "80"
          description:
@ -123,3 +121,5 @@ x-casaos:
  title:
    en_us: Nginx Proxy Manager
    zh_cn: Nginx 代理管理器
+  index: /
+  port_map: "81"
--- a/Apps/Node-RED/docker-compose.yml
+++ b/Apps/Node-RED/docker-compose.yml
@ -17,8 +17,6 @@ services:
        source: /DATA/AppData/$AppID/data
        target: /data
    x-casaos:
-      index: /
-      port_map: "1880"
      ports:
        - container: "1880"
          description:
@ -75,3 +73,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Node-RED
+  index: /
+  port_map: "1880"
--- a/Apps/Nzbget/docker-compose.yml
+++ b/Apps/Nzbget/docker-compose.yml
@ -42,7 +42,6 @@ services:
        - container: NZBGET_PASS
          description:
            en_us: ""
-      port_map: "6789"
      ports:
        - container: "6789"
          description:
@ -102,3 +101,4 @@ x-casaos:
  tips: {}
  title:
    en_us: Nzbget
+  port_map: "6789"
--- a/Apps/Ombi/docker-compose.yml
+++ b/Apps/Ombi/docker-compose.yml
@ -35,7 +35,6 @@ services:
        - container: BASE_URL
          description:
            en_us: ""
-      port_map: "3579"
      ports:
        - container: "3579"
          description:
@ -91,3 +90,4 @@ x-casaos:
  tips: {}
  title:
    en_us: Ombi
+  port_map: "3579"
--- a/Apps/OpenHAB/docker-compose.yml
+++ b/Apps/OpenHAB/docker-compose.yml
@ -44,8 +44,6 @@ services:
          description:
            en_us: Run OpenHAB as specified gid.
            zh_cn: 以指定的gid运行OpenHAB。
-      index: /
-      port_map: "8080"

      volumes:
        - container: /etc/localtime
@ -117,3 +115,5 @@ x-casaos:
  tips: {}
  title:
    en_us: OpenHAB
+  index: /
+  port_map: "8080"
--- a/Apps/OpenSpeedTest/docker-compose.yml
+++ b/Apps/OpenSpeedTest/docker-compose.yml
@ -13,8 +13,6 @@ services:
        protocol: tcp
    restart: always
    x-casaos:
-      index: /
-      port_map: "3004"
      ports:
        - container: "3000"
          description:
@ -69,3 +67,5 @@ x-casaos:
  tips: {}
  title:
    en_us: OpenSpeedTest
+  index: /
+  port_map: "3004"
--- a/Apps/PhotoPrism/docker-compose.yml
+++ b/Apps/PhotoPrism/docker-compose.yml
@ -37,8 +37,6 @@ services:
          description:
            en_us: The password of admin
            zh_cn: 管理员密码
-      index: /
-      port_map: "2342"
      ports:
        - container: "2342"
          description:
@ -112,3 +110,5 @@ x-casaos:
        | `admin`    | `casaos`   |
  title:
    en_us: PhotoPrism
+  index: /
+  port_map: "2342"
--- a/Apps/Pihole/docker-compose.yml
+++ b/Apps/Pihole/docker-compose.yml
@ -53,8 +53,6 @@ services:
        - container: PROXY_LOCATION
          description:
            en_us: Pi-hole PROXY_LOCATION
-      index: /admin
-      port_map: "8800"
      ports:
        - container: "80"
          description:
@ -143,3 +141,5 @@ x-casaos:
        默认密码：`casaos`
  title:
    en_us: Pi-hole
+  index: /admin
+  port_map: "8800"
--- a/Apps/Plex/docker-compose.yml
+++ b/Apps/Plex/docker-compose.yml
@ -36,8 +36,6 @@ services:
          description:
            en_us: Let Docker handle the Plex Version
            zh_cn: 让Docker处理Plex版本
-      index: /web/index.html
-      port_map: "32400"

      volumes:
        - container: /config
@ -94,3 +92,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Plex
+  index: /web/index.html
+  port_map: "32400"
--- a/Apps/Prowlarr/docker-compose.yml
+++ b/Apps/Prowlarr/docker-compose.yml
@ -31,7 +31,6 @@ services:
        - container: TZ
          description:
            en_us: ""
-      port_map: "9696"
      ports:
        - container: "9696"
          description:
@ -86,3 +85,4 @@ x-casaos:
  tips: {}
  title:
    en_us: Prowlarr
+  port_map: "9696"
--- a/Apps/Radarr/docker-compose.yml
+++ b/Apps/Radarr/docker-compose.yml
@ -40,8 +40,6 @@ services:
          description:
            en_us: Run Radarr as specified gid.
            zh_cn: 以指定的gid运行Radarr
-      index: /
-      port_map: "7878"
      ports:
        - container: "7878"
          description:
@ -108,3 +106,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Radarr
+  index: /
+  port_map: "7878"
--- a/Apps/Readarr/docker-compose.yml
+++ b/Apps/Readarr/docker-compose.yml
@ -37,7 +37,6 @@ services:
        - container: TZ
          description:
            en_us: ""
-      port_map: "8787"
      ports:
        - container: "8787"
          description:
@ -100,3 +99,4 @@ x-casaos:
  tips: {}
  title:
    en_us: Readarr
+  port_map: "8787"
--- a/Apps/Sabnzbd/docker-compose.yml
+++ b/Apps/Sabnzbd/docker-compose.yml
@ -37,7 +37,6 @@ services:
        - container: TZ
          description:
            en_us: ""
-      port_map: "8282"
      ports:
        - container: "8080"
          description:
@ -103,3 +102,4 @@ x-casaos:
  tips: {}
  title:
    en_us: Sabnzbd
+  port_map: "8282"
--- a/Apps/Sickchill/docker-compose.yml
+++ b/Apps/Sickchill/docker-compose.yml
@ -37,7 +37,6 @@ services:
        - container: TZ
          description:
            en_us: ""
-      port_map: "8081"
      ports:
        - container: "8081"
          description:
@ -115,3 +114,4 @@ x-casaos:
  tips: {}
  title:
    en_us: Sickchill
+  port_map: "8081"
--- a/Apps/Smokeping/docker-compose.yml
+++ b/Apps/Smokeping/docker-compose.yml
@ -34,7 +34,6 @@ services:
        - container: TZ
          description:
            en_us: ""
-      port_map: "10280"
      ports:
        - container: "80"
          description:
@ -95,3 +94,4 @@ x-casaos:
  tips: {}
  title:
    en_us: Smokeping
+  port_map: "10280"
--- a/Apps/Sonarr/docker-compose.yml
+++ b/Apps/Sonarr/docker-compose.yml
@ -40,8 +40,6 @@ services:
          description:
            en_us: Run Sonarr as specified gid.
            zh_cn: 以指定的gid运行Sonarr
-      index: /
-      port_map: "8989"
      ports:
        - container: "8989"
          description:
@ -107,3 +105,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Sonarr
+  index: /
+  port_map: "8989"
--- a/Apps/Syncthing/docker-compose.yml
+++ b/Apps/Syncthing/docker-compose.yml
@ -46,8 +46,6 @@ services:
          description:
            en_us: Run Syncthing as specified gid.
            zh_cn: 以指定的组ID运行Syncthing
-      index: /
-      port_map: "8384"
      ports:
        - container: "8384"
          description:
@ -121,3 +119,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Syncthing
+  index: /
+  port_map: "8384"
--- a/Apps/Tautulli/docker-compose.yml
+++ b/Apps/Tautulli/docker-compose.yml
@ -30,8 +30,6 @@ services:
        - container: TZ
          description:
            en_us: ""
-      index: /
-      port_map: "8181"
      ports:
        - container: "8181"
          description:
@ -89,3 +87,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Tautulli
+  index: /
+  port_map: "8181"
--- a/Apps/Transmission/docker-compose.yml
+++ b/Apps/Transmission/docker-compose.yml
@ -59,8 +59,6 @@ services:
        - container: PEERPORT
          description:
            en_us: ""
-      index: /
-      port_map: "9091"
      ports:
        - container: "9091"
          description:
@ -153,3 +151,5 @@ x-casaos:
        | `casaos` | `casaos` |
  title:
    en_us: Transmission
+  index: /
+  port_map: "9091"
--- a/Apps/Unifi-controller/docker-compose.yml
+++ b/Apps/Unifi-controller/docker-compose.yml
@ -59,8 +59,6 @@ services:
        - container: MEM_STARTUP
          description:
            en_us: ""
-      index: /
-      port_map: "8383"
      ports:
        - container: "3478"
          description:
@ -149,3 +147,5 @@ x-casaos:
  title:
    en_us: Unifi-controller
    zh_cn: Unifi控制器
+  index: /
+  port_map: "8383"
--- a/Apps/UptimeKuma/docker-compose.yml
+++ b/Apps/UptimeKuma/docker-compose.yml
@ -17,8 +17,6 @@ services:
        source: /DATA/AppData/$AppID/app/data
        target: /app/data
    x-casaos:
-      index: /
-      port_map: "3001"
      ports:
        - container: "3001"
          description:
@ -78,3 +76,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Uptime Kuma
+  index: /
+  port_map: "3001"
--- a/Apps/Vaultwarden/docker-compose.yml
+++ b/Apps/Vaultwarden/docker-compose.yml
@ -17,8 +17,6 @@ services:
        source: /DATA/AppData/$AppID/data
        target: /data
    x-casaos:
-      index: /
-      port_map: "10380"
      ports:
        - container: "80"
          description:
@ -76,3 +74,5 @@ x-casaos:
  tips: {}
  title:
    en_us: Vaultwarden
+  index: /
+  port_map: "10380"
--- a/Apps/VoceChat/docker-compose.yml
+++ b/Apps/VoceChat/docker-compose.yml
@ -24,8 +24,6 @@ services:
          description:
            en_us: TimeZone
            zh_cn: 时区
-      index: /
-      port_map: "3009"
      ports:
        - container: "3000"
          description:
@ -82,3 +80,5 @@ x-casaos:
  tips: {}
  title:
    en_us: VoceChat
+  index: /
+  port_map: "3009"
--- a/Apps/qBittorrent/docker-compose.yml
+++ b/Apps/qBittorrent/docker-compose.yml
@ -42,8 +42,6 @@ services:
          description:
            en_us: Run qBittorrent as specified UMASK.
            zh_cn: 以指定的 UMASK 运行 qBittorrent。
-      index: /
-      port_map: "8181"
      ports:
        - container: "8080"
          description:
@ -139,3 +137,5 @@ x-casaos:

  title:
    en_us: qBittorrent
+  index: /
+  port_map: "8181"
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -34,8 +34,6 @@ Each directory under [Apps](Apps) correspond to a CasaOS App. The directory shou

        ```yaml
        x-casaos:
-            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
@ -77,4 +75,6 @@ Each directory under [Apps](Apps) correspond to a CasaOS App. The directory shou
            thumbnail: https://cdn.jsdelivr.net/gh/IceWhaleTech/CasaOS-AppStore@main/Apps/Jellyfin/thumbnail.jpg
            title:       # multiple locales are supported
                en_us: Syncthing
+            index: /         # the index page for web UI, e.g. index.html
+            port_map: "8384" # the port for web UI
        ```