docs(self-hosted): rework Railway + Coolify self-hosting guides with walkthroughs and explicit env vars (#700)

2026-07-09 10:01:24 +01:00
parent 22a3e6484b
commit bd2585f8fd
24 changed files with 555 additions and 68 deletions
@@ -0,0 +1,146 @@
+# documentation: https://classroomio.com/docs/self-hosted/coolify
+# slogan: Open-source LMS to build and teach courses with lessons, quizzes, certificates, student management, and an AI tutor.
+# category: lms
+# tags: lms, education, courses, teaching, e-learning
+# logo: svgs/classroomio.svg
+# port: 3082
+
+services:
+  postgres:
+    image: postgres:16-alpine
+    environment:
+      - POSTGRES_DB=${POSTGRES_DB:-classroomio}
+      - POSTGRES_USER=$SERVICE_USER_POSTGRES
+      - POSTGRES_PASSWORD=$SERVICE_PASSWORD_POSTGRES
+    volumes:
+      - postgres-data:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U $SERVICE_USER_POSTGRES -d ${POSTGRES_DB:-classroomio}"]
+      interval: 5s
+      timeout: 5s
+      retries: 15
+
+  redis:
+    image: redis:7-alpine
+    command: ["redis-server", "--appendonly", "yes"]
+    volumes:
+      - redis-data:/data
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 5s
+      timeout: 3s
+      retries: 10
+
+  minio:
+    image: minio/minio:latest
+    command: server /data --console-address ":9001"
+    environment:
+      - SERVICE_FQDN_MINIO_9000
+      - MINIO_ROOT_USER=$SERVICE_USER_MINIO
+      - MINIO_ROOT_PASSWORD=$SERVICE_PASSWORD_MINIO
+      - MINIO_SERVER_URL=$SERVICE_URL_MINIO
+    volumes:
+      - minio-data:/data
+    healthcheck:
+      test: ["CMD", "mc", "ready", "local"]
+      interval: 5s
+      timeout: 20s
+      retries: 10
+
+  minio-init:
+    image: minio/mc:latest
+    depends_on:
+      minio:
+        condition: service_healthy
+    exclude_from_hc: true
+    entrypoint: >
+      /bin/sh -c "
+      set -e;
+      mc alias set local http://minio:9000 $SERVICE_USER_MINIO $SERVICE_PASSWORD_MINIO;
+      mc mb local/videos --ignore-existing;
+      mc mb local/documents --ignore-existing;
+      mc mb local/media --ignore-existing;
+      mc anonymous set download local/media;
+      "
+
+  api:
+    image: classroomio/api:${CIO_VERSION:-latest}
+    depends_on:
+      postgres:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+    environment:
+      - NODE_ENV=production
+      - PORT=3081
+      - DATABASE_URL=postgresql://$SERVICE_USER_POSTGRES:$SERVICE_PASSWORD_POSTGRES@postgres:5432/${POSTGRES_DB:-classroomio}
+      - REDIS_URL=redis://redis:6379
+      - PUBLIC_IS_SELFHOSTED=true
+      - BETTER_AUTH_SECRET=$SERVICE_HEX_64_BETTERAUTH
+      - PRIVATE_SERVER_KEY=$SERVICE_HEX_64_PRIVATESERVER
+      - DASHBOARD_ORIGIN=$SERVICE_URL_DASHBOARD
+      - PUBLIC_SERVER_URL=$SERVICE_URL_DASHBOARD
+      - OBJECT_STORAGE_ENDPOINT=http://minio:9000
+      - OBJECT_STORAGE_PUBLIC_ENDPOINT=$SERVICE_URL_MINIO
+      - OBJECT_STORAGE_ACCESS_KEY_ID=$SERVICE_USER_MINIO
+      - OBJECT_STORAGE_SECRET_ACCESS_KEY=$SERVICE_PASSWORD_MINIO
+      - OBJECT_STORAGE_FORCE_PATH_STYLE=true
+      - OBJECT_STORAGE_MEDIA_PUBLIC_BASE_URL=$SERVICE_URL_MINIO/media
+      - SMTP_HOST=${SMTP_HOST}
+      - SMTP_PORT=${SMTP_PORT}
+      - SMTP_USER=${SMTP_USER}
+      - SMTP_PASSWORD=${SMTP_PASSWORD}
+      - SMTP_SENDER=${SMTP_SENDER}
+    healthcheck:
+      test: ["CMD", "node", "-e", "fetch('http://localhost:3081/').then(r=>process.exit(r.ok?0:1)).catch(()=>process.exit(1))"]
+      interval: 10s
+      timeout: 5s
+      retries: 12
+      start_period: 30s
+
+  dashboard:
+    image: classroomio/dashboard:${CIO_VERSION:-latest}
+    depends_on:
+      api:
+        condition: service_healthy
+    environment:
+      - SERVICE_FQDN_DASHBOARD_3082
+      - NODE_ENV=production
+      - PORT=3082
+      - ORIGIN=$SERVICE_URL_DASHBOARD
+      - PUBLIC_IS_SELFHOSTED=true
+      - PRIVATE_SERVER_URL=http://api:3081
+      - PRIVATE_SERVER_KEY=$SERVICE_HEX_64_PRIVATESERVER
+      - CSP_MEDIA_SRC_DOMAINS=$SERVICE_URL_MINIO
+
+  jobs:
+    image: classroomio/jobs:${CIO_VERSION:-latest}
+    depends_on:
+      postgres:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+    environment:
+      - NODE_ENV=production
+      - REDIS_URL=redis://redis:6379
+      - DATABASE_URL=postgresql://$SERVICE_USER_POSTGRES:$SERVICE_PASSWORD_POSTGRES@postgres:5432/${POSTGRES_DB:-classroomio}
+      - OBJECT_STORAGE_ENDPOINT=http://minio:9000
+      - OBJECT_STORAGE_PUBLIC_ENDPOINT=$SERVICE_URL_MINIO
+      - OBJECT_STORAGE_ACCESS_KEY_ID=$SERVICE_USER_MINIO
+      - OBJECT_STORAGE_SECRET_ACCESS_KEY=$SERVICE_PASSWORD_MINIO
+      - OBJECT_STORAGE_FORCE_PATH_STYLE=true
+      - OBJECT_STORAGE_MEDIA_PUBLIC_BASE_URL=$SERVICE_URL_MINIO/media
+      - OBJECT_STORAGE_BUCKET_VIDEOS=videos
+      - OBJECT_STORAGE_BUCKET_DOCUMENTS=documents
+      - OBJECT_STORAGE_BUCKET_MEDIA=media
+      - SMTP_HOST=${SMTP_HOST}
+      - SMTP_PORT=${SMTP_PORT}
+      - SMTP_USER=${SMTP_USER}
+      - SMTP_PASSWORD=${SMTP_PASSWORD}
+      - SMTP_SENDER=${SMTP_SENDER}
+      - OPENAI_API_KEY=${OPENAI_API_KEY}
+
+volumes:
+  postgres-data:
+  redis-data:
+  minio-data: