Upgrade to Express v5, Dockerfile, and Health Checks (#29)

Co-authored-by: Aveline <[email protected]>
Co-authored-by: Adam Shiervani <[email protected]>
Co-authored-by: Marc Brooks <[email protected]>

Author: 4 people

.dockerignore

@@ -0,0 +1,6 @@
+.github/
+.idea/
+node_modules/
+dist/
+.DS_Store
+.env

.env.example

@@ -1,23 +1,39 @@
+PORT=3000
 DATABASE_URL="postgresql://jetkvm:jetkvm@localhost:5432/jetkvm?schema=public"
 
-GOOGLE_CLIENT_ID=XXX        # Google OIDC Client ID
-GOOGLE_CLIENT_SECRET=XXX    # Google OIDC Client Secret
+##
+## Google Auth with OIDC Configuration
+##
+GOOGLE_CLIENT_ID=
+GOOGLE_CLIENT_SECRET=
+API_HOSTNAME=
+APP_HOSTNAME=
 
-API_HOSTNAME=XXX            # Is needed for the OIDC Callback
-APP_HOSTNAME=XXX            # Is needed for the OIDC Callback
+##
+## Cloudflare TURN Service
+##
+CLOUDFLARE_TURN_ID=
+CLOUDFLARE_TURN_TOKEN=
 
-CLOUDFLARE_TURN_ID=XXX      # Cloudflare TURN ID
-CLOUDFLARE_TURN_TOKEN=XXX   # Cloudflare TURN Token
+##
+## Session Cookie Secret
+##
+COOKIE_SECRET=
 
-COOKIE_SECRET=XXX           # Session Cookie Secret
+###
+### S3 Compatible Storage
+###
+R2_ENDPOINT=
+R2_ACCESS_KEY_ID=
+R2_SECRET_ACCESS_KEY=
+R2_BUCKET=
+R2_CDN_URL=
 
-R2_ENDPOINT=XXX             # Any S3 compatible endpoint
-R2_ACCESS_KEY_ID=XXX        # Any S3 compatible access key
-R2_SECRET_ACCESS_KEY=XXX    # Any S3 compatible secret access key
-R2_BUCKET=XXX               # Any S3 compatible bucket
-R2_CDN_URL=XXX              # Any S3 compatible CDN URL
+# Allowed CORS Origins, split by comma
+CORS_ORIGINS=https://app.jetkvm.com,http://localhost:5173
 
-CORS_ORIGINS=https://app.jetkvm.com,http://localhost:5173 # Allowed CORS Origins, split by comma
+# Real IP Header for the reverse proxy (e.g. X-Real-IP), leave empty if not needed
+REAL_IP_HEADER=
 
-REAL_IP_HEADER=XXX          # Real IP Header for the reverse proxy (e.g. X-Real-IP), leave empty if not needed
-ICE_SERVERS=XXX             # ICE Servers for WebRTC, split by comma (e.g. stun:stun.l.google.com:19302,stun:stun1.l.google.com:19302)
+# ICE Servers for WebRTC, split by comma (e.g. stun:stun.l.google.com:19302,stun:stun1.l.google.com:19302)
+ICE_SERVERS=

.gitignore

@@ -1,4 +1,5 @@
 node_modules
 .idea
+dist/
 .env
 .env.development

Dockerfile

@@ -0,0 +1,29 @@
+FROM node:21.1.0-alpine AS packages
+WORKDIR /usr/src/app
+
+COPY LICENSE /usr/src/app/
+COPY package.json /usr/src/app/
+COPY package-lock.json /usr/src/app/
+
+RUN npm install
+
+FROM packages AS builder
+WORKDIR /usr/src/app
+
+COPY . /usr/src/app/
+RUN npx prisma generate
+RUN npm run build
+
+FROM packages AS app
+LABEL org.opencontainers.image.source="https://github.com/jetkvm/cloud-api"
+WORKDIR /usr/src/app
+
+COPY --from=builder /usr/src/app/prisma /usr/src/app/prisma
+COPY --from=builder /usr/src/app/node_modules/.prisma /usr/src/app/node_modules/.prisma
+COPY --from=builder /usr/src/app/dist /usr/src/app/dist
+COPY .env.example ./.env
+
+ENV NODE_ENV=production
+ENV PORT=3000
+EXPOSE 3000
+CMD ["node", "./dist/index.js"]

README.md

@@ -26,7 +26,7 @@ If you've found an issue and want to report it, please check our [Issues](https:
 
 ## Development
 
-This project is built with Node.JS, Prisma and Express.
+This project is built on Node.JS using Prisma and Express.
 
 To start the development server, run:
 

compose.yaml

@@ -0,0 +1,44 @@
+name: jetkvm-cloud-api
+
+networks:
+  jetkvm:
+    driver: bridge
+
+services:
+  db:
+    image: postgres
+    restart: always
+    environment:
+      POSTGRES_PASSWORD: jetkvm
+      POSTGRES_USER: jetkvm
+      POSTGRES_DB: jetkvm
+    #ports:
+    # - "5432:5432"
+    networks:
+      - jetkvm
+    volumes:
+      - postgresql:/var/lib/postgresql/data
+
+  app: &app
+    build: .
+    environment:
+      PORT: 5172
+      DATABASE_URL: postgres://jetkvm:jetkvm@db:5432/jetkvm
+    depends_on:
+      - db
+    ports:
+        - "5172:5172"
+    networks:
+      - jetkvm
+
+  # Trigger prisma migration
+  # This can be done in the app container as well, but is generally discouraged.
+  app-migrate:
+    <<: *app
+    command: npm run prisma-migrate
+    ports: []
+    restart: no
+
+volumes:
+  postgresql:
+    driver: local