{
  "manifest_version": "1.0.0",
  "template": {
    "id": "b12c0b30-143a-43f8-a337-8e8515c6b0e7",
    "slug": "open-notebook-v1-ai-research-assistant",
    "name": "Open Notebook v1 AI Research Assistant",
    "description": "Private NotebookLM alternative: chat with your sources, generate podcasts.",
    "url": "https://railway.com/deploy/open-notebook-v1-ai-research-assistant",
    "upstream": {
      "image": "lfnovo/open_notebook:1.15.0"
    }
  },
  "services": [
    {
      "name": "SurrealDB",
      "source": {
        "image": "surrealdb/surrealdb:v2.7.0"
      },
      "needs_volume": true,
      "volume_mount_path": "/data",
      "http": false
    },
    {
      "name": "Open Notebook",
      "source": {
        "image": "lfnovo/open_notebook:1.15.0"
      },
      "needs_volume": true,
      "volume_mount_path": "/app/data",
      "http": true
    }
  ],
  "required_inputs": [
    {
      "key": "PORT",
      "service": "SurrealDB",
      "description": "Port SurrealDB listens on (HTTP + WebSocket RPC). Used by the healthcheck and by Open Notebook.",
      "secret": false,
      "strategy": "default",
      "default": "8000"
    },
    {
      "key": "SURREAL_LOG",
      "service": "SurrealDB",
      "description": "SurrealDB log level.",
      "secret": false,
      "strategy": "default",
      "default": "info"
    },
    {
      "key": "SURREAL_BIND",
      "service": "SurrealDB",
      "description": "Listen address: all IPv6 and IPv4 interfaces on the private network (no public domain).",
      "secret": false,
      "strategy": "default",
      "default": "[::]:8000"
    },
    {
      "key": "SURREAL_PASS",
      "service": "SurrealDB",
      "description": "Root password created on first start. Generated at deploy.",
      "secret": false,
      "strategy": "generate",
      "generate": "random_base64_32"
    },
    {
      "key": "SURREAL_PATH",
      "service": "SurrealDB",
      "description": "Storage engine and data path on the /data volume (RocksDB, as in upstream's docker-compose).",
      "secret": false,
      "strategy": "default",
      "default": "rocksdb:/data/open-notebook.db"
    },
    {
      "key": "SURREAL_USER",
      "service": "SurrealDB",
      "description": "Root user created on first start. Generated at deploy.",
      "secret": false,
      "strategy": "generate",
      "generate": "random_base64_32"
    },
    {
      "key": "RAILWAY_RUN_UID",
      "service": "SurrealDB",
      "description": "Run as root so SurrealDB can write the root-owned Railway volume (the image's default user is 65532).",
      "secret": false,
      "strategy": "default",
      "default": "0"
    },
    {
      "key": "SURREAL_NO_BANNER",
      "service": "SurrealDB",
      "description": "Skip the ASCII banner in the logs.",
      "secret": false,
      "strategy": "default",
      "default": "true"
    },
    {
      "key": "SURREAL_EXPERIMENTAL_GRAPHQL",
      "service": "SurrealDB",
      "description": "Same setting as upstream Open Notebook's docker-compose.",
      "secret": false,
      "strategy": "default",
      "default": "true"
    },
    {
      "key": "RAILWAY_DEPLOYMENT_DRAINING_SECONDS",
      "service": "SurrealDB",
      "description": "Lets SurrealDB flush RocksDB and shut down cleanly on redeploy.",
      "secret": false,
      "strategy": "default",
      "default": "30"
    },
    {
      "key": "PORT",
      "service": "Open Notebook",
      "description": "Port of the Next.js frontend, which also proxies /api/* to the internal API (5055). Railway routes the domain and the healthcheck here.",
      "secret": false,
      "strategy": "default",
      "default": "8502"
    },
    {
      "key": "API_URL",
      "service": "Open Notebook",
      "description": "Public URL the browser uses for API calls (same origin, proxied by the frontend). Update it if you add a custom domain.",
      "secret": false,
      "strategy": "railway_provided",
      "railway_source": "railway_domain"
    },
    {
      "key": "SURREAL_URL",
      "service": "Open Notebook",
      "description": "SurrealDB WebSocket endpoint on the private network.",
      "secret": false,
      "strategy": "railway_provided",
      "railway_source": "railway_private_domain"
    },
    {
      "key": "CORS_ORIGINS",
      "service": "Open Notebook",
      "description": "Origins allowed to call the API cross-origin (upstream default is *). Add your custom domain here if you use one.",
      "secret": false,
      "strategy": "railway_provided",
      "railway_source": "railway_domain"
    },
    {
      "key": "SURREAL_USER",
      "service": "Open Notebook",
      "description": "SurrealDB root user (from the SurrealDB service).",
      "secret": false,
      "strategy": "railway_provided",
      "railway_source": "reference_variable"
    },
    {
      "key": "SURREAL_DATABASE",
      "service": "Open Notebook",
      "description": "SurrealDB database used by Open Notebook.",
      "secret": false,
      "strategy": "default",
      "default": "open_notebook"
    },
    {
      "key": "SURREAL_PASSWORD",
      "service": "Open Notebook",
      "description": "SurrealDB root password (from the SurrealDB service).",
      "secret": true,
      "strategy": "railway_provided",
      "railway_source": "reference_variable"
    },
    {
      "key": "SURREAL_NAMESPACE",
      "service": "Open Notebook",
      "description": "SurrealDB namespace used by Open Notebook.",
      "secret": false,
      "strategy": "default",
      "default": "open_notebook"
    },
    {
      "key": "OPEN_NOTEBOOK_PASSWORD",
      "service": "Open Notebook",
      "description": "Password for the web UI, also the REST API bearer token. Generated at deploy; empty disables authentication entirely.",
      "secret": true,
      "strategy": "generate",
      "generate": "strong_password"
    },
    {
      "key": "OPEN_NOTEBOOK_ENCRYPTION_KEY",
      "service": "Open Notebook",
      "description": "Encrypts AI provider credentials stored in the database. Required; changing it makes saved credentials unreadable.",
      "secret": true,
      "strategy": "generate",
      "generate": "random_base64_32"
    },
    {
      "key": "OPEN_NOTEBOOK_WORKER_MAX_TASKS",
      "service": "Open Notebook",
      "description": "Background tasks (source processing, embeddings, podcasts) the worker runs at once (upstream default 5). Use 1 for strict provider rate limits.",
      "secret": false,
      "strategy": "default",
      "default": "5"
    },
    {
      "key": "OPEN_NOTEBOOK_MAX_UPLOAD_SIZE_MB",
      "service": "Open Notebook",
      "description": "Largest upload the API accepts, in MB (upstream default 100).",
      "secret": false,
      "strategy": "default",
      "default": "100"
    },
    {
      "key": "RAILWAY_DEPLOYMENT_DRAINING_SECONDS",
      "service": "Open Notebook",
      "description": "Grace period on redeploy so the worker can finish or release running tasks.",
      "secret": false,
      "strategy": "default",
      "default": "30"
    }
  ],
  "deploy": {
    "mcp": {
      "server": "railway",
      "tool": "deploy_template",
      "args": {
        "template_code": "open-notebook-v1-ai-research-assistant"
      }
    },
    "cli": "railway deploy --template open-notebook-v1-ai-research-assistant",
    "api": {
      "method": "POST",
      "path": "/graphql/v2",
      "body": {
        "query": "mutation templateDeploy($input: TemplateDeployV2Input!) { templateDeployV2(input: $input) { projectId workflowId } }",
        "variables": {
          "input": {
            "templateId": "b12c0b30-143a-43f8-a337-8e8515c6b0e7",
            "serializedConfig": {
              "buckets": {},
              "services": {
                "1186fdcf-5633-57b1-9920-2ffaa1a1cc4a": {
                  "icon": "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/surrealdb.svg",
                  "name": "SurrealDB",
                  "deploy": {
                    "startCommand": "/surreal start",
                    "healthcheckPath": "/health",
                    "restartPolicyType": "ON_FAILURE",
                    "healthcheckTimeout": 300,
                    "restartPolicyMaxRetries": 10
                  },
                  "source": {
                    "image": "surrealdb/surrealdb:v2.7.0"
                  },
                  "variables": {
                    "PORT": {
                      "isOptional": true,
                      "description": "Port SurrealDB listens on (HTTP + WebSocket RPC). Used by the healthcheck and by Open Notebook.",
                      "defaultValue": "8000"
                    },
                    "SURREAL_LOG": {
                      "isOptional": true,
                      "description": "SurrealDB log level.",
                      "defaultValue": "info"
                    },
                    "SURREAL_BIND": {
                      "isOptional": true,
                      "description": "Listen address: all IPv6 and IPv4 interfaces on the private network (no public domain).",
                      "defaultValue": "[::]:8000"
                    },
                    "SURREAL_PASS": {
                      "isOptional": true,
                      "description": "Root password created on first start. Generated at deploy.",
                      "defaultValue": "{{SURREAL_PASS}}"
                    },
                    "SURREAL_PATH": {
                      "isOptional": true,
                      "description": "Storage engine and data path on the /data volume (RocksDB, as in upstream's docker-compose).",
                      "defaultValue": "rocksdb:/data/open-notebook.db"
                    },
                    "SURREAL_USER": {
                      "isOptional": true,
                      "description": "Root user created on first start. Generated at deploy.",
                      "defaultValue": "{{SURREAL_USER}}"
                    },
                    "RAILWAY_RUN_UID": {
                      "isOptional": true,
                      "description": "Run as root so SurrealDB can write the root-owned Railway volume (the image's default user is 65532).",
                      "defaultValue": "0"
                    },
                    "SURREAL_NO_BANNER": {
                      "isOptional": true,
                      "description": "Skip the ASCII banner in the logs.",
                      "defaultValue": "true"
                    },
                    "SURREAL_EXPERIMENTAL_GRAPHQL": {
                      "isOptional": true,
                      "description": "Same setting as upstream Open Notebook's docker-compose.",
                      "defaultValue": "true"
                    },
                    "RAILWAY_DEPLOYMENT_DRAINING_SECONDS": {
                      "isOptional": true,
                      "description": "Lets SurrealDB flush RocksDB and shut down cleanly on redeploy.",
                      "defaultValue": "30"
                    }
                  },
                  "networking": {
                    "tcpProxies": {},
                    "serviceDomains": {}
                  },
                  "volumeMounts": {
                    "38c780e3-bb0c-5c52-9b1e-43765e7b4d57": {
                      "mountPath": "/data"
                    }
                  }
                },
                "f62fc4e7-bd08-5686-9138-d100888f03a0": {
                  "icon": "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/open-notebook.svg",
                  "name": "Open Notebook",
                  "deploy": {
                    "healthcheckPath": "/api/config",
                    "restartPolicyType": "ON_FAILURE",
                    "healthcheckTimeout": 600,
                    "restartPolicyMaxRetries": 10
                  },
                  "source": {
                    "image": "lfnovo/open_notebook:1.15.0"
                  },
                  "variables": {
                    "PORT": {
                      "isOptional": true,
                      "description": "Port of the Next.js frontend, which also proxies /api/* to the internal API (5055). Railway routes the domain and the healthcheck here.",
                      "defaultValue": "8502"
                    },
                    "API_URL": {
                      "isOptional": true,
                      "description": "Public URL the browser uses for API calls (same origin, proxied by the frontend). Update it if you add a custom domain.",
                      "defaultValue": "https://${{RAILWAY_PUBLIC_DOMAIN}}"
                    },
                    "SURREAL_URL": {
                      "isOptional": true,
                      "description": "SurrealDB WebSocket endpoint on the private network.",
                      "defaultValue": "ws://${{SurrealDB.RAILWAY_PRIVATE_DOMAIN}}:${{SurrealDB.PORT}}/rpc"
                    },
                    "CORS_ORIGINS": {
                      "isOptional": true,
                      "description": "Origins allowed to call the API cross-origin (upstream default is *). Add your custom domain here if you use one.",
                      "defaultValue": "https://${{RAILWAY_PUBLIC_DOMAIN}}"
                    },
                    "SURREAL_USER": {
                      "isOptional": true,
                      "description": "SurrealDB root user (from the SurrealDB service).",
                      "defaultValue": "${{SurrealDB.SURREAL_USER}}"
                    },
                    "SURREAL_DATABASE": {
                      "isOptional": true,
                      "description": "SurrealDB database used by Open Notebook.",
                      "defaultValue": "open_notebook"
                    },
                    "SURREAL_PASSWORD": {
                      "isOptional": true,
                      "description": "SurrealDB root password (from the SurrealDB service).",
                      "defaultValue": "${{SurrealDB.SURREAL_PASS}}"
                    },
                    "SURREAL_NAMESPACE": {
                      "isOptional": true,
                      "description": "SurrealDB namespace used by Open Notebook.",
                      "defaultValue": "open_notebook"
                    },
                    "OPEN_NOTEBOOK_PASSWORD": {
                      "isOptional": true,
                      "description": "Password for the web UI, also the REST API bearer token. Generated at deploy; empty disables authentication entirely.",
                      "defaultValue": "{{OPEN_NOTEBOOK_PASSWORD}}"
                    },
                    "OPEN_NOTEBOOK_ENCRYPTION_KEY": {
                      "isOptional": true,
                      "description": "Encrypts AI provider credentials stored in the database. Required; changing it makes saved credentials unreadable.",
                      "defaultValue": "{{OPEN_NOTEBOOK_ENCRYPTION_KEY}}"
                    },
                    "OPEN_NOTEBOOK_WORKER_MAX_TASKS": {
                      "isOptional": true,
                      "description": "Background tasks (source processing, embeddings, podcasts) the worker runs at once (upstream default 5). Use 1 for strict provider rate limits.",
                      "defaultValue": "5"
                    },
                    "OPEN_NOTEBOOK_MAX_UPLOAD_SIZE_MB": {
                      "isOptional": true,
                      "description": "Largest upload the API accepts, in MB (upstream default 100).",
                      "defaultValue": "100"
                    },
                    "RAILWAY_DEPLOYMENT_DRAINING_SECONDS": {
                      "isOptional": true,
                      "description": "Grace period on redeploy so the worker can finish or release running tasks.",
                      "defaultValue": "30"
                    }
                  },
                  "networking": {
                    "tcpProxies": {},
                    "serviceDomains": {
                      "<hasDomain>:8502": {
                        "port": 8502
                      }
                    }
                  },
                  "volumeMounts": {
                    "5c758409-f2e5-5bb7-87ad-45466b3a90e5": {
                      "mountPath": "/app/data"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "post_deploy": {
    "healthcheck": {
      "service": "Open Notebook",
      "method": "GET",
      "path": "/api/config",
      "expect_status": 200
    }
  },
  "resources": {
    "expected_services": 2,
    "needs_volume": true
  },
  "generated_at": "2026-10-11T22:14:38.939Z",
  "generator_version": "0.1.0",
  "status": "validated",
  "validated_at": "2026-10-11T19:08:10.669Z",
  "success_rate_30d": 1,
  "validation": {
    "last_run_id": "run_90640f1ad9de4421a80c",
    "checks": [
      {
        "name": "workflow_completed",
        "passed": true
      },
      {
        "name": "all_services_deployed",
        "passed": true
      },
      {
        "name": "healthcheck",
        "passed": true
      },
      {
        "name": "stays_up",
        "passed": true
      }
    ],
    "typical_ready_seconds": 47,
    "typical_build_seconds": 0,
    "typical_start_seconds": 20,
    "slowest_service": "Open Notebook"
  }
}