fix: update proxy service configuration in docker-compose for improved deployment

.github/workflows/build-branch.yml

@@ -117,6 +117,44 @@ jobs:
         name: Checkout Files
         uses: actions/checkout@v4
 
+      - name: Get changed files
+        id: changed_files
+        uses: tj-actions/changed-files@v42
+        with:
+          files_yaml: |
+            apiserver:
+              - apiserver/**
+            proxy:
+              - caddy/**
+            admin:
+              - admin/**
+              - packages/**
+              - "package.json"
+              - "yarn.lock"
+              - "tsconfig.json"
+              - "turbo.json"
+            space:
+              - space/**
+              - packages/**
+              - "package.json"
+              - "yarn.lock"
+              - "tsconfig.json"
+              - "turbo.json"
+            web:
+              - web/**
+              - packages/**
+              - "package.json"
+              - "yarn.lock"
+              - "tsconfig.json"
+              - "turbo.json"
+            live:
+              - live/**
+              - packages/**
+              - 'package.json'
+              - 'yarn.lock'
+              - 'tsconfig.json'
+              - 'turbo.json'
+
   branch_build_push_admin:
     name: Build-Push Admin Docker Image
     runs-on: ubuntu-22.04
@@ -242,8 +280,8 @@ jobs:
           dockerhub-token: ${{ secrets.DOCKERHUB_TOKEN }}
           docker-image-owner: makeplane
           docker-image-name: ${{ needs.branch_build_setup.outputs.dh_img_proxy }}
-          build-context: ./nginx
-          dockerfile-path: ./nginx/Dockerfile
+          build-context: ./caddy
+          dockerfile-path: ./caddy/Dockerfile
           buildx-driver: ${{ needs.branch_build_setup.outputs.gh_buildx_driver }}
           buildx-version: ${{ needs.branch_build_setup.outputs.gh_buildx_version }}
           buildx-platforms: ${{ needs.branch_build_setup.outputs.gh_buildx_platforms }}

aio/Dockerfile-app

@@ -11,7 +11,7 @@ WORKDIR /app
 RUN yarn global add turbo
 COPY . .
 
-RUN turbo prune --scope=web --scope=space --scope=admin --docker
+RUN turbo prune --scope=web --scope=space --scope=admin --scope=live --docker
 
 # *****************************************************************************
 # STAGE 2: Install dependencies & build the project
@@ -53,7 +53,7 @@ ENV NEXT_PUBLIC_WEB_BASE_URL=$NEXT_PUBLIC_WEB_BASE_URL
 ENV NEXT_TELEMETRY_DISABLED=1
 ENV TURBO_TELEMETRY_DISABLED=1
 
-RUN yarn turbo run build --filter=web --filter=space --filter=admin
+RUN yarn turbo run build --filter=web --filter=space --filter=admin --filter=live
 
 # *****************************************************************************
 # STAGE 3: Copy the project and start it
@@ -87,6 +87,8 @@ RUN chmod +x ./api/bin/*
 RUN chmod -R 777 ./api/
 
 # NEXTJS BUILDS
+COPY --from=installer /app/node_modules ./node_modules/
+
 COPY --from=installer /app/web/next.config.js ./web/
 COPY --from=installer /app/web/package.json ./web/
 COPY --from=installer /app/web/.next/standalone ./web
@@ -105,6 +107,10 @@ COPY --from=installer /app/admin/.next/standalone ./admin
 COPY --from=installer /app/admin/.next/static ./admin/admin/.next/static
 COPY --from=installer /app/admin/public ./admin/admin/public
 
+COPY --from=installer /app/live/package.json ./live/
+COPY --from=installer /app/live/dist ./live/dist
+# COPY --from=installer /app/live/node_modules ./live/node_modules
+
 ARG NEXT_PUBLIC_API_BASE_URL=""
 ENV NEXT_PUBLIC_API_BASE_URL=$NEXT_PUBLIC_API_BASE_URL
 

aio/nginx.conf

@@ -45,6 +45,14 @@ http {
             proxy_pass http://localhost:3003/god-mode/;
         }
 
+        location /live/ {
+            proxy_http_version 1.1;
+            proxy_set_header Upgrade ${dollar}http_upgrade;
+            proxy_set_header Connection "upgrade";
+            proxy_set_header Host ${dollar}http_host;
+            proxy_pass http://localhost:3004/;
+        }
+
         location /api/ {
             proxy_http_version 1.1;
             proxy_set_header Upgrade ${dollar}http_upgrade;

aio/supervisord-app

@@ -29,6 +29,16 @@ stderr_logfile=/dev/stdout
 stderr_logfile_maxbytes=0
 environment=PORT=3003,HOSTNAME=0.0.0.0
 
+[program:live]
+command=node /app/live/dist/server.js
+autostart=true
+autorestart=true
+stdout_logfile=/dev/stdout
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/stdout
+stderr_logfile_maxbytes=0
+environment=PORT=3004,HOSTNAME=0.0.0.0,API_BASE_URL="http://localhost:8000"
+
 [program:migrator]
 directory=/app/api
 command=sh -c "./bin/docker-entrypoint-migrator.sh"

caddy/Caddyfile.template

@@ -0,0 +1,34 @@
+(plane_proxy) {
+	request_body {
+		max_size {$FILE_SIZE_LIMIT}
+	}
+
+	reverse_proxy /spaces/* space:3000
+
+	reverse_proxy /god-mode/* admin:3000
+	
+	reverse_proxy /live/* live:3000
+
+	reverse_proxy /api/* api:8000
+
+	reverse_proxy /auth/* api:8000
+
+	reverse_proxy /{$BUCKET_NAME}/* plane-minio:9000
+
+	reverse_proxy /* web:3000
+}
+
+{
+	email {$CERT_EMAIL:admin@example.com}
+	acme_ca {$CERT_ACME_CA} 
+	{$CERT_ACME_DNS}
+	servers {
+		max_header_size 5MB
+		client_ip_headers X-Forwarded-For X-Real-IP
+		trusted_proxies static {$TRUSTED_PROXIES:0.0.0.0/0}
+	}
+}
+
+{$SITE_ADDRESS} {
+	import plane_proxy
+}

caddy/Dockerfile

@@ -0,0 +1,9 @@
+FROM makeplane/caddy:latest
+
+COPY ./Caddyfile.template /etc/caddy/Caddyfile
+
+COPY ./caddy.sh /docker-entrypoint.sh
+
+RUN chmod +x /docker-entrypoint.sh
+
+CMD ["/docker-entrypoint.sh"]

caddy/caddy.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+if [ "$APP_DOMAIN" == "localhost" ]; then
+    export SITE_ADDRESS=":${LISTEN_HTTP_PORT}"
+elif [ "$SSL" == "true" ]; then
+    export SITE_ADDRESS="${APP_DOMAIN}:${LISTEN_HTTPS_PORT}"
+else
+    export SITE_ADDRESS="http://${APP_DOMAIN}:${LISTEN_HTTP_PORT}"
+fi
+
+exec caddy run --config /etc/caddy/Caddyfile

deploy/selfhost/README.md

@@ -58,7 +58,7 @@ Installing plane is a very easy and minimal step process.
 ### Downloading Latest Release
 
 ```
-mkdir plane-selfhost
+mkdir -p plane-selfhost && cd plane-selfhost
 
 cd plane-selfhost
 ```
@@ -144,11 +144,15 @@ Again the `options [1-7]` will be popped up, and this time hit `7` to exit.
 Before proceeding, we suggest used to review `.env` file and set the values.
 Below are the most import keys you must refer to. _<span style="color: #fcba03">You can use any text editor to edit this file</span>_.
 
-> `NGINX_PORT` - This is default set to `80`. Make sure the port you choose to use is not preoccupied. (e.g `NGINX_PORT=8080`)
-
-> `WEB_URL` - This is default set to `http://localhost`. Change this to the FQDN you plan to use along with NGINX_PORT (eg. `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`)
-
-> `CORS_ALLOWED_ORIGINS` - This is default set to `http://localhost`. Change this to the FQDN you plan to use along with NGINX_PORT (eg. `https://plane.example.com:8080` or `http://[IP-ADDRESS]:8080`)
+> `APP_DOMAIN` - Set the Fully Qualified Domain Name here. (eg. `plane.example.com`)
+> 
+> `LISTEN_PORT` - This is default set to `80`. Make sure the port you choose to use is not preoccupied. (e.g `LISTEN_PORT=8080`)
+> 
+> `LISTEN_SSL_PORT` - This is default set to `443`. Make sure the port you choose to use is not preoccupied. (e.g `LISTEN_SSL_PORT=8443`)
+> 
+> `WEB_URL` - This is default set to `http://localhost`. Change this to the FQDN you plan to use along with LISTEN_PORT/LISTEN_SSL_PORT (eg. `https://plane.example.com:8443` or `http://[IP-ADDRESS]:8080`)
+> 
+> `CORS_ALLOWED_ORIGINS` - This is default set to `http://${APP_DOMAIN},https://${APP_DOMAIN}`. Change this to the FQDN you plan to use along with LISTEN_PORT and  LISTEN_SSL_PORT (eg. `http://plane.example.com:8080,https://plane.example.com:8443`)
 
 There are many other settings you can play with, but we suggest you configure `EMAIL SETTINGS` as it will enable you to invite your teammates onto the platform.
 
@@ -172,6 +176,8 @@ Select a Action you want to perform:
 Action [2]: 2
 ```
 
+> You can also choose to run `./setup.sh start` as direct command.
+
 Expect something like this.  
 ![Downloading docker images](images/download.png)
 
@@ -207,6 +213,8 @@ Select a Action you want to perform:
 Action [2]: 3
 ```
 
+> You can also choose to run `./setup.sh stop` as direct command.
+
 If all goes well, you must see something like this
 
 ![Stop Services](images/stopped.png)
@@ -253,6 +261,8 @@ Select a Action you want to perform:
 Action [2]: 4
 ```
 
+> You can also choose to run `./setup.sh restart` as direct command.
+
 If all goes well, you must see something like this
 
 ![Restart Services](images/restart.png)
@@ -297,6 +307,8 @@ Select a Action you want to perform:
 Action [2]: 5
 ```
 
+> You can also choose to run `./setup.sh upgrade` as direct command.
+
 By choosing this, it will stop the services and then will download the latest `docker-compose.yaml` and `plane.env`.
 
 You must expect the below message
@@ -465,6 +477,8 @@ Select a Action you want to perform:
 Action [2]: 7
 ```
 
+> You can also choose to run `./setup.sh backup` as direct command.
+
 In response, you can find the backup folder
 
 ```bash

deploy/selfhost/build.yml

@@ -17,6 +17,12 @@ services:
       context: ./
       dockerfile: ./admin/Dockerfile.admin
 
+  live:
+    image: ${DOCKERHUB_USER:-local}/plane-live:${APP_RELEASE:-latest}
+    build:
+      context: .
+      dockerfile: ./live/Dockerfile.live
+
   api:
     image: ${DOCKERHUB_USER:-local}/plane-backend:${APP_RELEASE:-latest}
     build:
@@ -26,5 +32,5 @@ services:
   proxy:
     image: ${DOCKERHUB_USER:-local}/plane-proxy:${APP_RELEASE:-latest}
     build:
-      context: ./nginx
+      context: ./caddy
       dockerfile: ./Dockerfile

deploy/selfhost/docker-compose.yml

@@ -24,9 +24,14 @@ x-aws-s3-env: &aws-s3-env
   AWS_S3_BUCKET_NAME: ${AWS_S3_BUCKET_NAME:-uploads}
 
 x-proxy-env: &proxy-env
-  NGINX_PORT: ${NGINX_PORT:-80}
-  BUCKET_NAME: ${AWS_S3_BUCKET_NAME:-uploads}
+  SSL: ${SSL:-false}
+  APP_DOMAIN: ${APP_DOMAIN:-localhost}
   FILE_SIZE_LIMIT: ${FILE_SIZE_LIMIT:-5242880}
+  CERT_EMAIL: ${CERT_EMAIL:-admin@example.com}
+  CERT_ACME_CA: ${CERT_ACME_CA:-}
+  LISTEN_HTTP_PORT: ${LISTEN_PORT:-80}
+  LISTEN_HTTPS_PORT: ${LISTEN_SSL_PORT:-443}
+  BUCKET_NAME: ${AWS_S3_BUCKET_NAME:-uploads}
 
 x-mq-env: &mq-env # RabbitMQ Settings
   RABBITMQ_HOST: ${RABBITMQ_HOST:-plane-mq}
@@ -212,22 +217,31 @@ services:
 
   # Comment this if you already have a reverse proxy running
   proxy:
-    image: artifacts.plane.so/makeplane/plane-proxy:${APP_RELEASE:-stable}
-    ports:
-      - target: 80
-        published: ${NGINX_PORT:-80}
-        protocol: tcp
-        mode: host
-    environment:
-      <<: *proxy-env
+    image: artifacts.plane.so/makeplane/plane-proxy:${APP_RELEASE_VERSION}
     deploy:
       replicas: 1
       restart_policy:
         condition: on-failure
+    environment:
+      <<: *proxy-env
+    ports:
+    - target: 80
+      published: ${LISTEN_HTTP_PORT:-80}
+      protocol: tcp
+      mode: host
+    - target: 443
+      published: ${LISTEN_HTTPS_PORT:-443}
+      protocol: tcp
+      mode: host
+    volumes:
+    - proxy_config:/config
+    - proxy_data:/data
     depends_on:
-      - web
-      - api
-      - space
+    - web
+    - api
+    - space
+    - admin
+    - live
 
 volumes:
   pgdata:
@@ -237,4 +251,6 @@ volumes:
   logs_worker:
   logs_beat-worker:
   logs_migrator:
+  caddy_config:
+  caddy_data:
   rabbitmq_data:

deploy/selfhost/install.sh

@@ -1,6 +1,7 @@
 #!/bin/bash
 
 BRANCH=${BRANCH:-master}
+RELEASE_TAG=${RELEASE_TAG:-v0.22-dev}
 SCRIPT_DIR=$PWD
 SERVICE_FOLDER=plane-app
 PLANE_INSTALL_DIR=$PWD/$SERVICE_FOLDER
@@ -177,11 +178,13 @@ function syncEnvFile(){
                 updateEnvFile "$key" "$value" "$DOCKER_ENV_PATH"
             fi
         done < "$DOCKER_ENV_PATH"
+        # Replace APP_RELEASE with the latest value
+        updateEnvFile "APP_RELEASE" "$APP_RELEASE" "$DOCKER_ENV_PATH"
     fi
     echo "Environment variables synced successfully" >&2
 }
 
-function buildYourOwnImage(){
+function buildYourOwnImage() {
     echo "Building images locally..."
 
     export DOCKERHUB_USER="myplane"
@@ -423,7 +426,7 @@ function upgrade() {
     stopServices
 
     echo
-    echo "***** DOWNLOADING STABLE VERSION ****"
+    echo "***** DOWNLOADING $APP_RELEASE VERSION ****"
     install
 
     echo "***** PLEASE VALIDATE AND START SERVICES ****"

deploy/selfhost/variables.env

@@ -1,5 +1,6 @@
 APP_DOMAIN=localhost
 APP_RELEASE=stable
+SSL=false
 
 WEB_REPLICAS=1
 SPACE_REPLICAS=1
@@ -9,10 +10,11 @@ WORKER_REPLICAS=1
 BEAT_WORKER_REPLICAS=1
 LIVE_REPLICAS=1
 
-NGINX_PORT=80
+LISTEN_PORT=80
+LISTEN_SSL_PORT=443
 WEB_URL=http://${APP_DOMAIN}
 DEBUG=0
-CORS_ALLOWED_ORIGINS=http://${APP_DOMAIN}
+CORS_ALLOWED_ORIGINS=http://${APP_DOMAIN},https://${APP_DOMAIN}
 API_BASE_URL=http://api:8000
 
 #DB SETTINGS
@@ -30,6 +32,11 @@ REDIS_HOST=plane-redis
 REDIS_PORT=6379
 REDIS_URL=
 
+# If SSL Cert to be generated, set CERT_EMAIL and APP_PROTOCOL to https
+CERT_EMAIL=
+CERT_ACME_CA=https://acme-v02.api.letsencrypt.org/directory
+TRUSTED_PROXIES=0.0.0.0/0
+
 # RabbitMQ Settings
 RABBITMQ_HOST=plane-mq
 RABBITMQ_PORT=5672