diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7ea66ab452..2a4e8ab5bd 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,7 +5,7 @@ concurrency: cancel-in-progress: ${{ github.event_name == 'pull_request' }} env: - COMPOSE_FILE: docker-compose.yml + COMPOSE_FILE: docker-compose.yml:docker-compose.override.yml IMAGE: appwrite-dev K6_VERSION: '0.53.0' @@ -107,6 +107,11 @@ jobs: tools: composer:v2 coverage: none + - name: Setup Node + uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 + with: + node-version: '24' + - name: Validate composer.json run: composer validate @@ -114,6 +119,10 @@ jobs: id: install run: composer install --prefer-dist --no-progress --ignore-platform-reqs + - name: Install Node dependencies + if: ${{ !cancelled() && steps.install.outcome == 'success' }} + run: npm ci + - name: Cache PHPStan result cache if: ${{ !cancelled() && steps.install.outcome == 'success' }} uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5 @@ -133,6 +142,10 @@ jobs: if: ${{ !cancelled() && steps.install.outcome == 'success' }} run: composer lint + - name: Check Docker Compose formatting + if: ${{ !cancelled() && steps.install.outcome == 'success' }} + run: npm run lint:compose + - name: Run Rector if: ${{ !cancelled() && steps.install.outcome == 'success' }} run: composer refactor:check diff --git a/.github/workflows/sdk-preview.yml b/.github/workflows/sdk-preview.yml index dacc37a64a..535b3712f6 100644 --- a/.github/workflows/sdk-preview.yml +++ b/.github/workflows/sdk-preview.yml @@ -1,7 +1,7 @@ name: "SDK Preview" env: - COMPOSE_FILE: docker-compose.yml + COMPOSE_FILE: docker-compose.yml:docker-compose.override.yml on: workflow_dispatch: diff --git a/.github/workflows/specs.yml b/.github/workflows/specs.yml index 85c76bacd3..50a70bd4bb 100644 --- a/.github/workflows/specs.yml +++ b/.github/workflows/specs.yml @@ -1,7 +1,7 @@ name: "Generate Specs" env: - COMPOSE_FILE: docker-compose.yml + COMPOSE_FILE: docker-compose.yml:docker-compose.override.yml on: workflow_dispatch: diff --git a/app/views/install/compose.phtml b/app/views/install/compose.phtml deleted file mode 100644 index f55f9568ab..0000000000 --- a/app/views/install/compose.phtml +++ /dev/null @@ -1,1258 +0,0 @@ -x-logging: &x-logging - logging: - driver: 'json-file' - options: - max-file: '5' - max-size: '10m' -getParam('httpPort', ''); -$httpsPort = $this->getParam('httpsPort', ''); -$version = $this->getParam('version', ''); -$organization = $this->getParam('organization', ''); -$image = $this->getParam('image', ''); -$enableAssistant = $this->getParam('enableAssistant', false); -$executorImages = $this->getParam('executorImages', ''); -$dbService = $this->getParam('database', 'mongodb'); -$allowedDbServices = ['mariadb', 'mongodb', 'postgresql']; -if (!\in_array($dbService, $allowedDbServices, true)) { - $dbService = 'mongodb'; -} -$hostPath = rtrim($this->getParam('hostPath', ''), '/'); -?>services: - traefik: - image: traefik:3.6 - container_name: appwrite-traefik - <<: *x-logging - command: - - --providers.file.directory=/storage/config - - --providers.file.watch=true - - --providers.docker=true - - --providers.docker.exposedByDefault=false - - --providers.docker.constraints=Label(`traefik.constraint-label-stack`,`appwrite`) - - --entrypoints.appwrite_web.address=:80 - - --entrypoints.appwrite_websecure.address=:443 - restart: unless-stopped - ports: - - :80 - - :443 - volumes: - - /var/run/docker.sock:/var/run/docker.sock - - appwrite-config:/storage/config:ro - - appwrite-certificates:/storage/certificates:ro - depends_on: - - appwrite - networks: - - gateway - - appwrite - - appwrite: - image: /: - container_name: appwrite - <<: *x-logging - restart: unless-stopped - networks: - - appwrite - labels: - - traefik.enable=true - - traefik.constraint-label-stack=appwrite - - traefik.docker.network=appwrite - - traefik.http.services.appwrite_api.loadbalancer.server.port=80 - #http - - traefik.http.routers.appwrite_api_http.entrypoints=appwrite_web - - traefik.http.routers.appwrite_api_http.rule=PathPrefix(`/`) - - traefik.http.routers.appwrite_api_http.service=appwrite_api - # https - - traefik.http.routers.appwrite_api_https.entrypoints=appwrite_websecure - - traefik.http.routers.appwrite_api_https.rule=PathPrefix(`/`) - - traefik.http.routers.appwrite_api_https.service=appwrite_api - - traefik.http.routers.appwrite_api_https.tls=true - volumes: - - - ":/usr/src/code:rw" - - - appwrite-uploads:/storage/uploads:rw - - appwrite-imports:/storage/imports:rw - - appwrite-cache:/storage/cache:rw - - appwrite-config:/storage/config:rw - - appwrite-certificates:/storage/certificates:rw - - appwrite-functions:/storage/functions:rw - - appwrite-sites:/storage/sites:rw - - appwrite-builds:/storage/builds:rw - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy -# - clamav - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_LOCALE - - _APP_COMPRESSION_MIN_SIZE_BYTES - - _APP_CONSOLE_WHITELIST_ROOT - - _APP_CONSOLE_WHITELIST_EMAILS - - _APP_CONSOLE_SESSION_ALERTS - - _APP_CONSOLE_WHITELIST_IPS - - _APP_CONSOLE_HOSTNAMES - - _APP_SYSTEM_EMAIL_NAME - - _APP_SYSTEM_EMAIL_ADDRESS - - _APP_EMAIL_SECURITY - - _APP_SYSTEM_RESPONSE_FORMAT - - _APP_OPTIONS_ABUSE - - _APP_OPTIONS_ROUTER_PROTECTION - - _APP_OPTIONS_FORCE_HTTPS - - _APP_OPTIONS_ROUTER_FORCE_HTTPS - - _APP_OPENSSL_KEY_V1 - - _APP_NOTIFICATIONS_TRACKING_SECRET - - _APP_DOMAIN - - _APP_DOMAIN_TARGET_CNAME - - _APP_DOMAIN_TARGET_AAAA - - _APP_DOMAIN_TARGET_A - - _APP_DOMAIN_TARGET_CAA - - _APP_DNS - - _APP_DOMAIN_FUNCTIONS - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_SMTP_HOST - - _APP_SMTP_PORT - - _APP_SMTP_SECURE - - _APP_SMTP_USERNAME - - _APP_SMTP_PASSWORD - - _APP_USAGE_STATS - - _APP_STORAGE_LIMIT - - _APP_STORAGE_PREVIEW_LIMIT - - _APP_STORAGE_ANTIVIRUS - - _APP_STORAGE_ANTIVIRUS_HOST - - _APP_STORAGE_ANTIVIRUS_PORT - - _APP_STORAGE_DEVICE - - _APP_STORAGE_S3_ACCESS_KEY - - _APP_STORAGE_S3_SECRET - - _APP_STORAGE_S3_REGION - - _APP_STORAGE_S3_BUCKET - - _APP_STORAGE_S3_ENDPOINT - - _APP_STORAGE_DO_SPACES_ACCESS_KEY - - _APP_STORAGE_DO_SPACES_SECRET - - _APP_STORAGE_DO_SPACES_REGION - - _APP_STORAGE_DO_SPACES_BUCKET - - _APP_STORAGE_BACKBLAZE_ACCESS_KEY - - _APP_STORAGE_BACKBLAZE_SECRET - - _APP_STORAGE_BACKBLAZE_REGION - - _APP_STORAGE_BACKBLAZE_BUCKET - - _APP_STORAGE_LINODE_ACCESS_KEY - - _APP_STORAGE_LINODE_SECRET - - _APP_STORAGE_LINODE_REGION - - _APP_STORAGE_LINODE_BUCKET - - _APP_STORAGE_WASABI_ACCESS_KEY - - _APP_STORAGE_WASABI_SECRET - - _APP_STORAGE_WASABI_REGION - - _APP_STORAGE_WASABI_BUCKET - - _APP_COMPUTE_SIZE_LIMIT - - _APP_FUNCTIONS_TIMEOUT - - _APP_SITES_TIMEOUT - - _APP_COMPUTE_BUILD_TIMEOUT - - _APP_COMPUTE_CPUS - - _APP_COMPUTE_MEMORY - - _APP_FUNCTIONS_RUNTIMES - - _APP_SITES_RUNTIMES - - _APP_DOMAIN_SITES - - _APP_EXECUTOR_SECRET - - _APP_EXECUTOR_HOST - - _APP_LOGGING_CONFIG - - _APP_MAINTENANCE_INTERVAL - - _APP_MAINTENANCE_DELAY - - _APP_MAINTENANCE_START_TIME - - _APP_MAINTENANCE_RETENTION_EXECUTION - - _APP_MAINTENANCE_RETENTION_CACHE - - _APP_MAINTENANCE_RETENTION_ABUSE - - _APP_MAINTENANCE_RETENTION_AUDIT - - _APP_MAINTENANCE_RETENTION_AUDIT_CONSOLE - - _APP_MAINTENANCE_RETENTION_USAGE_HOURLY - - _APP_MAINTENANCE_RETENTION_SCHEDULES - - _APP_SMS_PROVIDER - - _APP_SMS_FROM - - _APP_GRAPHQL_INTROSPECTION - - _APP_GRAPHQL_MAX_BATCH_SIZE - - _APP_GRAPHQL_MAX_COMPLEXITY - - _APP_GRAPHQL_MAX_DEPTH - - _APP_VCS_GITHUB_APP_NAME - - _APP_VCS_GITHUB_PRIVATE_KEY - - _APP_VCS_GITHUB_APP_ID - - _APP_VCS_GITHUB_WEBHOOK_SECRET - - _APP_VCS_GITHUB_CLIENT_SECRET - - _APP_VCS_GITHUB_CLIENT_ID - - _APP_MIGRATIONS_FIREBASE_CLIENT_ID - - _APP_MIGRATIONS_FIREBASE_CLIENT_SECRET - - _APP_ASSISTANT_OPENAI_API_KEY - appwrite-console: - <<: *x-logging - container_name: appwrite-console - image: /console:8.7.5 - restart: unless-stopped - networks: - - appwrite - labels: - - "traefik.enable=true" - - "traefik.constraint-label-stack=appwrite" - - "traefik.docker.network=appwrite" - - "traefik.http.services.appwrite_console.loadbalancer.server.port=80" - #ws - - traefik.http.routers.appwrite_console_http.entrypoints=appwrite_web - - traefik.http.routers.appwrite_console_http.rule=PathPrefix(`/console`) - - traefik.http.routers.appwrite_console_http.service=appwrite_console - # wss - - traefik.http.routers.appwrite_console_https.entrypoints=appwrite_websecure - - traefik.http.routers.appwrite_console_https.rule=PathPrefix(`/console`) - - traefik.http.routers.appwrite_console_https.service=appwrite_console - - traefik.http.routers.appwrite_console_https.tls=true - - appwrite-realtime: - image: /: - entrypoint: realtime - container_name: appwrite-realtime - <<: *x-logging - restart: unless-stopped - labels: - - "traefik.enable=true" - - "traefik.constraint-label-stack=appwrite" - - "traefik.docker.network=appwrite" - - "traefik.http.services.appwrite_realtime.loadbalancer.server.port=80" - #ws - - traefik.http.routers.appwrite_realtime_ws.entrypoints=appwrite_web - - traefik.http.routers.appwrite_realtime_ws.rule=PathPrefix(`/v1/realtime`) - - traefik.http.routers.appwrite_realtime_ws.service=appwrite_realtime - # wss - - traefik.http.routers.appwrite_realtime_wss.entrypoints=appwrite_websecure - - traefik.http.routers.appwrite_realtime_wss.rule=PathPrefix(`/v1/realtime`) - - traefik.http.routers.appwrite_realtime_wss.service=appwrite_realtime - - traefik.http.routers.appwrite_realtime_wss.tls=true - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPTIONS_ABUSE - - _APP_OPTIONS_ROUTER_PROTECTION - - _APP_OPENSSL_KEY_V1 - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_USAGE_STATS - - _APP_LOGGING_CONFIG - - appwrite-worker-audits: - image: /: - entrypoint: worker-audits - <<: *x-logging - container_name: appwrite-worker-audits - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_LOGGING_CONFIG - - appwrite-worker-webhooks: - image: /: - entrypoint: worker-webhooks - <<: *x-logging - container_name: appwrite-worker-webhooks - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_EMAIL_SECURITY - - _APP_SYSTEM_SECURITY_EMAIL_ADDRESS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_LOGGING_CONFIG - - appwrite-worker-deletes: - image: /: - entrypoint: worker-deletes - <<: *x-logging - container_name: appwrite-worker-deletes - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - volumes: - - appwrite-uploads:/storage/uploads:rw - - appwrite-cache:/storage/cache:rw - - appwrite-functions:/storage/functions:rw - - appwrite-sites:/storage/sites:rw - - appwrite-builds:/storage/builds:rw - - appwrite-certificates:/storage/certificates:rw - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_STORAGE_DEVICE - - _APP_STORAGE_S3_ACCESS_KEY - - _APP_STORAGE_S3_SECRET - - _APP_STORAGE_S3_REGION - - _APP_STORAGE_S3_BUCKET - - _APP_STORAGE_S3_ENDPOINT - - _APP_STORAGE_DO_SPACES_ACCESS_KEY - - _APP_STORAGE_DO_SPACES_SECRET - - _APP_STORAGE_DO_SPACES_REGION - - _APP_STORAGE_DO_SPACES_BUCKET - - _APP_STORAGE_BACKBLAZE_ACCESS_KEY - - _APP_STORAGE_BACKBLAZE_SECRET - - _APP_STORAGE_BACKBLAZE_REGION - - _APP_STORAGE_BACKBLAZE_BUCKET - - _APP_STORAGE_LINODE_ACCESS_KEY - - _APP_STORAGE_LINODE_SECRET - - _APP_STORAGE_LINODE_REGION - - _APP_STORAGE_LINODE_BUCKET - - _APP_STORAGE_WASABI_ACCESS_KEY - - _APP_STORAGE_WASABI_SECRET - - _APP_STORAGE_WASABI_REGION - - _APP_STORAGE_WASABI_BUCKET - - _APP_LOGGING_CONFIG - - _APP_EXECUTOR_SECRET - - _APP_EXECUTOR_HOST - - _APP_MAINTENANCE_RETENTION_ABUSE - - _APP_MAINTENANCE_RETENTION_AUDIT - - _APP_MAINTENANCE_RETENTION_AUDIT_CONSOLE - - _APP_MAINTENANCE_RETENTION_EXECUTION - - _APP_SYSTEM_SECURITY_EMAIL_ADDRESS - - _APP_EMAIL_CERTIFICATES - - appwrite-worker-databases: - image: /: - entrypoint: worker-databases - <<: *x-logging - container_name: appwrite-worker-databases - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_LOGGING_CONFIG - - appwrite-worker-builds: - image: /: - entrypoint: worker-builds - <<: *x-logging - container_name: appwrite-worker-builds - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - volumes: - - appwrite-functions:/storage/functions:rw - - appwrite-sites:/storage/sites:rw - - appwrite-builds:/storage/builds:rw - - appwrite-uploads:/storage/uploads:rw - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_EXECUTOR_SECRET - - _APP_EXECUTOR_HOST - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_LOGGING_CONFIG - - _APP_VCS_GITHUB_APP_NAME - - _APP_VCS_GITHUB_PRIVATE_KEY - - _APP_VCS_GITHUB_APP_ID - - _APP_FUNCTIONS_TIMEOUT - - _APP_SITES_TIMEOUT - - _APP_COMPUTE_BUILD_TIMEOUT - - _APP_COMPUTE_CPUS - - _APP_COMPUTE_MEMORY - - _APP_OPEN_RUNTIMES_NFT - - _APP_COMPUTE_SIZE_LIMIT - - _APP_OPTIONS_FORCE_HTTPS - - _APP_OPTIONS_ROUTER_FORCE_HTTPS - - _APP_DOMAIN - - _APP_STORAGE_DEVICE - - _APP_STORAGE_S3_ACCESS_KEY - - _APP_STORAGE_S3_SECRET - - _APP_STORAGE_S3_REGION - - _APP_STORAGE_S3_BUCKET - - _APP_STORAGE_S3_ENDPOINT - - _APP_STORAGE_DO_SPACES_ACCESS_KEY - - _APP_STORAGE_DO_SPACES_SECRET - - _APP_STORAGE_DO_SPACES_REGION - - _APP_STORAGE_DO_SPACES_BUCKET - - _APP_STORAGE_BACKBLAZE_ACCESS_KEY - - _APP_STORAGE_BACKBLAZE_SECRET - - _APP_STORAGE_BACKBLAZE_REGION - - _APP_STORAGE_BACKBLAZE_BUCKET - - _APP_STORAGE_LINODE_ACCESS_KEY - - _APP_STORAGE_LINODE_SECRET - - _APP_STORAGE_LINODE_REGION - - _APP_STORAGE_LINODE_BUCKET - - _APP_STORAGE_WASABI_ACCESS_KEY - - _APP_STORAGE_WASABI_SECRET - - _APP_STORAGE_WASABI_REGION - - _APP_STORAGE_WASABI_BUCKET - - _APP_DOMAIN_SITES - - appwrite-worker-certificates: - image: /: - entrypoint: worker-certificates - <<: *x-logging - container_name: appwrite-worker-certificates - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - volumes: - - appwrite-config:/storage/config:rw - - appwrite-certificates:/storage/certificates:rw - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_DOMAIN - - _APP_DOMAIN_TARGET_CNAME - - _APP_DOMAIN_TARGET_AAAA - - _APP_DOMAIN_TARGET_A - - _APP_DOMAIN_TARGET_CAA - - _APP_DNS - - _APP_DOMAIN_FUNCTIONS - - _APP_EMAIL_CERTIFICATES - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_LOGGING_CONFIG - - appwrite-worker-executions: - image: /: - entrypoint: worker-executions - <<: *x-logging - container_name: appwrite-worker-executions - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_ENV - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_LOGGING_CONFIG - - appwrite-worker-functions: - image: /: - entrypoint: worker-functions - <<: *x-logging - container_name: appwrite-worker-functions - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - openruntimes-executor: - condition: service_started - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_DOMAIN - - _APP_OPTIONS_FORCE_HTTPS - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_FUNCTIONS_TIMEOUT - - _APP_SITES_TIMEOUT - - _APP_COMPUTE_BUILD_TIMEOUT - - _APP_COMPUTE_CPUS - - _APP_COMPUTE_MEMORY - - _APP_EXECUTOR_SECRET - - _APP_EXECUTOR_HOST - - _APP_USAGE_STATS - - _APP_DOCKER_HUB_USERNAME - - _APP_DOCKER_HUB_PASSWORD - - _APP_LOGGING_CONFIG - - appwrite-worker-mails: - image: /: - entrypoint: worker-mails - <<: *x-logging - container_name: appwrite-worker-mails - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_NOTIFICATIONS_TRACKING_SECRET - - _APP_SYSTEM_EMAIL_NAME - - _APP_SYSTEM_EMAIL_ADDRESS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_SMTP_HOST - - _APP_SMTP_PORT - - _APP_SMTP_SECURE - - _APP_SMTP_USERNAME - - _APP_SMTP_PASSWORD - - _APP_LOGGING_CONFIG - - _APP_DOMAIN - - _APP_OPTIONS_FORCE_HTTPS - - appwrite-worker-notifications: - image: /: - entrypoint: worker-notifications - <<: *x-logging - container_name: appwrite-worker-notifications - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_NOTIFICATIONS_TRACKING_SECRET - - _APP_SYSTEM_EMAIL_NAME - - _APP_SYSTEM_EMAIL_ADDRESS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_SMTP_HOST - - _APP_SMTP_PORT - - _APP_SMTP_SECURE - - _APP_SMTP_USERNAME - - _APP_SMTP_PASSWORD - - _APP_LOGGING_CONFIG - - _APP_DOMAIN - - _APP_OPTIONS_FORCE_HTTPS - - appwrite-worker-messaging: - image: /: - entrypoint: worker-messaging - <<: *x-logging - container_name: appwrite-worker-messaging - restart: unless-stopped - networks: - - appwrite - volumes: - - appwrite-uploads:/storage/uploads:rw - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_LOGGING_CONFIG - - _APP_SMS_FROM - - _APP_SMS_PROVIDER - - _APP_STORAGE_DEVICE - - _APP_STORAGE_S3_ACCESS_KEY - - _APP_STORAGE_S3_SECRET - - _APP_STORAGE_S3_REGION - - _APP_STORAGE_S3_BUCKET - - _APP_STORAGE_S3_ENDPOINT - - _APP_STORAGE_DO_SPACES_ACCESS_KEY - - _APP_STORAGE_DO_SPACES_SECRET - - _APP_STORAGE_DO_SPACES_REGION - - _APP_STORAGE_DO_SPACES_BUCKET - - _APP_STORAGE_BACKBLAZE_ACCESS_KEY - - _APP_STORAGE_BACKBLAZE_SECRET - - _APP_STORAGE_BACKBLAZE_REGION - - _APP_STORAGE_BACKBLAZE_BUCKET - - _APP_STORAGE_LINODE_ACCESS_KEY - - _APP_STORAGE_LINODE_SECRET - - _APP_STORAGE_LINODE_REGION - - _APP_STORAGE_LINODE_BUCKET - - _APP_STORAGE_WASABI_ACCESS_KEY - - _APP_STORAGE_WASABI_SECRET - - _APP_STORAGE_WASABI_REGION - - _APP_STORAGE_WASABI_BUCKET - - appwrite-worker-migrations: - image: /: - entrypoint: worker-migrations - <<: *x-logging - container_name: appwrite-worker-migrations - restart: unless-stopped - networks: - - appwrite - volumes: - - appwrite-imports:/storage/imports:rw - depends_on: - : - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_DOMAIN - - _APP_DOMAIN_TARGET_CNAME - - _APP_DOMAIN_TARGET_AAAA - - _APP_DOMAIN_TARGET_A - - _APP_DOMAIN_TARGET_CAA - - _APP_DNS - - _APP_EMAIL_SECURITY - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_LOGGING_CONFIG - - _APP_MIGRATIONS_FIREBASE_CLIENT_ID - - _APP_MIGRATIONS_FIREBASE_CLIENT_SECRET - - appwrite-task-maintenance: - image: /: - entrypoint: maintenance - <<: *x-logging - container_name: appwrite-task-maintenance - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_DOMAIN - - _APP_DOMAIN_TARGET_CNAME - - _APP_DOMAIN_TARGET_AAAA - - _APP_DOMAIN_TARGET_A - - _APP_DOMAIN_TARGET_CAA - - _APP_DNS - - _APP_DOMAIN_FUNCTIONS - - _APP_OPENSSL_KEY_V1 - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_MAINTENANCE_INTERVAL - - _APP_MAINTENANCE_RETENTION_EXECUTION - - _APP_MAINTENANCE_RETENTION_CACHE - - _APP_MAINTENANCE_RETENTION_ABUSE - - _APP_MAINTENANCE_RETENTION_AUDIT - - _APP_MAINTENANCE_RETENTION_AUDIT_CONSOLE - - _APP_MAINTENANCE_RETENTION_USAGE_HOURLY - - _APP_MAINTENANCE_RETENTION_SCHEDULES - - appwrite-task-stats-resources: - image: /: - container_name: appwrite-task-stats-resources - entrypoint: stats-resources - <<: *x-logging - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_USAGE_STATS - - _APP_LOGGING_CONFIG - - _APP_DATABASE_SHARED_TABLES - - _APP_STATS_RESOURCES_INTERVAL - - appwrite-worker-stats-resources: - image: /: - entrypoint: worker-stats-resources - container_name: appwrite-worker-stats-resources - <<: *x-logging - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_USAGE_STATS - - _APP_LOGGING_CONFIG - - _APP_STATS_RESOURCES_INTERVAL - - appwrite-worker-stats-usage: - image: /: - entrypoint: worker-stats-usage - container_name: appwrite-worker-stats-usage - <<: *x-logging - restart: unless-stopped - networks: - - appwrite - depends_on: - redis: - condition: service_healthy - : - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_USAGE_STATS - - _APP_LOGGING_CONFIG - - _APP_USAGE_AGGREGATION_INTERVAL - - appwrite-task-scheduler-functions: - image: /: - entrypoint: schedule-functions - container_name: appwrite-task-scheduler-functions - <<: *x-logging - restart: unless-stopped - networks: - - appwrite - depends_on: - : - condition: service_healthy - redis: - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_OPTIONS_FORCE_HTTPS - - _APP_DOMAIN - - _APP_CONSOLE_DOMAIN - - _APP_DOMAIN_FUNCTIONS - - _APP_DOMAIN_SITES - - _APP_MIGRATION_HOST - - _APP_CONSOLE_SCHEMA - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - appwrite-task-scheduler-executions: - image: /: - entrypoint: schedule-executions - container_name: appwrite-task-scheduler-executions - <<: *x-logging - restart: unless-stopped - networks: - - appwrite - depends_on: - : - condition: service_healthy - redis: - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_OPTIONS_FORCE_HTTPS - - _APP_DOMAIN - - _APP_CONSOLE_DOMAIN - - _APP_DOMAIN_FUNCTIONS - - _APP_DOMAIN_SITES - - _APP_MIGRATION_HOST - - _APP_CONSOLE_SCHEMA - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - appwrite-task-scheduler-messages: - image: /: - entrypoint: schedule-messages - container_name: appwrite-task-scheduler-messages - <<: *x-logging - restart: unless-stopped - networks: - - appwrite - depends_on: - : - condition: service_healthy - redis: - condition: service_healthy - environment: - - _APP_ENV - - _APP_WORKER_PER_CORE - - _APP_OPENSSL_KEY_V1 - - _APP_REDIS_HOST - - _APP_REDIS_PORT - - _APP_REDIS_USER - - _APP_REDIS_PASS - - _APP_DB_ADAPTER - - _APP_DB_HOST - - _APP_DB_PORT - - _APP_DB_SCHEMA - - _APP_DB_USER - - _APP_DB_PASS - - - appwrite-assistant: - image: appwrite/assistant:0.8.4 - container_name: appwrite-assistant - <<: *x-logging - restart: unless-stopped - networks: - - appwrite - environment: - - _APP_ASSISTANT_OPENAI_API_KEY - - - appwrite-browser: - image: appwrite/browser:0.3.2 - container_name: appwrite-browser - <<: *x-logging - restart: unless-stopped - networks: - - appwrite - - openruntimes-executor: - container_name: exc1 - hostname: exc1 - <<: *x-logging - restart: unless-stopped - stop_signal: SIGINT - image: openruntimes/executor:0.25.1 - networks: - - appwrite - volumes: - - /var/run/docker.sock:/var/run/docker.sock - - appwrite-builds:/storage/builds:rw - - appwrite-functions:/storage/functions:rw - - appwrite-sites:/storage/sites:rw - # Host mount nessessary to share files between executor and runtimes. - # It's not possible to share mount file between 2 containers without host mount (copying is too slow) - - /tmp:/tmp:rw - environment: - - OPR_EXECUTOR_CONNECTION_STORAGE=local://localhost - - OPR_EXECUTOR_CONNECTION_BUILD_CACHE_STORAGE= - - OPR_EXECUTOR_IMAGES= - - OPR_EXECUTOR_INACTIVE_THRESHOLD=$_APP_COMPUTE_INACTIVE_THRESHOLD - - OPR_EXECUTOR_MAINTENANCE_INTERVAL=$_APP_COMPUTE_MAINTENANCE_INTERVAL - - OPR_EXECUTOR_NETWORK=$_APP_COMPUTE_RUNTIMES_NETWORK - - OPR_EXECUTOR_DOCKER_HUB_USERNAME=$_APP_DOCKER_HUB_USERNAME - - OPR_EXECUTOR_DOCKER_HUB_PASSWORD=$_APP_DOCKER_HUB_PASSWORD - - OPR_EXECUTOR_ENV=$_APP_ENV - - OPR_EXECUTOR_RUNTIMES=$_APP_FUNCTIONS_RUNTIMES,$_APP_SITES_RUNTIMES - - OPR_EXECUTOR_SECRET=$_APP_EXECUTOR_SECRET - - OPR_EXECUTOR_RUNTIME_VERSIONS=v5 - - OPEN_RUNTIMES_NFT=$_APP_OPEN_RUNTIMES_NFT - - OPR_EXECUTOR_LOGGING_CONFIG=$_APP_LOGGING_CONFIG - - OPR_EXECUTOR_STORAGE_DEVICE=$_APP_STORAGE_DEVICE - - OPR_EXECUTOR_STORAGE_S3_ACCESS_KEY=$_APP_STORAGE_S3_ACCESS_KEY - - OPR_EXECUTOR_STORAGE_S3_SECRET=$_APP_STORAGE_S3_SECRET - - OPR_EXECUTOR_STORAGE_S3_REGION=$_APP_STORAGE_S3_REGION - - OPR_EXECUTOR_STORAGE_S3_BUCKET=$_APP_STORAGE_S3_BUCKET - - OPR_EXECUTOR_STORAGE_S3_ENDPOINT=$_APP_STORAGE_S3_ENDPOINT - - OPR_EXECUTOR_STORAGE_DO_SPACES_ACCESS_KEY=$_APP_STORAGE_DO_SPACES_ACCESS_KEY - - OPR_EXECUTOR_STORAGE_DO_SPACES_SECRET=$_APP_STORAGE_DO_SPACES_SECRET - - OPR_EXECUTOR_STORAGE_DO_SPACES_REGION=$_APP_STORAGE_DO_SPACES_REGION - - OPR_EXECUTOR_STORAGE_DO_SPACES_BUCKET=$_APP_STORAGE_DO_SPACES_BUCKET - - OPR_EXECUTOR_STORAGE_BACKBLAZE_ACCESS_KEY=$_APP_STORAGE_BACKBLAZE_ACCESS_KEY - - OPR_EXECUTOR_STORAGE_BACKBLAZE_SECRET=$_APP_STORAGE_BACKBLAZE_SECRET - - OPR_EXECUTOR_STORAGE_BACKBLAZE_REGION=$_APP_STORAGE_BACKBLAZE_REGION - - OPR_EXECUTOR_STORAGE_BACKBLAZE_BUCKET=$_APP_STORAGE_BACKBLAZE_BUCKET - - OPR_EXECUTOR_STORAGE_LINODE_ACCESS_KEY=$_APP_STORAGE_LINODE_ACCESS_KEY - - OPR_EXECUTOR_STORAGE_LINODE_SECRET=$_APP_STORAGE_LINODE_SECRET - - OPR_EXECUTOR_STORAGE_LINODE_REGION=$_APP_STORAGE_LINODE_REGION - - OPR_EXECUTOR_STORAGE_LINODE_BUCKET=$_APP_STORAGE_LINODE_BUCKET - - OPR_EXECUTOR_STORAGE_WASABI_ACCESS_KEY=$_APP_STORAGE_WASABI_ACCESS_KEY - - OPR_EXECUTOR_STORAGE_WASABI_SECRET=$_APP_STORAGE_WASABI_SECRET - - OPR_EXECUTOR_STORAGE_WASABI_REGION=$_APP_STORAGE_WASABI_REGION - - OPR_EXECUTOR_STORAGE_WASABI_BUCKET=$_APP_STORAGE_WASABI_BUCKET - - - mariadb: - image: mariadb:10.11 - container_name: appwrite-mariadb - restart: unless-stopped - networks: - - appwrite - volumes: - - appwrite-mariadb:/var/lib/mysql:rw - environment: - - MYSQL_ROOT_PASSWORD=${_APP_DB_ROOT_PASS} - - MYSQL_DATABASE=${_APP_DB_SCHEMA} - - MYSQL_USER=${_APP_DB_USER} - - MYSQL_PASSWORD=${_APP_DB_PASS} - - MARIADB_AUTO_UPGRADE=1 - command: 'mysqld --innodb-flush-method=fsync' - healthcheck: - test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"] - interval: 10s - timeout: 10s - retries: 10 - start_period: 30s - - - - mongodb: - image: mongo:8.2.5 - container_name: appwrite-mongodb - <<: *x-logging - restart: unless-stopped - networks: - - appwrite - volumes: - - appwrite-mongodb:/data/db - - appwrite-mongodb-keyfile:/data/keyfile - environment: - - MONGO_INITDB_ROOT_USERNAME=root - - MONGO_INITDB_ROOT_PASSWORD=${_APP_DB_ROOT_PASS} - - MONGO_INITDB_DATABASE=${_APP_DB_SCHEMA} - - MONGO_INITDB_USERNAME=${_APP_DB_USER} - - MONGO_INITDB_PASSWORD=${_APP_DB_PASS} - entrypoint: - - /bin/bash - - -c - - | - set -e - KEYFILE_PATH="/data/keyfile/mongo-keyfile" - INIT_FLAG="/data/db/.mongodb_initialized" - - # Generate keyfile if it doesn't exist - if [ ! -f "$$KEYFILE_PATH" ]; then - echo "Generating random MongoDB keyfile..." - mkdir -p /data/keyfile - openssl rand -base64 756 > "$$KEYFILE_PATH" - fi - chmod 400 "$$KEYFILE_PATH" - chown mongodb:mongodb "$$KEYFILE_PATH" 2>/dev/null || chown 999:999 "$$KEYFILE_PATH" - - # If not initialized, start without auth first to set up replica set and users - if [ ! -f "$$INIT_FLAG" ]; then - echo "First-time initialization: starting MongoDB without auth..." - mongod --replSet rs0 --bind_ip_all --fork --logpath /var/log/mongodb/mongod.log --dbpath /data/db - - echo "Waiting for MongoDB to start..." - sleep 5 - - echo "Initializing replica set..." - mongosh --eval "rs.initiate({_id: 'rs0', members: [{_id: 0, host: 'mongodb:27017'}]})" - - echo "Waiting for replica set to initialize..." - sleep 5 - - echo "Creating root user..." - mongosh admin --eval "db.createUser({user: '$$MONGO_INITDB_ROOT_USERNAME', pwd: '$$MONGO_INITDB_ROOT_PASSWORD', roles: ['root']})" - - echo "Creating application user..." - mongosh admin --eval "db.createUser({user: '$$MONGO_INITDB_USERNAME', pwd: '$$MONGO_INITDB_PASSWORD', roles: [{role: 'readWrite', db: '$$MONGO_INITDB_DATABASE'}]})" - - echo "Shutting down MongoDB..." - mongod --dbpath /data/db --shutdown - - touch "$$INIT_FLAG" - echo "Initialization complete." - fi - - echo "Starting MongoDB with authentication..." - exec mongod --replSet rs0 --bind_ip_all --auth --keyFile "$$KEYFILE_PATH" - healthcheck: - test: | - mongosh -u root -p "$$MONGO_INITDB_ROOT_PASSWORD" --authenticationDatabase admin --quiet --eval "const hello = db.adminCommand({hello: 1}); if (!hello.isWritablePrimary) { quit(1); }" - interval: 10s - timeout: 10s - retries: 10 - start_period: 60s - - - - postgresql: - image: appwrite/postgres:0.1.0 - container_name: appwrite-postgresql - restart: unless-stopped - networks: - - appwrite - volumes: - - appwrite-postgresql:/var/lib/postgresql:rw - environment: - - POSTGRES_DB=${_APP_DB_SCHEMA} - - POSTGRES_USER=${_APP_DB_USER} - - POSTGRES_PASSWORD=${_APP_DB_PASS} - command: "postgres" - healthcheck: - test: ["CMD-SHELL", "pg_isready -U ${_APP_DB_USER} -d ${_APP_DB_SCHEMA}"] - interval: 10s - timeout: 10s - retries: 10 - start_period: 30s - - - - redis: - image: redis:7.4.7-alpine - container_name: appwrite-redis - <<: *x-logging - restart: unless-stopped - command: > - redis-server - --maxmemory 512mb - --maxmemory-policy allkeys-lru - --maxmemory-samples 5 - networks: - - appwrite - volumes: - - appwrite-redis:/data:rw - healthcheck: - test: ["CMD", "redis-cli", "ping"] - interval: 10s - timeout: 5s - retries: 5 - start_period: 10s - - # clamav: - # image: appwrite/clamav:1.2.0 - # container_name: appwrite-clamav - # restart: unless-stopped - # networks: - # - appwrite - # volumes: - # - appwrite-uploads:/storage/uploads - -networks: - gateway: - name: gateway - appwrite: - name: appwrite - runtimes: - name: runtimes - -volumes: - - appwrite-mariadb: - - appwrite-postgresql: - - appwrite-mongodb: - appwrite-mongodb-keyfile: - - appwrite-redis: - appwrite-cache: - appwrite-uploads: - appwrite-imports: - appwrite-certificates: - appwrite-functions: - appwrite-sites: - appwrite-builds: - appwrite-config: - openruntimes-node-modules-cache: diff --git a/docker-compose.override.yml b/docker-compose.override.yml index 91625df148..ced607d9ca 100644 --- a/docker-compose.override.yml +++ b/docker-compose.override.yml @@ -1,10 +1,387 @@ -# Dev tools for local development only. -# This file is automatically loaded by `docker compose` alongside docker-compose.yml. -# CI sets COMPOSE_FILE=docker-compose.yml explicitly, so these services are excluded from test runs. - services: + appwrite: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - /var/run/docker.sock:/var/run/docker.sock + - ./docker-compose.yml:/usr/src/code/docker-compose.yml + - ./.env:/usr/src/code/.env + - ./phpunit.xml:/usr/src/code/phpunit.xml + - ./tests:/usr/src/code/tests + - ./app:/usr/src/code/app + - ./docs:/usr/src/code/docs + - ./public:/usr/src/code/public + - ./src:/usr/src/code/src + - ./dev:/usr/src/code/dev + depends_on: + - coredns + ports: + - 9501:80 + dns: + - 127.0.0.11 + - 172.16.238.100 + entrypoint: + - php + - -e + - app/http.php + environment: + - _APP_MESSAGE_SMS_TEST_DSN + - _APP_MESSAGE_EMAIL_TEST_DSN + - _APP_MESSAGE_PUSH_TEST_DSN + - _TESTS_OAUTH2_GITHUB_CLIENT_ID + - _TESTS_OAUTH2_GITHUB_CLIENT_SECRET + appwrite-realtime: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + ports: + - 9502:80 + appwrite-worker-audits: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-worker-webhooks: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + depends_on: + - request-catcher-sms + - request-catcher-webhook + appwrite-worker-deletes: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-worker-databases: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-worker-builds: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-worker-screenshots: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-worker-certificates: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-worker-executions: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-worker-functions: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-worker-mails: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + depends_on: + - maildev + appwrite-worker-notifications: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + depends_on: + - maildev + appwrite-worker-messaging: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-worker-migrations: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + - ./tests:/usr/src/code/tests + appwrite-task-maintenance: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-task-interval: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-task-stats-resources: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-worker-stats-resources: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-worker-stats-usage: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-task-scheduler-functions: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-task-scheduler-executions: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + appwrite-task-scheduler-messages: + build: + context: . + target: development + args: + DEBUG: false + TESTING: true + VERSION: dev + image: appwrite-dev + volumes: + - ./app:/usr/src/code/app + - ./src:/usr/src/code/src + coredns: + image: coredns/coredns:1.12.4 + container_name: appwrite-coredns + restart: unless-stopped + logging: + driver: json-file + options: + max-file: "5" + max-size: 10m + command: + - -conf + - /mnt/resources/Corefile + networks: + appwrite: + ipv4_address: 172.16.238.100 + volumes: + - ./tests/resources/coredns:/mnt/resources:ro + maildev: + image: appwrite/mailcatcher:1.1.1 + container_name: appwrite-mailcatcher + logging: + driver: json-file + options: + max-file: "5" + max-size: 10m + ports: + - 9503:1080 + networks: + - appwrite + - gateway + labels: + - traefik.enable=true + - traefik.constraint-label-stack=appwrite + - traefik.docker.network=gateway + - traefik.http.services.appwrite_maildev.loadbalancer.server.port=1080 + - traefik.http.routers.appwrite_maildev_http.entrypoints=appwrite_web + - traefik.http.routers.appwrite_maildev_http.rule=Host(`mail.localhost`) + - traefik.http.routers.appwrite_maildev_http.service=appwrite_maildev + - traefik.http.routers.appwrite_maildev_https.entrypoints=appwrite_websecure + - traefik.http.routers.appwrite_maildev_https.rule=Host(`mail.localhost`) + - traefik.http.routers.appwrite_maildev_https.service=appwrite_maildev + - traefik.http.routers.appwrite_maildev_https.tls=true + environment: + - MAILDEV_INCOMING_USER=${_APP_SMTP_USERNAME} + - MAILDEV_INCOMING_PASS=${_APP_SMTP_PASSWORD} + request-catcher-webhook: + image: appwrite/requestcatcher:1.1.0 + container_name: appwrite-requestcatcher-webhook + logging: + driver: json-file + options: + max-file: "5" + max-size: 10m + ports: + - 9504:5000 + networks: + - appwrite + request-catcher-sms: + image: appwrite/requestcatcher:1.1.0 + container_name: appwrite-requestcatcher-sms + logging: + driver: json-file + options: + max-file: "5" + max-size: 10m + ports: + - 9507:5000 + networks: + - appwrite appwrite-mongo-express: - profiles: ["mongodb"] + profiles: + - mongodb image: mongo-express container_name: appwrite-mongo-express networks: @@ -12,13 +389,12 @@ services: ports: - "9508:8081" environment: - ME_CONFIG_MONGODB_URL: "mongodb://root:${_APP_DB_ROOT_PASS}@appwrite-mongodb:27017/?replicaSet=rs0&directConnection=true" + ME_CONFIG_MONGODB_URL: mongodb://root:${_APP_DB_ROOT_PASS}@appwrite-mongodb:27017/?replicaSet=rs0&directConnection=true ME_CONFIG_BASICAUTH_USERNAME: ${_APP_DB_USER} ME_CONFIG_BASICAUTH_PASSWORD: ${_APP_DB_PASS} depends_on: mongodb: condition: service_healthy - adminer: image: adminer container_name: appwrite-adminer @@ -37,20 +413,19 @@ services: configs: - source: adminer-index.php target: /var/www/html/index.php - mode: 0755 + mode: 493 labels: - - "traefik.enable=true" - - "traefik.constraint-label-stack=appwrite" - - "traefik.docker.network=gateway" - - "traefik.http.services.appwrite_adminer.loadbalancer.server.port=8080" - - "traefik.http.routers.appwrite_adminer_http.entrypoints=appwrite_web" - - "traefik.http.routers.appwrite_adminer_http.rule=Host(`mysql.localhost`)" - - "traefik.http.routers.appwrite_adminer_http.service=appwrite_adminer" - - "traefik.http.routers.appwrite_adminer_https.entrypoints=appwrite_websecure" - - "traefik.http.routers.appwrite_adminer_https.rule=Host(`mysql.localhost`)" - - "traefik.http.routers.appwrite_adminer_https.service=appwrite_adminer" - - "traefik.http.routers.appwrite_adminer_https.tls=true" - + - traefik.enable=true + - traefik.constraint-label-stack=appwrite + - traefik.docker.network=gateway + - traefik.http.services.appwrite_adminer.loadbalancer.server.port=8080 + - traefik.http.routers.appwrite_adminer_http.entrypoints=appwrite_web + - traefik.http.routers.appwrite_adminer_http.rule=Host(`mysql.localhost`) + - traefik.http.routers.appwrite_adminer_http.service=appwrite_adminer + - traefik.http.routers.appwrite_adminer_https.entrypoints=appwrite_websecure + - traefik.http.routers.appwrite_adminer_https.rule=Host(`mysql.localhost`) + - traefik.http.routers.appwrite_adminer_https.service=appwrite_adminer + - traefik.http.routers.appwrite_adminer_https.tls=true redis-insight: image: redis/redisinsight:latest restart: unless-stopped @@ -62,22 +437,21 @@ services: configs: - source: redisinsight-connections.json target: /mnt/connections.json - mode: 0755 + mode: 493 labels: - - "traefik.enable=true" - - "traefik.constraint-label-stack=appwrite" - - "traefik.docker.network=gateway" - - "traefik.http.services.appwrite_redisinsight.loadbalancer.server.port=5540" - - "traefik.http.routers.appwrite_redisinsight_http.entrypoints=appwrite_web" - - "traefik.http.routers.appwrite_redisinsight_http.rule=Host(`redis.localhost`)" - - "traefik.http.routers.appwrite_redisinsight_http.service=appwrite_redisinsight" - - "traefik.http.routers.appwrite_redisinsight_https.entrypoints=appwrite_websecure" - - "traefik.http.routers.appwrite_redisinsight_https.rule=Host(`redis.localhost`)" - - "traefik.http.routers.appwrite_redisinsight_https.service=appwrite_redisinsight" - - "traefik.http.routers.appwrite_redisinsight_https.tls=true" + - traefik.enable=true + - traefik.constraint-label-stack=appwrite + - traefik.docker.network=gateway + - traefik.http.services.appwrite_redisinsight.loadbalancer.server.port=5540 + - traefik.http.routers.appwrite_redisinsight_http.entrypoints=appwrite_web + - traefik.http.routers.appwrite_redisinsight_http.rule=Host(`redis.localhost`) + - traefik.http.routers.appwrite_redisinsight_http.service=appwrite_redisinsight + - traefik.http.routers.appwrite_redisinsight_https.entrypoints=appwrite_websecure + - traefik.http.routers.appwrite_redisinsight_https.rule=Host(`redis.localhost`) + - traefik.http.routers.appwrite_redisinsight_https.service=appwrite_redisinsight + - traefik.http.routers.appwrite_redisinsight_https.tls=true ports: - "9514:5540" - graphql-explorer: container_name: appwrite-graphql-explorer image: appwrite/altair:0.3.0 @@ -85,10 +459,51 @@ services: networks: - appwrite ports: - - "9509:3000" + - 9509:3000 environment: - SERVER_URL=http://localhost:9520/v1/graphql - + traefik: + command: + - --providers.file.directory=/storage/config + - --providers.file.watch=true + - --providers.docker=true + - --providers.docker.exposedByDefault=false + - --providers.docker.constraints=Label(`traefik.constraint-label-stack`,`appwrite`) + - --entrypoints.appwrite_web.address=:80 + - --entrypoints.appwrite_websecure.address=:443 + - --log.level=DEBUG + - --api.insecure=true + - --accesslog=true + ports: + - 9520:80 + - 9522:80 + - 9521:443 + - 9500:8080 + networks: + appwrite: + aliases: + - appwrite.test + gateway: + aliases: + - appwrite.test + runtimes: + aliases: + - appwrite.test + mariadb: + ports: + - "9510:3306" + mongodb: + ports: + - "9511:27017" + postgresql: + ports: + - "9512:5432" + redis: + ports: + - "9513:6379" + appwrite-embedding: + ports: + - "9505:3000" configs: redisinsight-connections.json: content: | @@ -129,7 +544,6 @@ configs: "tags": [] } ] - adminer-index.php: content: | /dev/null"] + test: + - CMD-SHELL + - 'curl -fsS -H "Authorization: Bearer $$OPR_EXECUTOR_SECRET" http://localhost/v1/health + >/dev/null' interval: 5s timeout: 3s retries: 20 start_period: 5s - mariadb: - image: mariadb:10.11 # fix issues when upgrading using: mysql_upgrade -u root -p + image: mariadb:10.11 container_name: appwrite-mariadb - <<: *x-logging + logging: + driver: json-file + options: + max-file: "5" + max-size: 10m networks: - appwrite volumes: - appwrite-mariadb:/var/lib/mysql:rw - ports: - - "9510:3306" environment: - MYSQL_ROOT_PASSWORD=${_APP_DB_ROOT_PASS} - MYSQL_DATABASE=${_APP_DB_SCHEMA} - MYSQL_USER=${_APP_DB_USER} - MYSQL_PASSWORD=${_APP_DB_PASS} - MARIADB_AUTO_UPGRADE=1 - command: "mysqld --innodb-flush-method=fsync" + command: + - mysqld + - --innodb-flush-method=fsync healthcheck: - test: ["CMD", "healthcheck.sh", "--connect", "--innodb_initialized"] + test: + - CMD + - healthcheck.sh + - --connect + - --innodb_initialized interval: 5s timeout: 5s retries: 12 - mongodb: image: mongo:8.2.5 container_name: appwrite-mongodb - <<: *x-logging + logging: + driver: json-file + options: + max-file: "5" + max-size: 10m restart: on-failure:3 networks: - appwrite @@ -1395,15 +1340,15 @@ services: - appwrite-mongodb-keyfile:/data/keyfile - ./mongo-init.js:/docker-entrypoint-initdb.d/mongo-init.js:ro - ./mongo-entrypoint.sh:/mongo-entrypoint.sh:ro - ports: - - "9511:27017" environment: - MONGO_INITDB_ROOT_USERNAME=root - MONGO_INITDB_ROOT_PASSWORD=${_APP_DB_ROOT_PASS} - MONGO_INITDB_DATABASE=${_APP_DB_SCHEMA} - MONGO_INITDB_USERNAME=${_APP_DB_USER} - MONGO_INITDB_PASSWORD=${_APP_DB_PASS} - entrypoint: ["/bin/bash", "/mongo-entrypoint.sh"] + entrypoint: + - /bin/bash + - /mongo-entrypoint.sh healthcheck: test: | bash -c " @@ -1426,167 +1371,96 @@ services: timeout: 10s retries: 10 start_period: 30s - postgresql: image: appwrite/postgres:0.1.0 container_name: appwrite-postgresql - <<: *x-logging + logging: + driver: json-file + options: + max-file: "5" + max-size: 10m networks: - appwrite volumes: - appwrite-postgresql:/var/lib/postgresql/18/data:rw - ports: - - "9512:5432" environment: - POSTGRES_DB=${_APP_DB_SCHEMA} - POSTGRES_USER=${_APP_DB_USER} - POSTGRES_PASSWORD=${_APP_DB_PASS} healthcheck: - test: ["CMD-SHELL", "pg_isready -U ${_APP_DB_USER} -d ${_APP_DB_SCHEMA}"] + test: + - CMD-SHELL + - pg_isready -U ${_APP_DB_USER} -d ${_APP_DB_SCHEMA} interval: 5s timeout: 5s retries: 10 start_period: 10s - command: > - postgres - -c fsync=off - -c synchronous_commit=off - -c full_page_writes=off - + command: + - postgres + - -c + - fsync=off + - -c + - synchronous_commit=off + - -c + - full_page_writes=off appwrite-embedding: image: appwrite/embedding:0.1.0 environment: EMBEDDING_MODELS: ${_APP_EMBEDDING_MODELS:-nomic-embed-text} container_name: appwrite-embedding - ports: - - "9505:3000" restart: unless-stopped - # persistent for caching models across restarts and preloading volumes: - appwrite-models:/home/embedder/models networks: - appwrite - redis: image: redis:7.4.7-alpine - <<: *x-logging + logging: + driver: json-file + options: + max-file: "5" + max-size: 10m container_name: appwrite-redis - command: > - redis-server - --maxmemory 512mb - --maxmemory-policy allkeys-lru - --maxmemory-samples 5 - ports: - - "9513:6379" + command: + - redis-server + - --maxmemory + - 512mb + - --maxmemory-policy + - allkeys-lru + - --maxmemory-samples + - "5" networks: - appwrite volumes: - appwrite-redis:/data:rw healthcheck: - test: ["CMD", "redis-cli", "ping"] + test: + - CMD + - redis-cli + - ping interval: 5s timeout: 5s retries: 12 - - coredns: # DNS server for testing purposes (Proxy APIs) - image: coredns/coredns:1.12.4 - container_name: appwrite-coredns - restart: unless-stopped - <<: *x-logging - command: ["-conf", "/mnt/resources/Corefile"] - # If you need to debug CoreDNS, do it from "appwrite container", or port forward: - # ports: - # - "53:53" - networks: - appwrite: - ipv4_address: 172.16.238.100 - volumes: - - ./tests/resources/coredns:/mnt/resources:ro - - # Dev Tools Start ------------------------------------------------------------------------------------------ - # - # The Appwrite Team uses the following tools to help debug, monitor and diagnose the Appwrite stack - # - # Here is a description of the different tools and why are we using them: - # - # MailCatcher - An SMTP server. Catches all system emails and displays them in a nice UI. - # RequestCatcher - An HTTP server. Catches all system https calls and displays them using a simple HTTP API. Used to debug & tests webhooks and HTTP tasks - # Redis Insight - A nice UI for exploring Redis data - # Adminer - A nice UI for exploring MariaDB data - # GraphQl Explorer - A nice UI for exploring GraphQL API - - maildev: # used mainly for dev tests - image: appwrite/mailcatcher:1.1.1 - container_name: appwrite-mailcatcher - <<: *x-logging - ports: - - "9503:1080" - networks: - - appwrite - - gateway - labels: - - "traefik.enable=true" - - "traefik.constraint-label-stack=appwrite" - - "traefik.docker.network=gateway" - - "traefik.http.services.appwrite_maildev.loadbalancer.server.port=1080" - - "traefik.http.routers.appwrite_maildev_http.entrypoints=appwrite_web" - - "traefik.http.routers.appwrite_maildev_http.rule=Host(`mail.localhost`)" - - "traefik.http.routers.appwrite_maildev_http.service=appwrite_maildev" - - "traefik.http.routers.appwrite_maildev_https.entrypoints=appwrite_websecure" - - "traefik.http.routers.appwrite_maildev_https.rule=Host(`mail.localhost`)" - - "traefik.http.routers.appwrite_maildev_https.service=appwrite_maildev" - - "traefik.http.routers.appwrite_maildev_https.tls=true" - environment: - - MAILDEV_INCOMING_USER=${_APP_SMTP_USERNAME} - - MAILDEV_INCOMING_PASS=${_APP_SMTP_PASSWORD} - - request-catcher-webhook: # used mainly for dev tests (mock HTTP webhook) - image: appwrite/requestcatcher:1.1.0 - container_name: appwrite-requestcatcher-webhook - <<: *x-logging - ports: - - "9504:5000" - networks: - - appwrite - - request-catcher-sms: # used mainly for dev tests (mock SMS auth secret) - image: appwrite/requestcatcher:1.1.0 - container_name: appwrite-requestcatcher-sms - <<: *x-logging - ports: - - "9507:5000" - networks: - - appwrite - - # Dev tools (adminer, redis-insight, mongo-express, graphql-explorer) - # are defined in docker-compose.override.yml - networks: gateway: name: gateway appwrite: name: appwrite - ipam: - config: - - subnet: 172.16.238.0/24 runtimes: name: runtimes - - - volumes: - appwrite-mariadb: - appwrite-mongodb: - appwrite-mongodb-keyfile: - appwrite-postgresql: - appwrite-redis: - appwrite-cache: - appwrite-uploads: - appwrite-imports: - appwrite-certificates: - appwrite-functions: - appwrite-sites: - appwrite-builds: - appwrite-config: - appwrite-models: - openruntimes-node-modules-cache: + appwrite-mariadb: null + appwrite-mongodb: null + appwrite-mongodb-keyfile: null + appwrite-postgresql: null + appwrite-redis: null + appwrite-cache: null + appwrite-uploads: null + appwrite-imports: null + appwrite-certificates: null + appwrite-functions: null + appwrite-sites: null + appwrite-builds: null + appwrite-config: null + appwrite-models: null + openruntimes-node-modules-cache: null diff --git a/docs/tutorials/add-environment-variable.md b/docs/tutorials/add-environment-variable.md index 5116908580..7fdd416642 100644 --- a/docs/tutorials/add-environment-variable.md +++ b/docs/tutorials/add-environment-variable.md @@ -24,11 +24,11 @@ This information is also used to generate the website documentation at https://a If the newly introduced environment variable has a default value, add it to the `.env` and `Dockerfile` along with other environment variables. `.env` file uses settings for Appwrite development environment. -### Add to Docker Compose file and template +### Add to Docker Compose file -Add the new environment variables to the `docker-compose.yml` and `app/views/install/compose.phtml` for each docker service that requires access to those environment variables. +Add the new environment variables to `docker-compose.yml` for each Docker service that requires access to those environment variables. -The `docker-compose.yml` file is used by the Appwrite maintainers during development, whereas the `app/views/install/compose.phtml` file is used by the Appwrite setup script. +The setup script generates the install compose file from `docker-compose.yml`, so changes should be made in the base compose file instead of a separate template. Run `npm run format:compose` after editing compose files. With these steps, your environment variable is properly added and can be accessed inside Appwrite code and any other containers where it is passed. You can access and use those variables to implement the features you are trying to achieve. diff --git a/package-lock.json b/package-lock.json index 6ab33b14fe..138de0201d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4,7 +4,26 @@ "requires": true, "packages": { "": { - "name": "@appwrite.io/repo" + "name": "@appwrite.io/repo", + "devDependencies": { + "prettier": "^3.9.0" + } + }, + "node_modules/prettier": { + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.9.0.tgz", + "integrity": "sha512-LjIqSIC5VYLzs9WedVmJ2ljNAGnU+DteIClbahu4L/DBeWjZ6iT/k1lAYyu9JUh+1xINxWadaPw/Pl63y/agAw==", + "dev": true, + "license": "MIT", + "bin": { + "prettier": "bin/prettier.cjs" + }, + "engines": { + "node": ">=14" + }, + "funding": { + "url": "https://github.com/prettier/prettier?sponsor=1" + } } } } diff --git a/package.json b/package.json index 1e2b1be430..9dfab20a21 100644 --- a/package.json +++ b/package.json @@ -5,8 +5,15 @@ "type": "git", "url": "git+https://github.com/appwrite/appwrite.git" }, + "scripts": { + "format:compose": "prettier --write docker-compose.yml docker-compose.override.yml", + "lint:compose": "prettier --check docker-compose.yml docker-compose.override.yml" + }, "files": [ "docs/examples", "app/config/specs" - ] + ], + "devDependencies": { + "prettier": "^3.9.0" + } } diff --git a/src/Appwrite/Docker/Compose/Generator.php b/src/Appwrite/Docker/Compose/Generator.php new file mode 100644 index 0000000000..f982d80178 --- /dev/null +++ b/src/Appwrite/Docker/Compose/Generator.php @@ -0,0 +1,290 @@ + [ + 'default' => 'mongodb', + 'services' => [ + 'mariadb', + 'mongodb', + 'postgresql', + ], + ], + ]; + + private const array SELECTABLE_VOLUME_GROUPS = [ + 'database' => [ + 'mariadb' => ['appwrite-mariadb'], + 'mongodb' => ['appwrite-mongodb', 'appwrite-mongodb-keyfile'], + 'postgresql' => ['appwrite-postgresql'], + ], + ]; + + private const array OPTIONAL_SERVICES = [ + 'enableAssistant' => 'appwrite-assistant', + ]; + + private const array LOCAL_VOLUME_PREPENDS = [ + 'appwrite' => [ + 'param' => 'hostPath', + 'volume' => '{hostPath}:/usr/src/code:rw', + ], + ]; + + private const array PARAM_DEFAULTS = [ + 'version' => 'latest', + 'database' => 'mongodb', + 'hostPath' => '', + 'enableAssistant' => false, + ]; + + private const array DEPENDENCY_SELECTORS = [ + 'database' => [ + 'param' => 'database', + 'condition' => [ + 'condition' => 'service_healthy', + ], + 'placeholders' => [ + '${_APP_DB_HOST:-mongodb}', + '${_APP_DB_HOST:-mariadb}', + ], + ], + ]; + + private const array YAML_DOCUMENT_MARKER_PATTERNS = [ + '/^---\R/', + '/\R\\.\\.\\.\R?$/', + ]; + + /** + * @var array + */ + private array $compose; + + /** + * @var array + */ + private array $params = []; + + private array $selectableServices = [ + 'mariadb', + 'mongodb', + 'postgresql', + ]; + + public function __construct(string $compose) + { + $parsed = \yaml_parse($compose); + + if (!\is_array($parsed)) { + throw new Exception('Failed to parse Docker Compose file'); + } + + $this->compose = $parsed; + } + + /** + * @param array $params + */ + public function render(array $params): string + { + $compose = $this->compose; + $this->params = $this->normalizeParams($params); + $this->selectableServices = $this->getSelectableServices(); + + $compose['services'] = $this->filterServices($compose['services'] ?? []); + $compose['volumes'] = $this->filterVolumes($compose['volumes'] ?? []); + + foreach ($compose['services'] as $name => &$service) { + if (!\is_array($service)) { + continue; + } + + $this->rewriteDependencies($service); + $this->rewriteLocalVolumes($name, $service); + } + unset($service); + + return $this->emit($compose); + } + + /** + * @param array $params + * @return array + */ + private function normalizeParams(array $params): array + { + $params = \array_merge(self::PARAM_DEFAULTS, $params); + + foreach (self::SELECTABLE_SERVICE_GROUPS as $param => $config) { + if (!\in_array($params[$param], $config['services'], true)) { + $params[$param] = $config['default']; + } + } + + $params['hostPath'] = \rtrim((string)$params['hostPath'], '/'); + + return $params; + } + + /** + * @return string[] + */ + private function getSelectableServices(): array + { + $services = []; + + foreach (self::SELECTABLE_SERVICE_GROUPS as $config) { + $services = \array_merge($services, $config['services']); + } + + return \array_values(\array_unique($services)); + } + + /** + * @param array $services + * @return array + */ + private function filterServices(array $services): array + { + foreach (self::SELECTABLE_SERVICE_GROUPS as $param => $config) { + foreach ($config['services'] as $service) { + if ($service !== $this->params[$param]) { + unset($services[$service]); + } + } + } + + foreach (self::OPTIONAL_SERVICES as $param => $service) { + if (empty($this->params[$param])) { + unset($services[$service]); + } + } + + return $services; + } + + /** + * @param array $volumes + * @return array + */ + private function filterVolumes(array $volumes): array + { + foreach (self::SELECTABLE_VOLUME_GROUPS as $param => $groups) { + foreach ($groups as $service => $names) { + if ($service === $this->params[$param]) { + continue; + } + + foreach ($names as $name) { + unset($volumes[$name]); + } + } + } + + return $volumes; + } + + /** + * @param array $service + */ + private function rewriteDependencies(array &$service): void + { + if (!isset($service['depends_on'])) { + return; + } + + foreach (self::DEPENDENCY_SELECTORS as $selector) { + $selected = $this->params[$selector['param']]; + $removable = [ + ...$this->selectableServices, + ...$selector['placeholders'], + ]; + + if (\array_is_list($service['depends_on'])) { + $hasSelectedDependency = false; + $dependsOn = \array_values(\array_filter( + $service['depends_on'], + function (mixed $dependency) use ($removable, &$hasSelectedDependency): bool { + if (!\in_array($dependency, $removable, true)) { + return true; + } + + $hasSelectedDependency = true; + + return false; + } + )); + + if ($hasSelectedDependency && !\in_array($selected, $dependsOn, true)) { + $dependsOn[] = $selected; + } + + $service['depends_on'] = $dependsOn; + continue; + } + + $hasSelectedDependency = false; + foreach ($removable as $dependency) { + if (\array_key_exists($dependency, $service['depends_on'])) { + $hasSelectedDependency = true; + } + + unset($service['depends_on'][$dependency]); + } + + if ($hasSelectedDependency) { + $service['depends_on'][$selected] = $selector['condition']; + } + } + } + + /** + * @param array $service + */ + private function rewriteLocalVolumes(string $name, array &$service): void + { + if ($this->params['version'] !== 'local' || !isset(self::LOCAL_VOLUME_PREPENDS[$name])) { + return; + } + + $config = self::LOCAL_VOLUME_PREPENDS[$name]; + if (empty($this->params[$config['param']])) { + return; + } + + $service['volumes'] ??= []; + \array_unshift($service['volumes'], $this->replacePlaceholders($config['volume'])); + } + + /** + * @param array $compose + */ + private function emit(array $compose): string + { + $yaml = \yaml_emit($compose, YAML_UTF8_ENCODING, YAML_LN_BREAK); + + foreach (self::YAML_DOCUMENT_MARKER_PATTERNS as $pattern) { + $yaml = \preg_replace($pattern, '', $yaml) ?? $yaml; + } + + return $yaml; + } + + private function replacePlaceholders(string $value): string + { + foreach ($this->params as $param => $replacement) { + if (\is_scalar($replacement)) { + $value = \str_replace('{' . $param . '}', (string)$replacement, $value); + } + } + + return $value; + } + +} diff --git a/src/Appwrite/Platform/Installer/Server.php b/src/Appwrite/Platform/Installer/Server.php index b86db4d93d..06be8a6ad1 100644 --- a/src/Appwrite/Platform/Installer/Server.php +++ b/src/Appwrite/Platform/Installer/Server.php @@ -52,6 +52,10 @@ class Server private const string DEFAULT_IMAGE = 'appwrite-dev'; public const string DEFAULT_CONTAINER = 'appwrite-installer'; + private const string COMPOSE_FILE = 'docker-compose.yml'; + private const string ENV_FILE = '.env'; + private const string LOCAL_COMPOSE_FILE = 'docker-compose.web-installer.yml'; + private const string LOCAL_ENV_FILE = '.env.web-installer'; private State $state; private array $paths = []; @@ -208,8 +212,13 @@ class Server } $basePath = $config->isLocal() ? '/usr/src/code' : (getcwd() ?: '.'); - $composePath = $basePath . '/docker-compose.yml'; - $envPath = $basePath . '/.env'; + if ($config->isLocal()) { + $composePath = $basePath . '/' . self::LOCAL_COMPOSE_FILE; + $envPath = $basePath . '/' . self::LOCAL_ENV_FILE; + } else { + $composePath = $basePath . '/' . self::COMPOSE_FILE; + $envPath = $basePath . '/' . self::ENV_FILE; + } if (!file_exists($composePath) && !file_exists($envPath)) { return; diff --git a/src/Appwrite/Platform/Tasks/Install.php b/src/Appwrite/Platform/Tasks/Install.php index 8c9b86dedb..b2a8843049 100644 --- a/src/Appwrite/Platform/Tasks/Install.php +++ b/src/Appwrite/Platform/Tasks/Install.php @@ -3,6 +3,7 @@ namespace Appwrite\Platform\Tasks; use Appwrite\Docker\Compose; +use Appwrite\Docker\Compose\Generator; use Appwrite\Docker\Env; use Appwrite\Platform\Installer\Runtime\State; use Appwrite\Platform\Installer\Server as InstallerServer; @@ -532,7 +533,12 @@ class Install extends Action } $templateForEnv = new View($this->buildFromProjectPath('/app/views/install/env.phtml')); - $templateForCompose = new View($this->buildFromProjectPath('/app/views/install/compose.phtml')); + $composePath = $this->buildFromProjectPath('/docker-compose.yml'); + $composeYaml = \file_get_contents($composePath); + if ($composeYaml === false) { + throw new \RuntimeException('Failed to read docker-compose.yml from ' . $composePath); + } + $composeGenerator = new Generator($composeYaml); $database = $input['_APP_DB_ADAPTER'] ?? 'mongodb'; @@ -557,16 +563,18 @@ class Install extends Action } $executorImages = \implode(',', \array_unique($runtimeImages)); - $templateForCompose - ->setParam('httpPort', $httpPort) - ->setParam('httpsPort', $httpsPort) - ->setParam('version', $version) - ->setParam('organization', $organization) - ->setParam('image', $image) - ->setParam('database', $database) - ->setParam('hostPath', $this->hostPath) - ->setParam('enableAssistant', $enableAssistant) - ->setParam('executorImages', $executorImages); + $input['_APP_HTTP_PORT'] = $httpPort; + $input['_APP_HTTPS_PORT'] = $httpsPort; + $input['_APP_IMAGE'] = "{$organization}/{$image}"; + $input['_APP_VERSION'] = $version; + $input['_APP_EXECUTOR_IMAGES'] = $executorImages; + + $composeContent = $composeGenerator->render([ + 'version' => $version, + 'database' => $database, + 'hostPath' => $this->hostPath, + 'enableAssistant' => $enableAssistant, + ]); $templateForEnv->setParam('vars', $input); @@ -604,7 +612,7 @@ class Install extends Action $this->updateProgress($progress, InstallerServer::STEP_DOCKER_COMPOSE, InstallerServer::STATUS_IN_PROGRESS, $messages); if (!$useExistingConfig) { - $this->writeComposeFile($templateForCompose); + $this->writeComposeFile($composeContent); } $this->updateProgress($progress, InstallerServer::STEP_DOCKER_COMPOSE, InstallerServer::STATUS_COMPLETED, $messages); @@ -623,7 +631,7 @@ class Install extends Action } if ($database === 'mongodb' && !$useExistingConfig && $startIndex <= 1) { - $this->copyMongoEntrypointIfNeeded(); + $this->copyMongoFilesIfNeeded(); } if (!$noStart) { @@ -639,7 +647,7 @@ class Install extends Action } } - if (!$isLocalInstall || file_exists('/.dockerenv') || file_exists('/run/.containerenv')) { + if (!$isLocalInstall && (file_exists('/.dockerenv') || file_exists('/run/.containerenv'))) { $this->connectInstallerToAppwriteNetwork(); } @@ -919,10 +927,9 @@ class Install extends Action $healthPath = '/v1/health/version'; if ($isLocalInstall) { - $candidates = [ - self::APPWRITE_API_URL . $healthPath, - 'http://localhost:' . $httpPort . $healthPath, - ]; + $candidates = (file_exists('/.dockerenv') || file_exists('/run/.containerenv')) + ? ['http://host.docker.internal:' . $httpPort . $healthPath] + : ['http://localhost:' . $httpPort . $healthPath]; } else { $candidates = [ self::APPWRITE_API_URL . $healthPath, @@ -1079,11 +1086,10 @@ class Install extends Action ]; } - private function writeComposeFile(View $template): void + private function writeComposeFile(string $renderedContent): void { $composeFileName = $this->getComposeFileName(); $targetPath = $this->path . '/' . $composeFileName; - $renderedContent = $template->render(false); $result = @file_put_contents($targetPath, $renderedContent); if ($result === false) { @@ -1101,13 +1107,23 @@ class Install extends Action } } - private function copyMongoEntrypointIfNeeded(): void + private function copyMongoFilesIfNeeded(): void { - $mongoEntrypoint = $this->buildFromProjectPath('/mongo-entrypoint.sh'); + $files = [ + 'mongo-entrypoint.sh', + 'mongo-init.js', + ]; - if (file_exists($mongoEntrypoint)) { - // Always use container path for file operations - copy($mongoEntrypoint, $this->path . '/mongo-entrypoint.sh'); + foreach ($files as $file) { + $source = $this->buildFromProjectPath('/' . $file); + if (file_exists($source)) { + $target = $this->path . '/' . $file; + if (@copy($source, $target) === false) { + $lastError = error_get_last(); + $errorMsg = $lastError ? $lastError['message'] : 'Unknown error'; + throw new \RuntimeException('Failed to copy ' . $file . ' to ' . $target . ': ' . $errorMsg); + } + } } } @@ -1153,6 +1169,16 @@ class Install extends Action $command[] = '--project-directory'; $command[] = $composePath; + + $validateCommand = $command; + $validateCommand[] = 'config'; + $validateCommand[] = '--quiet'; + \exec($env . implode(' ', array_map(escapeshellarg(...), $validateCommand)) . ' 2>&1', $validateOutput, $validateExit); + if ($validateExit !== 0) { + $message = trim(implode("\n", $validateOutput)); + throw new \RuntimeException('Invalid Docker Compose file', 0, $message !== '' ? new \RuntimeException($message) : null); + } + $command[] = 'up'; $command[] = '-d'; $command[] = '--remove-orphans'; diff --git a/tests/unit/Docker/Compose/GeneratorTest.php b/tests/unit/Docker/Compose/GeneratorTest.php new file mode 100644 index 0000000000..3741a6004b --- /dev/null +++ b/tests/unit/Docker/Compose/GeneratorTest.php @@ -0,0 +1,134 @@ +assertIsString($compose); + + $this->generator = new Generator($compose); + } + + public function testSelectsDatabaseService(): void + { + $compose = $this->render([ + 'database' => 'mariadb', + 'enableAssistant' => false, + ]); + + $this->assertArrayHasKey('mariadb', $compose['services']); + $this->assertArrayNotHasKey('mongodb', $compose['services']); + $this->assertArrayNotHasKey('postgresql', $compose['services']); + $this->assertArrayHasKey('appwrite-mariadb', $compose['volumes']); + $this->assertArrayNotHasKey('appwrite-mongodb', $compose['volumes']); + $this->assertArrayNotHasKey('appwrite-postgresql', $compose['volumes']); + } + + public function testTogglesAssistantService(): void + { + $disabled = $this->render([ + 'enableAssistant' => false, + ]); + $enabled = $this->render([ + 'enableAssistant' => true, + ]); + + $this->assertArrayNotHasKey('appwrite-assistant', $disabled['services']); + $this->assertArrayHasKey('appwrite-assistant', $enabled['services']); + } + + public function testKeepsProductionWorkers(): void + { + $compose = $this->render(); + + $this->assertArrayHasKey('appwrite-worker-screenshots', $compose['services']); + $this->assertArrayHasKey('appwrite-task-interval', $compose['services']); + $this->assertArrayHasKey('appwrite-embedding', $compose['services']); + } + + public function testKeepsMongoInitFiles(): void + { + $compose = $this->render([ + 'database' => 'mongodb', + ]); + + $this->assertContains('./mongo-init.js:/docker-entrypoint-initdb.d/mongo-init.js:ro', $compose['services']['mongodb']['volumes']); + $this->assertContains('./mongo-entrypoint.sh:/mongo-entrypoint.sh:ro', $compose['services']['mongodb']['volumes']); + } + + public function testAddsLocalHostPathMount(): void + { + $compose = $this->render([ + 'version' => 'local', + 'hostPath' => '/tmp/appwrite', + ]); + + $this->assertSame('/tmp/appwrite:/usr/src/code:rw', $compose['services']['appwrite']['volumes'][0]); + } + + public function testDoesNotAddDatabaseDependencyWithoutPlaceholder(): void + { + $compose = $this->render([ + 'database' => 'postgresql', + ]); + + $this->assertSame(['appwrite'], $compose['services']['traefik']['depends_on']); + $this->assertContains('postgresql', $compose['services']['appwrite']['depends_on']); + $this->assertNotContains('${_APP_DB_HOST:-mongodb}', $compose['services']['appwrite']['depends_on']); + } + + public function testKeepsLongCommandsReadable(): void + { + $mariadb = $this->render([ + 'database' => 'mariadb', + ]); + $postgresql = $this->render([ + 'database' => 'postgresql', + ]); + + $this->assertSame(['mysqld', '--innodb-flush-method=fsync'], $mariadb['services']['mariadb']['command']); + $this->assertSame([ + 'postgres', + '-c', + 'fsync=off', + '-c', + 'synchronous_commit=off', + '-c', + 'full_page_writes=off', + ], $postgresql['services']['postgresql']['command']); + $this->assertSame([ + 'redis-server', + '--maxmemory', + '512mb', + '--maxmemory-policy', + 'allkeys-lru', + '--maxmemory-samples', + '5', + ], $postgresql['services']['redis']['command']); + } + + /** + * @param array $params + * @return array + */ + private function render(array $params = []): array + { + $yaml = $this->generator->render($params); + $compose = \yaml_parse($yaml); + + $this->assertIsArray($compose); + + return $compose; + } +}