{
  "manifest_version": "1.0.0",
  "template": {
    "id": "8f711bc1-75ee-4c0a-a72f-c537ebd33e79",
    "slug": "matrix-synapse",
    "name": "matrix-synapse",
    "description": "Deploy matrix synapse server with Railway.",
    "url": "https://railway.com/deploy/matrix-synapse",
    "upstream": {
      "image": "matrixdotorg/synapse:latest"
    }
  },
  "status": "unvalidated",
  "validated_at": null,
  "success_rate_30d": null,
  "services": [
    {
      "name": "Postgres",
      "source": {
        "image": "ghcr.io/railwayapp-templates/postgres-ssl:17"
      },
      "needs_volume": true,
      "volume_mount_path": "/var/lib/postgresql/data",
      "http": false
    },
    {
      "name": "synapse",
      "source": {
        "image": "matrixdotorg/synapse:latest"
      },
      "needs_volume": true,
      "volume_mount_path": "/data",
      "http": true
    }
  ],
  "required_inputs": [
    {
      "key": "PGDATA",
      "service": "Postgres",
      "description": "Provide a value for PGDATA.",
      "secret": false,
      "strategy": "default",
      "default": "/var/lib/postgresql/data/pgdata"
    },
    {
      "key": "PGHOST",
      "service": "Postgres",
      "description": "Provide a value for PGHOST.",
      "secret": false,
      "strategy": "railway_provided",
      "railway_source": "railway_private_domain"
    },
    {
      "key": "PGPORT",
      "service": "Postgres",
      "description": "Provide a value for PGPORT.",
      "secret": false,
      "strategy": "default",
      "default": "5432"
    },
    {
      "key": "PGUSER",
      "service": "Postgres",
      "description": "Provide a value for PGUSER.",
      "secret": false,
      "strategy": "railway_provided",
      "railway_source": "reference_variable"
    },
    {
      "key": "PGDATABASE",
      "service": "Postgres",
      "description": "Provide a value for PGDATABASE.",
      "secret": false,
      "strategy": "railway_provided",
      "railway_source": "reference_variable"
    },
    {
      "key": "PGPASSWORD",
      "service": "Postgres",
      "description": "Provide a value for PGPASSWORD.",
      "secret": true,
      "strategy": "railway_provided",
      "railway_source": "reference_variable"
    },
    {
      "key": "POSTGRES_DB",
      "service": "Postgres",
      "description": "Provide a value for POSTGRES_DB.",
      "secret": false,
      "strategy": "default",
      "default": "railway"
    },
    {
      "key": "DATABASE_URL",
      "service": "Postgres",
      "description": "Provide a value for DATABASE_URL.",
      "secret": false,
      "strategy": "railway_provided",
      "railway_source": "railway_private_domain"
    },
    {
      "key": "POSTGRES_USER",
      "service": "Postgres",
      "description": "Provide a value for POSTGRES_USER.",
      "secret": false,
      "strategy": "default",
      "default": "postgres"
    },
    {
      "key": "SSL_CERT_DAYS",
      "service": "Postgres",
      "description": "Provide a value for SSL_CERT_DAYS.",
      "secret": false,
      "strategy": "default",
      "default": "820"
    },
    {
      "key": "POSTGRES_PASSWORD",
      "service": "Postgres",
      "description": "Provide a value for POSTGRES_PASSWORD.",
      "secret": true,
      "strategy": "generate",
      "generate": "strong_password"
    },
    {
      "key": "POSTGRES_INITDB_ARGS",
      "service": "Postgres",
      "description": "Provide a value for POSTGRES_INITDB_ARGS.",
      "secret": false,
      "strategy": "default",
      "default": "--encoding=UTF-8 --lc-collate=C --lc-ctype=C"
    },
    {
      "key": "RAILWAY_DEPLOYMENT_DRAINING_SECONDS",
      "service": "Postgres",
      "description": "Provide a value for RAILWAY_DEPLOYMENT_DRAINING_SECONDS.",
      "secret": false,
      "strategy": "default",
      "default": "60"
    },
    {
      "key": "S3_BUCKET",
      "service": "synapse",
      "description": "The bucket's name.",
      "secret": false,
      "strategy": "ask_user"
    },
    {
      "key": "PGSQL_HOST",
      "service": "synapse",
      "description": "Provide a value for PGSQL_HOST.",
      "secret": false,
      "strategy": "railway_provided",
      "railway_source": "reference_variable"
    },
    {
      "key": "PGSQL_PASS",
      "service": "synapse",
      "description": "Provide a value for PGSQL_PASS.",
      "secret": false,
      "strategy": "railway_provided",
      "railway_source": "reference_variable"
    },
    {
      "key": "PGSQL_USER",
      "service": "synapse",
      "description": "Provide a value for PGSQL_USER.",
      "secret": false,
      "strategy": "railway_provided",
      "railway_source": "reference_variable"
    },
    {
      "key": "PGSQL_DATABASE",
      "service": "synapse",
      "description": "Provide a value for PGSQL_DATABASE.",
      "secret": false,
      "strategy": "railway_provided",
      "railway_source": "reference_variable"
    },
    {
      "key": "MAX_AVATAR_SIZE",
      "service": "synapse",
      "description": "Defaults to null. End with \"K\" \"M\" \"G\" \"T\".",
      "secret": false,
      "strategy": "default",
      "default": "10M"
    },
    {
      "key": "MAX_UPLOAD_SIZE",
      "service": "synapse",
      "description": "Defaults to \"50M\". End with \"K\" \"M\" \"G\" \"T\".",
      "secret": false,
      "strategy": "ask_user"
    },
    {
      "key": "S3_ENDPOINT_URL",
      "service": "synapse",
      "description": "Provide a value for S3_ENDPOINT_URL.",
      "secret": false,
      "strategy": "ask_user"
    },
    {
      "key": "S3_ACCESS_KEY_ID",
      "service": "synapse",
      "description": "Provide a value for S3_ACCESS_KEY_ID.",
      "secret": true,
      "strategy": "generate",
      "generate": "random_base64_32"
    },
    {
      "key": "ENABLE_REGISTRATION",
      "service": "synapse",
      "description": "Defaults to false. Can be changed to true.",
      "secret": false,
      "strategy": "ask_user"
    },
    {
      "key": "SYNAPSE_CONFIG_PATH",
      "service": "synapse",
      "description": "Provide a value for SYNAPSE_CONFIG_PATH.",
      "secret": false,
      "strategy": "default",
      "default": "/data/homeserver.yaml"
    },
    {
      "key": "SYNAPSE_SERVER_NAME",
      "service": "synapse",
      "description": "This sets the public-facing domain of the server.",
      "secret": false,
      "strategy": "ask_user"
    },
    {
      "key": "S3_SECRET_ACCESS_KEY",
      "service": "synapse",
      "description": "Provide a value for S3_SECRET_ACCESS_KEY.",
      "secret": true,
      "strategy": "generate",
      "generate": "random_base64_32"
    },
    {
      "key": "SYNAPSE_REPORT_STATS",
      "service": "synapse",
      "description": "Defaults to no, can be changed to yes.",
      "secret": false,
      "strategy": "default",
      "default": "no"
    }
  ],
  "deploy": {
    "mcp": {
      "server": "railway",
      "tool": "deploy_template",
      "args": {
        "template_code": "matrix-synapse"
      }
    },
    "cli": "railway deploy --template matrix-synapse",
    "api": {
      "method": "POST",
      "path": "/graphql/v2",
      "body": {
        "query": "mutation templateDeploy($input: TemplateDeployV2Input!) { templateDeployV2(input: $input) { projectId workflowId } }",
        "variables": {
          "input": {
            "templateId": "8f711bc1-75ee-4c0a-a72f-c537ebd33e79",
            "serializedConfig": {
              "services": {
                "5a118945-1726-4178-a30c-515636402189": {
                  "icon": "https://devicons.railway.app/i/postgresql.svg",
                  "name": "Postgres",
                  "deploy": {
                    "startCommand": null,
                    "healthcheckPath": null
                  },
                  "source": {
                    "image": "ghcr.io/railwayapp-templates/postgres-ssl:17"
                  },
                  "variables": {
                    "PGDATA": {
                      "isOptional": false,
                      "defaultValue": "/var/lib/postgresql/data/pgdata"
                    },
                    "PGHOST": {
                      "isOptional": false,
                      "defaultValue": "${{RAILWAY_PRIVATE_DOMAIN}}"
                    },
                    "PGPORT": {
                      "isOptional": false,
                      "defaultValue": "5432"
                    },
                    "PGUSER": {
                      "isOptional": false,
                      "defaultValue": "${{POSTGRES_USER}}"
                    },
                    "PGDATABASE": {
                      "isOptional": false,
                      "defaultValue": "${{POSTGRES_DB}}"
                    },
                    "PGPASSWORD": {
                      "isOptional": false,
                      "defaultValue": "${{POSTGRES_PASSWORD}}"
                    },
                    "POSTGRES_DB": {
                      "isOptional": false,
                      "defaultValue": "railway"
                    },
                    "DATABASE_URL": {
                      "defaultValue": "postgresql://${{PGUSER}}:${{POSTGRES_PASSWORD}}@${{RAILWAY_PRIVATE_DOMAIN}}:5432/${{PGDATABASE}}"
                    },
                    "POSTGRES_USER": {
                      "isOptional": false,
                      "defaultValue": "postgres"
                    },
                    "SSL_CERT_DAYS": {
                      "isOptional": false,
                      "defaultValue": "820"
                    },
                    "POSTGRES_PASSWORD": {
                      "isOptional": false,
                      "defaultValue": "{{POSTGRES_PASSWORD}}"
                    },
                    "POSTGRES_INITDB_ARGS": {
                      "isOptional": false,
                      "defaultValue": "--encoding=UTF-8 --lc-collate=C --lc-ctype=C"
                    },
                    "RAILWAY_DEPLOYMENT_DRAINING_SECONDS": {
                      "isOptional": false,
                      "defaultValue": "60"
                    }
                  },
                  "volumeMounts": {
                    "5a118945-1726-4178-a30c-515636402189": {
                      "mountPath": "/var/lib/postgresql/data"
                    }
                  },
                  "haTemplateCode": "postgres-ha",
                  "haConversionConfig": {
                    "edge": {
                      "label": "Reverse Proxy",
                      "options": [
                        2,
                        3,
                        4,
                        5
                      ],
                      "nodeLabel": "HAProxy",
                      "description": "Routes traffic to the primary",
                      "defaultValue": 3
                    },
                    "replica": {
                      "label": "Replicas",
                      "options": [
                        2,
                        3,
                        4,
                        5,
                        6,
                        7
                      ],
                      "nodeLabel": "Postgres",
                      "description": "Streaming replicas for automatic failover",
                      "defaultValue": 2
                    },
                    "internal": {
                      "label": "Coordinator Nodes",
                      "options": [
                        3,
                        5,
                        7,
                        9
                      ],
                      "nodeLabel": "etcd",
                      "defaultValue": 3
                    },
                    "description": "This will convert your Postgres database to an HA cluster with Patroni failover and etcd consensus."
                  }
                },
                "c5ec43d7-093c-44b8-8073-c9e7f281d7fc": {
                  "icon": null,
                  "name": "synapse",
                  "deploy": {
                    "startCommand": "sh -c \"[ -f /data/homeserver.yaml ] || ( /start.py generate && curl -sLo /usr/local/bin/yq https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 && chmod +x /usr/local/bin/yq && /usr/local/bin/yq eval '.database.name=\\\"psycopg2\\\" | del(.database.args.database) | .database.args.user=strenv(PGSQL_USER) | .database.args.password=strenv(PGSQL_PASS) | .database.args.dbname=strenv(PGSQL_DATABASE) | .database.args.host=strenv(PGSQL_HOST) | .database.args.sslmode=\\\"disable\\\" | .suppress_key_server_warning=true | .public_baseurl=strenv(PUBLIC_BASEURL) | .email.smtp_host=strenv(EMAIL_SMTP_HOST) | .email.smtp_port=strenv(EMAIL_SMTP_PORT) | .email.smtp_user=strenv(EMAIL_SMTP_USER) | .email.smtp_pass=strenv(EMAIL_SMTP_PASS) | .email.force_tls=(strenv(EMAIL_FORCE_TLS)==\"true\") | .email.tlsname=strenv(EMAIL_SMTP_HOST) | .email.app_name=strenv(EMAIL_APP_NAME) | .email.enable_notifs=true | .email.notif_from=strenv(EMAIL_NOTIF_FROM) | .email.notif_for_new_users=false | .enable_registration=(strenv(ENABLE_REGISTRATION)==\"true\") | .max_avatar_size=strenv(MAX_AVATAR_SIZE) | .registrations_require_3pid=[\\\"email\\\"] | .max_pending_media_uploads=3 | .max_upload_size=strenv(MAX_UPLOAD_SIZE) | .media_storage_providers=[{\\\"module\\\":\\\"s3_storage_provider.S3StorageProviderBackend\\\",\\\"store_local\\\":true,\\\"store_remote\\\":true,\\\"store_synchronous\\\":true,\\\"config\\\":{\\\"bucket\\\":strenv(S3_BUCKET),\\\"endpoint_url\\\":strenv(S3_ENDPOINT_URL),\\\"access_key_id\\\":strenv(S3_ACCESS_KEY_ID),\\\"secret_access_key\\\":strenv(S3_SECRET_ACCESS_KEY)}}]' -i /data/homeserver.yaml ); pip install --no-cache-dir boto3 && curl -fsSL 'https://github.com/matrix-org/synapse-s3-storage-provider/raw/refs/heads/main/s3_storage_provider.py' -o \\\"$(python -c 'import site; p=[x for x in site.getsitepackages() if \\\"site-packages\\\" in x]; print((p[0] if p else site.getusersitepackages()) + \\\"/s3_storage_provider.py\\\")')\\\" && exec /start.py\"",
                    "healthcheckPath": null
                  },
                  "source": {
                    "image": "matrixdotorg/synapse:latest"
                  },
                  "variables": {
                    "S3_BUCKET": {
                      "isOptional": false,
                      "description": "The bucket's name.",
                      "defaultValue": "{{S3_BUCKET}}"
                    },
                    "PGSQL_HOST": {
                      "isOptional": false,
                      "defaultValue": "${{Postgres.PGHOST}}"
                    },
                    "PGSQL_PASS": {
                      "isOptional": false,
                      "defaultValue": "${{Postgres.PGPASSWORD}}"
                    },
                    "PGSQL_USER": {
                      "isOptional": false,
                      "defaultValue": "${{Postgres.PGUSER}}"
                    },
                    "EMAIL_APP_NAME": {
                      "isOptional": true,
                      "description": "Defines the default value for %(app)s in notif_from and email subjects. Defaults to \"Matrix\".",
                      "defaultValue": ""
                    },
                    "PGSQL_DATABASE": {
                      "isOptional": false,
                      "defaultValue": "${{Postgres.PGDATABASE}}"
                    },
                    "PUBLIC_BASEURL": {
                      "isOptional": true,
                      "description": "The public-facing base URL that clients use to access this Homeserver (not including _matrix/...). If unset or null, https://<server_name>/ is used.",
                      "defaultValue": ""
                    },
                    "EMAIL_FORCE_TLS": {
                      "isOptional": true,
                      "description": "Defaults to false.",
                      "defaultValue": ""
                    },
                    "EMAIL_SMTP_HOST": {
                      "isOptional": true,
                      "description": "",
                      "defaultValue": ""
                    },
                    "EMAIL_SMTP_PASS": {
                      "isOptional": true,
                      "description": "",
                      "defaultValue": ""
                    },
                    "EMAIL_SMTP_PORT": {
                      "isOptional": true,
                      "description": "",
                      "defaultValue": ""
                    },
                    "EMAIL_SMTP_USER": {
                      "isOptional": true,
                      "description": "",
                      "defaultValue": ""
                    },
                    "MAX_AVATAR_SIZE": {
                      "isOptional": true,
                      "description": "Defaults to null. End with \"K\" \"M\" \"G\" \"T\".",
                      "defaultValue": "10M"
                    },
                    "MAX_UPLOAD_SIZE": {
                      "isOptional": false,
                      "description": "Defaults to \"50M\". End with \"K\" \"M\" \"G\" \"T\".",
                      "defaultValue": "{{MAX_UPLOAD_SIZE}}"
                    },
                    "S3_ENDPOINT_URL": {
                      "isOptional": false,
                      "description": "",
                      "defaultValue": "{{S3_ENDPOINT_URL}}"
                    },
                    "EMAIL_NOTIF_FROM": {
                      "isOptional": true,
                      "description": "Defines the \"From\" address to use when sending emails. ([name] <noreply@example.com>)",
                      "defaultValue": ""
                    },
                    "S3_ACCESS_KEY_ID": {
                      "isOptional": false,
                      "description": "",
                      "defaultValue": "{{S3_ACCESS_KEY_ID}}"
                    },
                    "ENABLE_REGISTRATION": {
                      "isOptional": false,
                      "description": "Defaults to false. Can be changed to true.",
                      "defaultValue": "{{ENABLE_REGISTRATION}}"
                    },
                    "SYNAPSE_CONFIG_PATH": {
                      "isOptional": false,
                      "defaultValue": "/data/homeserver.yaml"
                    },
                    "SYNAPSE_SERVER_NAME": {
                      "isOptional": false,
                      "description": "This sets the public-facing domain of the server.",
                      "defaultValue": "{{SYNAPSE_SERVER_NAME}}"
                    },
                    "S3_SECRET_ACCESS_KEY": {
                      "isOptional": false,
                      "description": "",
                      "defaultValue": "{{S3_SECRET_ACCESS_KEY}}"
                    },
                    "SYNAPSE_REPORT_STATS": {
                      "isOptional": true,
                      "description": "Defaults to no, can be changed to yes.",
                      "defaultValue": "no"
                    }
                  },
                  "networking": {
                    "serviceDomains": {
                      "<hasDomain>": {}
                    }
                  },
                  "volumeMounts": {
                    "c5ec43d7-093c-44b8-8073-c9e7f281d7fc": {
                      "mountPath": "/data"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "post_deploy": {},
  "resources": {
    "expected_services": 2,
    "needs_volume": true
  },
  "generated_at": "2026-09-20T10:14:37.339Z",
  "generator_version": "0.1.0"
}