Add --db-image argument to wasp deploy railway

waspc/ChangeLog.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### 🔧 Small improvements
+
+- You can now specify which PostgreSQL image to use in `wasp deploy railway` with the `--db-image` argument. ([#3184](https://github.com/wasp-lang/wasp/pull/3184))
+
 ### 📖 Documentation
 
 - Added note for SMTP ports being blocked by some hosting providers (by @Vickram-T-G). ([#3109](https://github.com/wasp-lang/wasp/pull/3109))

waspc/packages/deploy/src/providers/railway/commands/setup/SetupCmdOptions.ts

@@ -7,4 +7,5 @@ import {
 export interface SetupCmdOptions extends CommonCmdOptions, SecretsOptions {
   existingProjectId: RailwayProjectId | null;
   workspace: string | null;
+  dbImage?: string;
 }

waspc/packages/deploy/src/providers/railway/commands/setup/setup.ts

@@ -122,14 +122,42 @@ async function setupRailwayProjectForDirectory({
 
 async function setupDb({
   cmdOptions: options,
+  dbServiceName,
 }: DeploymentInstructions<SetupCmdOptions>): Promise<void> {
   waspSays("Setting up database");
 
   const railwayCli = createCommandWithCwd(
     options.railwayExe,
     options.waspProjectDir,
   );
-  await railwayCli(["add", "-d", "postgres"]);
+
+  if (options.dbImage) {
+    waspSays(`Using custom database image: ${options.dbImage}`);
+    // When using a custom database image, the automatic variables that Railway sets up for the
+    // default Postgres template are not available.
+    await railwayCli([
+      "add",
+      "--service",
+      dbServiceName,
+      "--image",
+      options.dbImage,
+      "--variables",
+      "POSTGRES_DB=railway",
+      "--variables",
+      "POSTGRES_USER=postgres",
+      "--variables",
+      "POSTGRES_PASSWORD=${{secret()}}",
+      "--variables",
+      "PORT=5432",
+      "--variables",
+      "PGDATA=/var/lib/postgresql/data/pgdata",
+      "--variables",
+      "DATABASE_URL=postgresql://${{POSTGRES_USER}}:${{POSTGRES_PASSWORD}}@${{RAILWAY_PRIVATE_DOMAIN}}:${{PORT}}/${{POSTGRES_DB}}",
+    ]);
+  } else {
+    // Use the default Railway Postgres template
+    await railwayCli(["add", "-d", "postgres"]);
+  }
 }
 
 async function setupServer({

waspc/packages/deploy/src/providers/railway/index.ts

@@ -111,6 +111,10 @@ function makeRailwaySetupCommand(): Command {
       "--workspace [workspace]",
       "the Railway workspace to use if a new project needs to be created (if not provided, will ask interactively)",
     )
+    .option(
+      "--db-image [dbImage]",
+      "custom Docker image for the Postgres database (e.g., postgis/postgis for PostGIS extensions)",
+    )
     .action(setupFn);
 }
 
@@ -140,5 +144,9 @@ function makeRailwayLaunchCommand(): Command {
       "--workspace [workspace]",
       "the Railway workspace to use if a new project needs to be created (if not provided, will ask interactively)",
     )
+    .option(
+      "--db-image [dbImage]",
+      "custom Docker image for the Postgres database (e.g., postgis/postgis for PostGIS extensions)",
+    )
     .action(launchFn);
 }

web/docs/deployment/deployment-methods/wasp-deploy/railway.md

@@ -41,7 +41,7 @@ The project name is used as a base for your server and client service names on R
 - `my-wasp-app-client`
 - `my-wasp-app-server`
 
-Railway doesn't allow setting the database service name using the Railway CLI. It will always be named `Postgres`.
+Railway doesn't allow setting the database service name using the Railway CLI. It will always be named `Postgres`. This also applies when using `--db-image`.
 
 <LaunchCommandEnvVars />
 
@@ -96,6 +96,20 @@ wasp deploy railway setup <project-name>
 wasp deploy railway deploy <project-name>
 ```
 
+#### Using a custom database image
+
+Use `--db-image <docker-image>` to provision the database with a specific Postgres image (for example, to enable extensions):
+
+```shell
+# PostGIS
+wasp deploy railway launch my-wasp-app --db-image postgis/postgis
+
+# pgvector
+wasp deploy railway launch my-wasp-app --db-image pgvector/pgvector:pg16
+```
+
+When provided, Wasp configures the DB service on Railway using the given image and required Postgres environment variables. If omitted, Railway’s default Postgres is used. The service name remains `Postgres`.
+
 #### Explicitly providing the Railway project ID
 
 By default, Wasp CLI tries to create a new Railway project named `<project-name>`. If you want to use an existing Railway project, pass its ID with `--existing-project-id` option:
@@ -192,7 +206,21 @@ The project name is used as a base for your server and client service names on R
 - `<project-name>-client`
 - `<project-name>-server`
 
-Railway also creates a PostgreSQL database service named `Postgres`.
+Railway also creates a PostgreSQL database service named `Postgres` (the name remains the same even when using `--db-image`).
+
+#### Using a custom database image
+
+To create the database using a specific Postgres image, pass `--db-image <docker-image>`:
+
+```shell
+# PostGIS
+wasp deploy railway setup my-wasp-app --db-image postgis/postgis
+
+# pgvector
+wasp deploy railway setup my-wasp-app --db-image pgvector/pgvector:pg16
+```
+
+When provided, Wasp sets up the DB service with the specified image and configures necessary Postgres variables. If not provided, Railway’s default Postgres template is used.
 
 #### Explicitly providing the Railway project ID