{ "manifest_version": "1.0.0", "template": { "id": "5af804fd-6109-41a8-90cf-888e239b962a", "slug": "docs", "name": "Docs", "description": "Collaborative document editor for writing and sharing as a team", "url": "https://railway.com/deploy/docs", "upstream": { "repo_url": "https://github.com/gridalpha/docs-railway" } }, "services": [ { "name": "Postgres", "source": { "image": "ghcr.io/railwayapp-templates/postgres-ssl:18" }, "needs_volume": true, "volume_mount_path": "/var/lib/postgresql/data", "http": false }, { "name": "keycloak", "source": { "repo": "https://github.com/gridalpha/docs-railway" }, "needs_volume": false, "http": true }, { "name": "backend", "source": { "repo": "https://github.com/gridalpha/docs-railway" }, "needs_volume": false, "http": false }, { "name": "worker", "source": { "repo": "https://github.com/gridalpha/docs-railway" }, "needs_volume": false, "http": false }, { "name": "y-provider", "source": { "image": "lasuite/impress-y-provider:v5.5.0" }, "needs_volume": false, "http": false }, { "name": "docs", "source": { "repo": "https://github.com/gridalpha/docs-railway" }, "needs_volume": false, "http": true }, { "name": "Redis", "source": { "image": "redis:8.2" }, "needs_volume": true, "volume_mount_path": "/data", "http": false }, { "name": "keycloak-db", "source": { "image": "ghcr.io/railwayapp-templates/postgres-ssl:18" }, "needs_volume": true, "volume_mount_path": "/var/lib/postgresql/data", "http": false } ], "required_inputs": [ { "key": "PGDATA", "service": "Postgres", "description": "Cluster location on the volume", "secret": false, "strategy": "default", "default": "/var/lib/postgresql/data/pgdata" }, { "key": "PGHOST", "service": "Postgres", "description": "Data panel alias, not read by the server", "secret": false, "strategy": "railway_provided", "railway_source": "railway_private_domain" }, { "key": "PGPORT", "service": "Postgres", "description": "Data panel alias, not read by the server", "secret": false, "strategy": "default", "default": "5432" }, { "key": "PGUSER", "service": "Postgres", "description": "Data panel alias, not read by the server", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "PGDATABASE", "service": "Postgres", "description": "Data panel alias, not read by the server", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "PGPASSWORD", "service": "Postgres", "description": "Data panel alias, not read by the server", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "POSTGRES_DB", "service": "Postgres", "description": "Database created on first boot", "secret": false, "strategy": "default", "default": "railway" }, { "key": "DATABASE_URL", "service": "Postgres", "description": "Private connection string", "secret": false, "strategy": "railway_provided", "railway_source": "railway_private_domain" }, { "key": "POSTGRES_USER", "service": "Postgres", "description": "Superuser created on first boot", "secret": false, "strategy": "default", "default": "postgres" }, { "key": "SSL_CERT_DAYS", "service": "Postgres", "description": "SSL certificate expiry in days", "secret": false, "strategy": "default", "default": "820" }, { "key": "POSTGRES_PASSWORD", "service": "Postgres", "description": "Superuser password", "secret": true, "strategy": "generate", "generate": "strong_password" }, { "key": "RAILWAY_DEPLOYMENT_DRAINING_SECONDS", "service": "Postgres", "description": "Clean shutdown window", "secret": false, "strategy": "default", "default": "60" }, { "key": "PORT", "service": "keycloak", "description": "HTTP port probed by the health check", "secret": false, "strategy": "default", "default": "8080" }, { "key": "KC_DB", "service": "keycloak", "description": "Database vendor", "secret": false, "strategy": "default", "default": "postgres" }, { "key": "DOCS_REALM", "service": "keycloak", "description": "Realm created at boot", "secret": false, "strategy": "default", "default": "docs" }, { "key": "KC_HOSTNAME", "service": "keycloak", "description": "Public issuer URL", "secret": false, "strategy": "railway_provided", "railway_source": "railway_domain" }, { "key": "KC_HTTP_PORT", "service": "keycloak", "description": "Keycloak HTTP listener", "secret": false, "strategy": "default", "default": "8080" }, { "key": "DOCS_CLIENT_ID", "service": "keycloak", "description": "OpenID Connect client created at boot", "secret": false, "strategy": "default", "default": "docs" }, { "key": "KC_DB_PASSWORD", "service": "keycloak", "description": "Keycloak database password", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "KC_DB_URL_HOST", "service": "keycloak", "description": "Keycloak database host", "secret": false, "strategy": "railway_provided", "railway_source": "railway_private_domain" }, { "key": "KC_DB_URL_PORT", "service": "keycloak", "description": "Keycloak database port", "secret": false, "strategy": "default", "default": "5432" }, { "key": "KC_DB_USERNAME", "service": "keycloak", "description": "Keycloak database user", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "DOCS_PUBLIC_URL", "service": "keycloak", "description": "Drives the client redirect URIs", "secret": false, "strategy": "railway_provided", "railway_source": "railway_domain" }, { "key": "KC_HTTP_ENABLED", "service": "keycloak", "description": "Serve plain HTTP behind the edge", "secret": false, "strategy": "default", "default": "true" }, { "key": "DOCS_ADMIN_EMAIL", "service": "keycloak", "description": "First Docs user, change before deploying", "secret": false, "strategy": "default", "default": "admin@example.dev" }, { "key": "JAVA_OPTS_APPEND", "service": "keycloak", "description": "Heap and private networking", "secret": false, "strategy": "default", "default": "-XX:MaxRAMPercentage=70 -Djava.net.preferIPv6Addresses=true" }, { "key": "KC_PROXY_HEADERS", "service": "keycloak", "description": "Trust X-Forwarded-* from the edge", "secret": false, "strategy": "default", "default": "xforwarded" }, { "key": "KC_DB_URL_DATABASE", "service": "keycloak", "description": "Keycloak database name", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "DOCS_ADMIN_PASSWORD", "service": "keycloak", "description": "Password for that first user", "secret": true, "strategy": "generate", "generate": "strong_password" }, { "key": "DOCS_ADMIN_LAST_NAME", "service": "keycloak", "description": "Family name of the first user", "secret": false, "strategy": "default", "default": "Administrator" }, { "key": "DOCS_ADMIN_FIRST_NAME", "service": "keycloak", "description": "Given name of the first user", "secret": false, "strategy": "default", "default": "Docs" }, { "key": "OIDC_RP_CLIENT_SECRET", "service": "keycloak", "description": "Secret of that client, shared with Docs", "secret": true, "strategy": "generate", "generate": "random_base64_32" }, { "key": "KC_HTTP_MANAGEMENT_PORT", "service": "keycloak", "description": "Management and metrics listener", "secret": false, "strategy": "default", "default": "9000" }, { "key": "KC_BOOTSTRAP_ADMIN_PASSWORD", "service": "keycloak", "description": "Console administrator password", "secret": true, "strategy": "generate", "generate": "strong_password" }, { "key": "KC_BOOTSTRAP_ADMIN_USERNAME", "service": "keycloak", "description": "Console administrator username", "secret": false, "strategy": "default", "default": "admin" }, { "key": "KC_HOSTNAME_BACKCHANNEL_DYNAMIC", "service": "keycloak", "description": "Allow internal backchannel calls", "secret": false, "strategy": "default", "default": "true" }, { "key": "RAILWAY_HEALTHCHECK_TIMEOUT_SEC", "service": "keycloak", "description": "Startup window for schema migration", "secret": false, "strategy": "default", "default": "600" }, { "key": "PORT", "service": "backend", "description": "uvicorn listening port", "secret": false, "strategy": "default", "default": "8000" }, { "key": "DOCS_ROLE", "service": "backend", "description": "Selects the web role in the shared image", "secret": false, "strategy": "default", "default": "web" }, { "key": "REDIS_URL", "service": "backend", "description": "Cache and session store", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "DATABASE_URL", "service": "backend", "description": "Application database", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "KEYCLOAK_REALM", "service": "backend", "description": "Realm holding Docs users", "secret": true, "strategy": "default", "default": "docs" }, { "key": "DOCS_PUBLIC_URL", "service": "backend", "description": "Public origin of the app", "secret": false, "strategy": "railway_provided", "railway_source": "railway_domain" }, { "key": "Y_PROVIDER_HOST", "service": "backend", "description": "Private hostname of the collaboration server", "secret": false, "strategy": "railway_provided", "railway_source": "railway_private_domain" }, { "key": "DOCS_ADMIN_EMAIL", "service": "backend", "description": "First administrator email", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "DJANGO_SECRET_KEY", "service": "backend", "description": "Signs sessions and tokens", "secret": true, "strategy": "generate", "generate": "random_base64_32" }, { "key": "OIDC_RP_CLIENT_ID", "service": "backend", "description": "OpenID Connect client id", "secret": false, "strategy": "default", "default": "docs" }, { "key": "AWS_S3_REGION_NAME", "service": "backend", "description": "Bucket region", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "Y_PROVIDER_API_KEY", "service": "backend", "description": "Authenticates calls to the collaboration server", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "AWS_S3_ENDPOINT_URL", "service": "backend", "description": "Object storage endpoint", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "DOCS_ADMIN_PASSWORD", "service": "backend", "description": "First administrator password", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "KEYCLOAK_PUBLIC_URL", "service": "backend", "description": "Public origin of the identity provider", "secret": true, "strategy": "railway_provided", "railway_source": "railway_domain" }, { "key": "AWS_S3_ACCESS_KEY_ID", "service": "backend", "description": "Object storage access key", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "OIDC_RP_CLIENT_SECRET", "service": "backend", "description": "OpenID Connect client secret", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "AWS_STORAGE_BUCKET_NAME", "service": "backend", "description": "Bucket holding attachments", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "AWS_S3_SECRET_ACCESS_KEY", "service": "backend", "description": "Object storage secret key", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "LOGGING_LEVEL_LOGGERS_APP", "service": "backend", "description": "Application log level", "secret": false, "strategy": "default", "default": "INFO" }, { "key": "LOGGING_LEVEL_LOGGERS_ROOT", "service": "backend", "description": "Root log level", "secret": false, "strategy": "default", "default": "INFO" }, { "key": "COLLABORATION_SERVER_SECRET", "service": "backend", "description": "Shared collaboration API key", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "RAILWAY_HEALTHCHECK_TIMEOUT_SEC", "service": "backend", "description": "Startup window for migrations", "secret": false, "strategy": "default", "default": "600" }, { "key": "PORT", "service": "worker", "description": "Liveness endpoint port", "secret": false, "strategy": "default", "default": "8000" }, { "key": "DOCS_ROLE", "service": "worker", "description": "Selects the Celery role in the shared image", "secret": false, "strategy": "default", "default": "worker" }, { "key": "REDIS_URL", "service": "worker", "description": "Cache and session store", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "DATABASE_URL", "service": "worker", "description": "Application database", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "KEYCLOAK_REALM", "service": "worker", "description": "Realm holding Docs users", "secret": true, "strategy": "default", "default": "docs" }, { "key": "DOCS_PUBLIC_URL", "service": "worker", "description": "Public origin of the app", "secret": false, "strategy": "railway_provided", "railway_source": "railway_domain" }, { "key": "Y_PROVIDER_HOST", "service": "worker", "description": "Private hostname of the collaboration server", "secret": false, "strategy": "railway_provided", "railway_source": "railway_private_domain" }, { "key": "DOCS_ADMIN_EMAIL", "service": "worker", "description": "First administrator email", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "DJANGO_SECRET_KEY", "service": "worker", "description": "Must match the web role", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "OIDC_RP_CLIENT_ID", "service": "worker", "description": "OpenID Connect client id", "secret": false, "strategy": "default", "default": "docs" }, { "key": "AWS_S3_REGION_NAME", "service": "worker", "description": "Bucket region", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "CELERY_CONCURRENCY", "service": "worker", "description": "Worker processes", "secret": false, "strategy": "default", "default": "2" }, { "key": "Y_PROVIDER_API_KEY", "service": "worker", "description": "Authenticates calls to the collaboration server", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "AWS_S3_ENDPOINT_URL", "service": "worker", "description": "Object storage endpoint", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "DOCS_ADMIN_PASSWORD", "service": "worker", "description": "First administrator password", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "KEYCLOAK_PUBLIC_URL", "service": "worker", "description": "Public origin of the identity provider", "secret": true, "strategy": "railway_provided", "railway_source": "railway_domain" }, { "key": "AWS_S3_ACCESS_KEY_ID", "service": "worker", "description": "Object storage access key", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "OIDC_RP_CLIENT_SECRET", "service": "worker", "description": "OpenID Connect client secret", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "AWS_STORAGE_BUCKET_NAME", "service": "worker", "description": "Bucket holding attachments", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "AWS_S3_SECRET_ACCESS_KEY", "service": "worker", "description": "Object storage secret key", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "LOGGING_LEVEL_LOGGERS_APP", "service": "worker", "description": "Application log level", "secret": false, "strategy": "default", "default": "INFO" }, { "key": "LOGGING_LEVEL_LOGGERS_ROOT", "service": "worker", "description": "Root log level", "secret": false, "strategy": "default", "default": "INFO" }, { "key": "COLLABORATION_SERVER_SECRET", "service": "worker", "description": "Shared collaboration API key", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "RAILWAY_HEALTHCHECK_TIMEOUT_SEC", "service": "worker", "description": "Startup window for the liveness endpoint", "secret": false, "strategy": "default", "default": "600" }, { "key": "PORT", "service": "y-provider", "description": "WebSocket and conversion API port", "secret": false, "strategy": "default", "default": "4444" }, { "key": "Y_PROVIDER_API_KEY", "service": "y-provider", "description": "Authenticates the backend to this service", "secret": true, "strategy": "generate", "generate": "random_base64_32" }, { "key": "COLLABORATION_LOGGING", "service": "y-provider", "description": "Log room connections", "secret": false, "strategy": "default", "default": "true" }, { "key": "COLLABORATION_SERVER_ORIGIN", "service": "y-provider", "description": "Allowed browser origin", "secret": false, "strategy": "railway_provided", "railway_source": "railway_domain" }, { "key": "COLLABORATION_SERVER_SECRET", "service": "y-provider", "description": "Second accepted collaboration API key", "secret": true, "strategy": "generate", "generate": "random_base64_32" }, { "key": "COLLABORATION_BACKEND_BASE_URL", "service": "y-provider", "description": "Where this service calls the API", "secret": false, "strategy": "railway_provided", "railway_source": "railway_domain" }, { "key": "PORT", "service": "docs", "description": "nginx listening port for the single origin", "secret": false, "strategy": "default", "default": "8083" }, { "key": "DOCS_BACKEND_HOST", "service": "docs", "description": "Private hostname of the Django API", "secret": false, "strategy": "railway_provided", "railway_source": "railway_private_domain" }, { "key": "DOCS_BACKEND_PORT", "service": "docs", "description": "Django API port", "secret": false, "strategy": "default", "default": "8000" }, { "key": "AWS_S3_ENDPOINT_URL", "service": "docs", "description": "Bucket endpoint for the media gateway", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "DOCS_YPROVIDER_HOST", "service": "docs", "description": "Private hostname of the collaboration server", "secret": false, "strategy": "railway_provided", "railway_source": "railway_private_domain" }, { "key": "DOCS_YPROVIDER_PORT", "service": "docs", "description": "Collaboration server port", "secret": false, "strategy": "default", "default": "4444" }, { "key": "AWS_STORAGE_BUCKET_NAME", "service": "docs", "description": "Bucket name for the media gateway", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "DOCS_CLIENT_MAX_BODY_SIZE", "service": "docs", "description": "Maximum upload size at the proxy", "secret": false, "strategy": "default", "default": "100m" }, { "key": "NGINX_ENTRYPOINT_WORKER_PROCESSES_AUTOTUNE", "service": "docs", "description": "Size nginx workers from the container quota", "secret": false, "strategy": "default", "default": "1" }, { "key": "REDISHOST", "service": "Redis", "description": "Data panel alias, not read by the server", "secret": false, "strategy": "railway_provided", "railway_source": "railway_private_domain" }, { "key": "REDISPORT", "service": "Redis", "description": "Data panel alias, not read by the server", "secret": false, "strategy": "default", "default": "6379" }, { "key": "REDISUSER", "service": "Redis", "description": "Data panel alias, not read by the server", "secret": false, "strategy": "default", "default": "default" }, { "key": "REDIS_URL", "service": "Redis", "description": "Private connection string", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "REDISPASSWORD", "service": "Redis", "description": "Data panel alias, not read by the server", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "REDIS_PASSWORD", "service": "Redis", "description": "Auth password, read by the server", "secret": true, "strategy": "generate", "generate": "strong_password" }, { "key": "PGDATA", "service": "keycloak-db", "description": "Cluster location on the volume", "secret": false, "strategy": "default", "default": "/var/lib/postgresql/data/pgdata" }, { "key": "PGHOST", "service": "keycloak-db", "description": "Data panel alias, not read by the server", "secret": false, "strategy": "railway_provided", "railway_source": "railway_private_domain" }, { "key": "PGPORT", "service": "keycloak-db", "description": "Data panel alias, not read by the server", "secret": false, "strategy": "default", "default": "5432" }, { "key": "PGUSER", "service": "keycloak-db", "description": "Data panel alias, not read by the server", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "PGDATABASE", "service": "keycloak-db", "description": "Data panel alias, not read by the server", "secret": false, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "PGPASSWORD", "service": "keycloak-db", "description": "Data panel alias, not read by the server", "secret": true, "strategy": "railway_provided", "railway_source": "reference_variable" }, { "key": "POSTGRES_DB", "service": "keycloak-db", "description": "Database created on first boot", "secret": false, "strategy": "default", "default": "railway" }, { "key": "DATABASE_URL", "service": "keycloak-db", "description": "Private connection string", "secret": false, "strategy": "railway_provided", "railway_source": "railway_private_domain" }, { "key": "POSTGRES_USER", "service": "keycloak-db", "description": "Superuser created on first boot", "secret": false, "strategy": "default", "default": "postgres" }, { "key": "SSL_CERT_DAYS", "service": "keycloak-db", "description": "SSL certificate expiry in days", "secret": false, "strategy": "default", "default": "820" }, { "key": "POSTGRES_PASSWORD", "service": "keycloak-db", "description": "Superuser password", "secret": true, "strategy": "generate", "generate": "strong_password" }, { "key": "RAILWAY_DEPLOYMENT_DRAINING_SECONDS", "service": "keycloak-db", "description": "Clean shutdown window", "secret": false, "strategy": "default", "default": "60" } ], "deploy": { "mcp": { "server": "railway", "tool": "deploy_template", "args": { "template_code": "docs" } }, "cli": "railway deploy --template docs", "api": { "method": "POST", "path": "/graphql/v2", "body": { "query": "mutation templateDeploy($input: TemplateDeployV2Input!) { templateDeployV2(input: $input) { projectId workflowId } }", "variables": { "input": { "templateId": "5af804fd-6109-41a8-90cf-888e239b962a", "serializedConfig": { "buckets": { "cb45d256-f7aa-4e03-adc1-e8d1cd065491": { "name": "docs-media" } }, "services": { "18cc0e5f-5ecc-454d-835c-6fcb4d58a6de": { "icon": "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/postgresql.svg", "name": "Postgres", "deploy": { "startCommand": null, "healthcheckPath": null, "restartPolicyType": "ON_FAILURE", "restartPolicyMaxRetries": 10 }, "source": { "image": "ghcr.io/railwayapp-templates/postgres-ssl:18" }, "variables": { "PGDATA": { "isOptional": false, "description": "Cluster location on the volume", "defaultValue": "/var/lib/postgresql/data/pgdata" }, "PGHOST": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "${{RAILWAY_PRIVATE_DOMAIN}}" }, "PGPORT": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "5432" }, "PGUSER": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "${{POSTGRES_USER}}" }, "PGDATABASE": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "${{POSTGRES_DB}}" }, "PGPASSWORD": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "${{POSTGRES_PASSWORD}}" }, "POSTGRES_DB": { "isOptional": false, "description": "Database created on first boot", "defaultValue": "railway" }, "DATABASE_URL": { "isOptional": false, "description": "Private connection string", "defaultValue": "postgresql://${{PGUSER}}:${{POSTGRES_PASSWORD}}@${{RAILWAY_PRIVATE_DOMAIN}}:5432/${{PGDATABASE}}" }, "POSTGRES_USER": { "isOptional": false, "description": "Superuser created on first boot", "defaultValue": "postgres" }, "SSL_CERT_DAYS": { "isOptional": false, "description": "SSL certificate expiry in days", "defaultValue": "820" }, "POSTGRES_PASSWORD": { "isOptional": false, "description": "Superuser password", "defaultValue": "{{POSTGRES_PASSWORD}}" }, "RAILWAY_DEPLOYMENT_DRAINING_SECONDS": { "isOptional": false, "description": "Clean shutdown window", "defaultValue": "60" } }, "volumeMounts": { "18cc0e5f-5ecc-454d-835c-6fcb4d58a6de": { "mountPath": "/var/lib/postgresql/data" } } }, "213addbb-8e0d-4332-8e2a-a045495ec819": { "icon": "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/keycloak.svg", "name": "keycloak", "deploy": { "startCommand": null, "healthcheckPath": "/realms/docs", "restartPolicyType": "ON_FAILURE", "restartPolicyMaxRetries": 10 }, "source": { "repo": "https://github.com/gridalpha/docs-railway", "rootDirectory": "keycloak" }, "variables": { "PORT": { "isOptional": false, "description": "HTTP port probed by the health check", "defaultValue": "8080" }, "KC_DB": { "isOptional": false, "description": "Database vendor", "defaultValue": "postgres" }, "DOCS_REALM": { "isOptional": false, "description": "Realm created at boot", "defaultValue": "docs" }, "KC_HOSTNAME": { "isOptional": false, "description": "Public issuer URL", "defaultValue": "https://${{RAILWAY_PUBLIC_DOMAIN}}" }, "KC_HTTP_PORT": { "isOptional": false, "description": "Keycloak HTTP listener", "defaultValue": "8080" }, "DOCS_CLIENT_ID": { "isOptional": false, "description": "OpenID Connect client created at boot", "defaultValue": "docs" }, "KC_DB_PASSWORD": { "isOptional": false, "description": "Keycloak database password", "defaultValue": "${{keycloak-db.PGPASSWORD}}" }, "KC_DB_URL_HOST": { "isOptional": false, "description": "Keycloak database host", "defaultValue": "${{keycloak-db.RAILWAY_PRIVATE_DOMAIN}}" }, "KC_DB_URL_PORT": { "isOptional": false, "description": "Keycloak database port", "defaultValue": "5432" }, "KC_DB_USERNAME": { "isOptional": false, "description": "Keycloak database user", "defaultValue": "${{keycloak-db.PGUSER}}" }, "DOCS_PUBLIC_URL": { "isOptional": false, "description": "Drives the client redirect URIs", "defaultValue": "https://${{docs.RAILWAY_PUBLIC_DOMAIN}}" }, "KC_HTTP_ENABLED": { "isOptional": false, "description": "Serve plain HTTP behind the edge", "defaultValue": "true" }, "DOCS_ADMIN_EMAIL": { "isOptional": false, "description": "First Docs user, change before deploying", "defaultValue": "admin@example.dev" }, "JAVA_OPTS_APPEND": { "isOptional": false, "description": "Heap and private networking", "defaultValue": "-XX:MaxRAMPercentage=70 -Djava.net.preferIPv6Addresses=true" }, "KC_PROXY_HEADERS": { "isOptional": false, "description": "Trust X-Forwarded-* from the edge", "defaultValue": "xforwarded" }, "KC_DB_URL_DATABASE": { "isOptional": false, "description": "Keycloak database name", "defaultValue": "${{keycloak-db.PGDATABASE}}" }, "DOCS_ADMIN_PASSWORD": { "isOptional": false, "description": "Password for that first user", "defaultValue": "{{DOCS_ADMIN_PASSWORD}}" }, "DOCS_ADMIN_LAST_NAME": { "isOptional": false, "description": "Family name of the first user", "defaultValue": "Administrator" }, "DOCS_ADMIN_FIRST_NAME": { "isOptional": false, "description": "Given name of the first user", "defaultValue": "Docs" }, "OIDC_RP_CLIENT_SECRET": { "isOptional": false, "description": "Secret of that client, shared with Docs", "defaultValue": "{{OIDC_RP_CLIENT_SECRET}}" }, "KC_HTTP_MANAGEMENT_PORT": { "isOptional": false, "description": "Management and metrics listener", "defaultValue": "9000" }, "KC_BOOTSTRAP_ADMIN_PASSWORD": { "isOptional": false, "description": "Console administrator password", "defaultValue": "{{KC_BOOTSTRAP_ADMIN_PASSWORD}}" }, "KC_BOOTSTRAP_ADMIN_USERNAME": { "isOptional": false, "description": "Console administrator username", "defaultValue": "admin" }, "KC_HOSTNAME_BACKCHANNEL_DYNAMIC": { "isOptional": false, "description": "Allow internal backchannel calls", "defaultValue": "true" }, "RAILWAY_HEALTHCHECK_TIMEOUT_SEC": { "isOptional": false, "description": "Startup window for schema migration", "defaultValue": "600" } }, "networking": { "serviceDomains": { ":8080": { "port": 8080 } } } }, "2aff955f-ffbb-4f0b-94db-878ccbaea2ae": { "icon": "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/django-dark.svg", "name": "backend", "deploy": { "startCommand": null, "healthcheckPath": "/__heartbeat__", "restartPolicyType": "ON_FAILURE", "restartPolicyMaxRetries": 10 }, "source": { "repo": "https://github.com/gridalpha/docs-railway", "rootDirectory": "backend" }, "variables": { "PORT": { "isOptional": false, "description": "uvicorn listening port", "defaultValue": "8000" }, "DOCS_ROLE": { "isOptional": false, "description": "Selects the web role in the shared image", "defaultValue": "web" }, "REDIS_URL": { "isOptional": false, "description": "Cache and session store", "defaultValue": "${{Redis.REDIS_URL}}/0" }, "DATABASE_URL": { "isOptional": false, "description": "Application database", "defaultValue": "${{Postgres.DATABASE_URL}}" }, "KEYCLOAK_REALM": { "isOptional": false, "description": "Realm holding Docs users", "defaultValue": "docs" }, "DOCS_PUBLIC_URL": { "isOptional": false, "description": "Public origin of the app", "defaultValue": "https://${{docs.RAILWAY_PUBLIC_DOMAIN}}" }, "Y_PROVIDER_HOST": { "isOptional": false, "description": "Private hostname of the collaboration server", "defaultValue": "${{y-provider.RAILWAY_PRIVATE_DOMAIN}}" }, "DOCS_ADMIN_EMAIL": { "isOptional": false, "description": "First administrator email", "defaultValue": "${{keycloak.DOCS_ADMIN_EMAIL}}" }, "DJANGO_SECRET_KEY": { "isOptional": false, "description": "Signs sessions and tokens", "defaultValue": "{{DJANGO_SECRET_KEY}}" }, "OIDC_RP_CLIENT_ID": { "isOptional": false, "description": "OpenID Connect client id", "defaultValue": "docs" }, "AWS_S3_REGION_NAME": { "isOptional": false, "description": "Bucket region", "defaultValue": "${{docs-media.REGION}}" }, "Y_PROVIDER_API_KEY": { "isOptional": false, "description": "Authenticates calls to the collaboration server", "defaultValue": "${{y-provider.Y_PROVIDER_API_KEY}}" }, "AWS_S3_ENDPOINT_URL": { "isOptional": false, "description": "Object storage endpoint", "defaultValue": "${{docs-media.ENDPOINT}}" }, "DOCS_ADMIN_PASSWORD": { "isOptional": false, "description": "First administrator password", "defaultValue": "${{keycloak.DOCS_ADMIN_PASSWORD}}" }, "KEYCLOAK_PUBLIC_URL": { "isOptional": false, "description": "Public origin of the identity provider", "defaultValue": "https://${{keycloak.RAILWAY_PUBLIC_DOMAIN}}" }, "AWS_S3_ACCESS_KEY_ID": { "isOptional": false, "description": "Object storage access key", "defaultValue": "${{docs-media.ACCESS_KEY_ID}}" }, "OIDC_RP_CLIENT_SECRET": { "isOptional": false, "description": "OpenID Connect client secret", "defaultValue": "${{keycloak.OIDC_RP_CLIENT_SECRET}}" }, "AWS_STORAGE_BUCKET_NAME": { "isOptional": false, "description": "Bucket holding attachments", "defaultValue": "${{docs-media.BUCKET}}" }, "AWS_S3_SECRET_ACCESS_KEY": { "isOptional": false, "description": "Object storage secret key", "defaultValue": "${{docs-media.SECRET_ACCESS_KEY}}" }, "LOGGING_LEVEL_LOGGERS_APP": { "isOptional": false, "description": "Application log level", "defaultValue": "INFO" }, "LOGGING_LEVEL_LOGGERS_ROOT": { "isOptional": false, "description": "Root log level", "defaultValue": "INFO" }, "COLLABORATION_SERVER_SECRET": { "isOptional": false, "description": "Shared collaboration API key", "defaultValue": "${{y-provider.COLLABORATION_SERVER_SECRET}}" }, "RAILWAY_HEALTHCHECK_TIMEOUT_SEC": { "isOptional": false, "description": "Startup window for migrations", "defaultValue": "600" } } }, "330c521e-8f8f-4b70-af2d-235088185659": { "icon": "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/png/celery.png", "name": "worker", "deploy": { "startCommand": null, "healthcheckPath": "/healthz", "restartPolicyType": "ON_FAILURE", "restartPolicyMaxRetries": 10 }, "source": { "repo": "https://github.com/gridalpha/docs-railway", "rootDirectory": "backend" }, "variables": { "PORT": { "isOptional": false, "description": "Liveness endpoint port", "defaultValue": "8000" }, "DOCS_ROLE": { "isOptional": false, "description": "Selects the Celery role in the shared image", "defaultValue": "worker" }, "REDIS_URL": { "isOptional": false, "description": "Cache and session store", "defaultValue": "${{Redis.REDIS_URL}}/0" }, "DATABASE_URL": { "isOptional": false, "description": "Application database", "defaultValue": "${{Postgres.DATABASE_URL}}" }, "KEYCLOAK_REALM": { "isOptional": false, "description": "Realm holding Docs users", "defaultValue": "docs" }, "DOCS_PUBLIC_URL": { "isOptional": false, "description": "Public origin of the app", "defaultValue": "https://${{docs.RAILWAY_PUBLIC_DOMAIN}}" }, "Y_PROVIDER_HOST": { "isOptional": false, "description": "Private hostname of the collaboration server", "defaultValue": "${{y-provider.RAILWAY_PRIVATE_DOMAIN}}" }, "DOCS_ADMIN_EMAIL": { "isOptional": false, "description": "First administrator email", "defaultValue": "${{keycloak.DOCS_ADMIN_EMAIL}}" }, "DJANGO_SECRET_KEY": { "isOptional": false, "description": "Must match the web role", "defaultValue": "${{backend.DJANGO_SECRET_KEY}}" }, "OIDC_RP_CLIENT_ID": { "isOptional": false, "description": "OpenID Connect client id", "defaultValue": "docs" }, "AWS_S3_REGION_NAME": { "isOptional": false, "description": "Bucket region", "defaultValue": "${{docs-media.REGION}}" }, "CELERY_CONCURRENCY": { "isOptional": false, "description": "Worker processes", "defaultValue": "2" }, "Y_PROVIDER_API_KEY": { "isOptional": false, "description": "Authenticates calls to the collaboration server", "defaultValue": "${{y-provider.Y_PROVIDER_API_KEY}}" }, "AWS_S3_ENDPOINT_URL": { "isOptional": false, "description": "Object storage endpoint", "defaultValue": "${{docs-media.ENDPOINT}}" }, "DOCS_ADMIN_PASSWORD": { "isOptional": false, "description": "First administrator password", "defaultValue": "${{keycloak.DOCS_ADMIN_PASSWORD}}" }, "KEYCLOAK_PUBLIC_URL": { "isOptional": false, "description": "Public origin of the identity provider", "defaultValue": "https://${{keycloak.RAILWAY_PUBLIC_DOMAIN}}" }, "AWS_S3_ACCESS_KEY_ID": { "isOptional": false, "description": "Object storage access key", "defaultValue": "${{docs-media.ACCESS_KEY_ID}}" }, "OIDC_RP_CLIENT_SECRET": { "isOptional": false, "description": "OpenID Connect client secret", "defaultValue": "${{keycloak.OIDC_RP_CLIENT_SECRET}}" }, "AWS_STORAGE_BUCKET_NAME": { "isOptional": false, "description": "Bucket holding attachments", "defaultValue": "${{docs-media.BUCKET}}" }, "AWS_S3_SECRET_ACCESS_KEY": { "isOptional": false, "description": "Object storage secret key", "defaultValue": "${{docs-media.SECRET_ACCESS_KEY}}" }, "LOGGING_LEVEL_LOGGERS_APP": { "isOptional": false, "description": "Application log level", "defaultValue": "INFO" }, "LOGGING_LEVEL_LOGGERS_ROOT": { "isOptional": false, "description": "Root log level", "defaultValue": "INFO" }, "COLLABORATION_SERVER_SECRET": { "isOptional": false, "description": "Shared collaboration API key", "defaultValue": "${{y-provider.COLLABORATION_SERVER_SECRET}}" }, "RAILWAY_HEALTHCHECK_TIMEOUT_SEC": { "isOptional": false, "description": "Startup window for the liveness endpoint", "defaultValue": "600" } } }, "8409f566-f793-4caf-b239-6892a6ddfd61": { "icon": "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/nodejs.svg", "name": "y-provider", "deploy": { "startCommand": null, "healthcheckPath": "/ping", "restartPolicyType": "ON_FAILURE", "restartPolicyMaxRetries": 10 }, "source": { "image": "lasuite/impress-y-provider:v5.5.0" }, "variables": { "PORT": { "isOptional": false, "description": "WebSocket and conversion API port", "defaultValue": "4444" }, "Y_PROVIDER_API_KEY": { "isOptional": false, "description": "Authenticates the backend to this service", "defaultValue": "{{Y_PROVIDER_API_KEY}}" }, "COLLABORATION_LOGGING": { "isOptional": false, "description": "Log room connections", "defaultValue": "true" }, "COLLABORATION_SERVER_ORIGIN": { "isOptional": false, "description": "Allowed browser origin", "defaultValue": "https://${{docs.RAILWAY_PUBLIC_DOMAIN}}" }, "COLLABORATION_SERVER_SECRET": { "isOptional": false, "description": "Second accepted collaboration API key", "defaultValue": "{{COLLABORATION_SERVER_SECRET}}" }, "COLLABORATION_BACKEND_BASE_URL": { "isOptional": false, "description": "Where this service calls the API", "defaultValue": "https://${{docs.RAILWAY_PUBLIC_DOMAIN}}" } } }, "cc0422ea-0ad1-47e8-9551-add7e1023204": { "icon": "https://raw.githubusercontent.com/suitenumerique/docs/main/src/frontend/apps/impress/public/assets/icon-docs.svg", "name": "docs", "deploy": { "startCommand": null, "healthcheckPath": "/", "restartPolicyType": "ON_FAILURE", "restartPolicyMaxRetries": 10 }, "source": { "repo": "https://github.com/gridalpha/docs-railway", "rootDirectory": "frontend" }, "variables": { "PORT": { "isOptional": false, "description": "nginx listening port for the single origin", "defaultValue": "8083" }, "DOCS_BACKEND_HOST": { "isOptional": false, "description": "Private hostname of the Django API", "defaultValue": "${{backend.RAILWAY_PRIVATE_DOMAIN}}" }, "DOCS_BACKEND_PORT": { "isOptional": false, "description": "Django API port", "defaultValue": "8000" }, "AWS_S3_ENDPOINT_URL": { "isOptional": false, "description": "Bucket endpoint for the media gateway", "defaultValue": "${{docs-media.ENDPOINT}}" }, "DOCS_YPROVIDER_HOST": { "isOptional": false, "description": "Private hostname of the collaboration server", "defaultValue": "${{y-provider.RAILWAY_PRIVATE_DOMAIN}}" }, "DOCS_YPROVIDER_PORT": { "isOptional": false, "description": "Collaboration server port", "defaultValue": "4444" }, "AWS_STORAGE_BUCKET_NAME": { "isOptional": false, "description": "Bucket name for the media gateway", "defaultValue": "${{docs-media.BUCKET}}" }, "DOCS_CLIENT_MAX_BODY_SIZE": { "isOptional": false, "description": "Maximum upload size at the proxy", "defaultValue": "100m" }, "NGINX_ENTRYPOINT_WORKER_PROCESSES_AUTOTUNE": { "isOptional": false, "description": "Size nginx workers from the container quota", "defaultValue": "1" } }, "networking": { "serviceDomains": { ":8083": { "port": 8083 } } } }, "e0afc2eb-7258-4349-acfc-3f2ef806e38a": { "icon": "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/redis.svg", "name": "Redis", "deploy": { "startCommand": "/bin/sh -c \"rm -rf $RAILWAY_VOLUME_MOUNT_PATH/lost+found/ && exec docker-entrypoint.sh redis-server --requirepass $REDIS_PASSWORD --save 60 1 --dir $RAILWAY_VOLUME_MOUNT_PATH\"", "healthcheckPath": null, "restartPolicyType": "ON_FAILURE", "restartPolicyMaxRetries": 10 }, "source": { "image": "redis:8.2" }, "variables": { "REDISHOST": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "${{RAILWAY_PRIVATE_DOMAIN}}" }, "REDISPORT": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "6379" }, "REDISUSER": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "default" }, "REDIS_URL": { "isOptional": false, "description": "Private connection string", "defaultValue": "redis://${{REDISUSER}}:${{REDIS_PASSWORD}}@${{REDISHOST}}:${{REDISPORT}}" }, "REDISPASSWORD": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "${{REDIS_PASSWORD}}" }, "REDIS_PASSWORD": { "isOptional": false, "description": "Auth password, read by the server", "defaultValue": "{{REDIS_PASSWORD}}" } }, "volumeMounts": { "e0afc2eb-7258-4349-acfc-3f2ef806e38a": { "mountPath": "/data" } } }, "f5d6496e-253f-409a-871a-c31c0f9740c8": { "icon": "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/postgresql.svg", "name": "keycloak-db", "deploy": { "startCommand": null, "healthcheckPath": null, "restartPolicyType": "ON_FAILURE", "restartPolicyMaxRetries": 10 }, "source": { "image": "ghcr.io/railwayapp-templates/postgres-ssl:18" }, "variables": { "PGDATA": { "isOptional": false, "description": "Cluster location on the volume", "defaultValue": "/var/lib/postgresql/data/pgdata" }, "PGHOST": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "${{RAILWAY_PRIVATE_DOMAIN}}" }, "PGPORT": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "5432" }, "PGUSER": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "${{POSTGRES_USER}}" }, "PGDATABASE": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "${{POSTGRES_DB}}" }, "PGPASSWORD": { "isOptional": false, "description": "Data panel alias, not read by the server", "defaultValue": "${{POSTGRES_PASSWORD}}" }, "POSTGRES_DB": { "isOptional": false, "description": "Database created on first boot", "defaultValue": "railway" }, "DATABASE_URL": { "isOptional": false, "description": "Private connection string", "defaultValue": "postgresql://${{PGUSER}}:${{POSTGRES_PASSWORD}}@${{RAILWAY_PRIVATE_DOMAIN}}:5432/${{PGDATABASE}}" }, "POSTGRES_USER": { "isOptional": false, "description": "Superuser created on first boot", "defaultValue": "postgres" }, "SSL_CERT_DAYS": { "isOptional": false, "description": "SSL certificate expiry in days", "defaultValue": "820" }, "POSTGRES_PASSWORD": { "isOptional": false, "description": "Superuser password", "defaultValue": "{{POSTGRES_PASSWORD}}" }, "RAILWAY_DEPLOYMENT_DRAINING_SECONDS": { "isOptional": false, "description": "Clean shutdown window", "defaultValue": "60" } }, "volumeMounts": { "f5d6496e-253f-409a-871a-c31c0f9740c8": { "mountPath": "/var/lib/postgresql/data" } } } } } } } } } }, "post_deploy": { "healthcheck": { "service": "keycloak", "method": "GET", "path": "/realms/docs", "expect_status": 200 } }, "resources": { "expected_services": 8, "needs_volume": true }, "generated_at": "2026-09-22T22:14:50.114Z", "generator_version": "0.1.0", "status": "degraded", "validated_at": "2026-09-21T19:30:49.528Z", "success_rate_30d": 0.1429, "validation": { "last_run_id": "run_ed3d3aa9a21648dd890c", "checks": [ { "name": "workflow_completed", "passed": false, "detail": "Your workspace has been restricted. Please contact support to resolve this." } ], "typical_ready_seconds": 148 } }