Merge pull request #684 from openziti/docker-multi-share

demonstrate adding public share containers to the compose project

CHANGELOG.md

@@ -6,6 +6,8 @@ FEATURE: Linux service support for all private share modes (contribution from St
 
 FIX: Fix for mixing limited and unlimited (-1) resource counts in the limits system (https://github.com/openziti/zrok/issues/680)
 
+CHANGE: add Docker compose example for multiple share containers using the same enabled environment in [compose.override.yml](./docker/compose/zrok-public-reserved/compose.override.yml)
+
 CHANGE: bump many GitHub Actions that were using deprecated distributions of Node.js
 
 CHANGE: bump macOS runner for Node SDK from macos-11 to macos-12

docker/compose/zrok-public-reserved/.gitignore

@@ -1,2 +1 @@
-.env
-*compose.override.yml
+.env

docker/compose/zrok-public-reserved/compose.override.yml

@@ -0,0 +1,18 @@
+services:
+  my-other-zrok-share:
+    image: ${ZROK_CONTAINER_IMAGE:-docker.io/openziti/zrok}
+    restart: unless-stopped
+    entrypoint: zrok-share.bash
+    depends_on:
+      zrok-enable:
+        condition: service_completed_successfully
+    volumes:
+      - zrok_env:/mnt
+      - ./Caddyfile:/Caddyfile
+    environment:
+      # most relevant options
+      ZROK_UNIQUE_NAME:     "my-other-zrok-share"
+      ZROK_BACKEND_MODE:    caddy
+      ZROK_TARGET:          /Caddyfile
+      # internal configuration
+      STATE_DIRECTORY: /mnt  # zrok homedir in container

docker/compose/zrok-public-share/.gitignore

@@ -1,2 +0,0 @@
-.env
-*compose.override.yml

docker/compose/zrok-public-share/compose.yml

@@ -1,62 +0,0 @@
-services:
-
-  # set file ownership
-  zrok-init:
-    image: busybox
-    # matches uid:gid of "ziggy" in zrok container image
-    command: chown -Rc 2171:2171 /mnt/.zrok
-    user: root
-    volumes:
-      - zrok_env:/mnt/.zrok
-
-  # enable zrok environment
-  zrok-enable:
-    image: ${ZROK_CONTAINER_IMAGE:-docker.io/openziti/zrok}
-    depends_on:
-      zrok-init:
-        condition: service_completed_successfully
-    entrypoint: zrok-enable.bash
-    volumes:
-      - zrok_env:/mnt
-    environment:
-      STATE_DIRECTORY: /mnt
-      ZROK_ENABLE_TOKEN:
-      ZROK_API_ENDPOINT:
-      ZROK_ENVIRONMENT_NAME: docker-public-share
-
-  # provision a temporary zrok frontend subdomain and start sharing the backend target
-  zrok-share:
-    image: ${ZROK_CONTAINER_IMAGE:-docker.io/openziti/zrok}
-    restart: no
-    entrypoint: zrok-share.bash
-    depends_on:
-      zrok-enable:
-        condition: service_completed_successfully
-    volumes:
-      - zrok_env:/mnt
-    environment:
-      # internal configuration
-      STATE_DIRECTORY: /mnt  # zrok homedir in container
-      ZROK_FRONTEND_MODE: temp-public  # tells zrok-share.bash to create a temporary subdomain and share until exit
-
-      # most relevant options
-      ZROK_BACKEND_MODE: proxy  # web, caddy, drive, proxy
-      ZROK_TARGET: http://zrok-test:9090  # backend target, is a path in container filesystem unless proxy mode
-      ZROK_INSECURE:        # "--insecure" if proxy target has unverifiable TLS server certificate
-      ZROK_OAUTH_PROVIDER:  # google, github
-      ZROK_OAUTH_EMAILS:    # allow space-separated list of OAuth email address glob patterns
-      ZROK_BASIC_AUTH:      # username:password, mutually-exclusive with ZROK_OAUTH_PROVIDER
-
-      # least relevant options
-      ZROK_VERBOSE:           # "--verbose"
-      ZROK_SHARE_OPTS:        # additional arguments to "zrok share public" command
-      ZROK_FRONTENDS:         # "public"
-      PFXLOG_NO_JSON: "true"  # suppress JSON logging format
-
-  # demo server you can share with zrok
-  zrok-test:
-    image: ${ZROK_CONTAINER_IMAGE:-docker.io/openziti/zrok}
-    command: test endpoint --address 0.0.0.0  # 9090
-
-volumes:
-  zrok_env: