Add backup download feature (#1587)

Author: humanagent

Archive.zip

@@ -70,7 +70,7 @@ const initClient = async (network: XmtpEnv = "dev") => {
   return client;
 };
 
-export async function handler(req: Request) {
+export async function handler(req: Request): Promise<Response> {
   if (req.method !== "POST") {
     return new Response(JSON.stringify({ error: "Method not allowed" }), {
       status: 405,

agents/monitoring/endpoint.ts

@@ -1 +1 @@
-{"deployedAt": "2025-11-14T15:23:51Z", "version": "0.4.21"}
+{ "deployedAt": "2025-11-14T15:23:51Z", "version": "0.4.21" }

deploy-metadata.json

@@ -46,6 +46,7 @@
     "axios": "^1.8.2",
     "datadog-metrics": "^0.12.1",
     "dotenv": "^16.5.0",
+    "express": "^5.1.0",
     "node-fetch": "^3.3.0",
     "rimraf": "^6.0.1",
     "uint8arrays": "^5.1.0",
@@ -59,6 +60,7 @@
     "@eslint/js": "^9.19.0",
     "@ianvs/prettier-plugin-sort-imports": "^4.4.1",
     "@types/eslint__js": "^8.42.3",
+    "@types/express": "^5",
     "@types/node": "^20.0.0",
     "eslint": "^9.19.0",
     "eslint-config-prettier": "^10.0.1",

package.json

@@ -0,0 +1,52 @@
+# Local db backups in railway
+
+This guide walks you through cloning the repository, deploying the download
+server to Railway, and accessing the backups listing on port `8080`.
+
+> [!NOTE]  
+> THis guides assumes you are deploying to Railway in the /app/data folder using this [tutorial](https://docs.xmtp.org/agents/deploy/deploy-agent)
+
+## 1. Clone the project
+
+```bash
+git clone --depth=1 https://github.com/xmtp/xmtp-qa-tools.git
+cd xmtp-qa-tools
+```
+
+## 2. Deploy to Railway
+
+1. Install the Railway CLI and log in:
+
+   ```bash
+   npm i -g @railway/cli
+   railway login
+   ```
+
+2. Create a Railway project:
+
+   ```bash
+   railway init
+   ```
+
+3. In the Railway dashboard, open your service settings and set the **Start
+   Command** to `yarn web`. This ensures Railway runs the web server entrypoint
+   after each deploy.
+
+4. Deploy the download server:
+
+   ```bash
+   railway up
+   ```
+
+## 3. Access the download page
+
+Once the deployment finishes, open the Railway service URL in your browser:
+
+```
+https://<your-service>.up.railway.app/
+```
+
+You should see the “Download Backup” page with a list of files and their sizes.
+Click any **Download** button to retrieve the selected file.
+
+![Screenshot](./screenshot.png)