--- title: "Deploy KaraKeep | (Just Updated) Bookmark Manager and Read-Later App, Pocket Alternative, Admin Preset" description: "KaraKeep self-hosted bookmark manager and read-later app with REST API" category: "Other" url: https://railway.com/deploy/karakeep-or-just-updated-bookmark-manage --- # Deploy KaraKeep | (Just Updated) Bookmark Manager and Read-Later App, Pocket Alternative, Admin Preset KaraKeep self-hosted bookmark manager and read-later app with REST API **[Deploy KaraKeep | (Just Updated) Bookmark Manager and Read-Later App, Pocket Alternative, Admin Preset on Railway](https://railway.com/template/karakeep-or-just-updated-bookmark-manage)** Machine-readable deploy manifest (JSON, validated by TemplateCI): https://railway.com/deploy/karakeep-or-just-updated-bookmark-manage/manifest.json - **Creator:** SuperSlowSloth - **Category:** Other ## Template content ### search - **Image:** getmeili/meilisearch:v1.36.0@sha256:203a0854738be101bfdada825ac3cbf95e5681bc849757b6bc199e4cfae98faa - **Start command:** `/bin/meilisearch --http-addr [::]:7700 --no-analytics` ### chrome - **Image:** ghcr.io/browserless/chromium:v2.55.0 - **Start command:** `/bin/sh -c 'HOST=:: PORT=3000 exec ./scripts/start.sh'` ### karakeep - **Image:** ghcr.io/bon5co/karakeep-railway:0.34.1@sha256:f520e45ee979a560ada1251fcedfecb9e4a953ce971232d39067a4c8a4c60b68 - **Health check:** /api/health - **Public domain:** Yes ## Documentation # Deploy and Host KaraKeep on Railway **Built for an LLM agent to deploy and use.** The deploy form has no fields to fill: the admin login, the session signing key, the search key and the browser token are generated at deploy time, Meilisearch and a headless Chrome run beside the app, and public sign-up is closed once the admin exists. KaraKeep is an open-source, self-hosted bookmark manager and read-later app, a Pocket alternative: save links, notes and images, search them in full text, archive pages and read them later. ## About Hosting KaraKeep This template runs three services: **karakeep** (the web app and its REST API on one public domain, with a volume at `/data` for the database, archived pages and assets), **search** (Meilisearch with a volume at `/meili_data` for the full-text index) and **chrome** (a headless Chrome the app drives over the private network to crawl pages and take screenshots). Bookmarks and settings live in the `/data` volume, so they survive redeploys of any service. **Ready from boot.** Stock KaraKeep leaves sign-up open, so the first stranger to reach a fresh public URL becomes the owner. This template creates the administrator named by the generated `ADMIN_EMAIL` and `ADMIN_PASSWORD` on first boot, on a loopback-only server before the public port opens, and from then on runs with sign-up disabled. The account exists once and a redeploy does not repeat it. **Using it.** Sign in to the web interface at the public URL with the same email and password. For the API, exchange the email and password for an API key with the `apiKeys.exchange` call and send the key as a Bearer header; then `POST /api/v1/bookmarks` saves a link. Uploading assets, AI tagging and summaries need an inference provider key such as `OPENAI_API_KEY`, added as a variable on the karakeep service; everything else works without one. ### Agent contract - Public URL: `https://RAILWAY_PUBLIC_DOMAIN` (the generated domain of the `karakeep` service) - Private URL: `http://karakeep.railway.internal:8080` - Credentials: the variables `ADMIN_EMAIL` and `ADMIN_PASSWORD` on the `karakeep` service - Auth: `POST /api/trpc/apiKeys.exchange` with a JSON body `{"json":{"keyName","email","password"}}` returns an API key under `result.data.json.key`; send it as `Authorization: Bearer $KEY`. A write without a key or with a wrong key answers `401`, and sign-up answers `403`. - Health: `GET /api/health` returns 200 ```bash #!/bin/sh # needs: RAILWAY_PUBLIC_DOMAIN, ADMIN_EMAIL, ADMIN_PASSWORD (variables of the karakeep service); also curl B="https://$RAILWAY_PUBLIC_DOMAIN" J="Content-Type: application/json" curl -s -o /dev/null -w "health: %{http_code}\n" "$B/api/health" KEY=$(curl -s -X POST -H "$J" -d "{\"json\":{\"keyName\":\"agent\",\"email\":\"$ADMIN_EMAIL\",\"password\":\"$ADMIN_PASSWORD\"}}" "$B/api/trpc/apiKeys.exchange" | sed -n 's/.*"key":"\([^"]*\)".*/\1/p') if [ -n "$KEY" ]; then echo "exchange: ok"; else echo "exchange: FAILED"; fi D='{"type":"link","url":"https://example.com"}' curl -s -o /dev/null -w "write with key: %{http_code}\n" -X POST -H "$J" -H "Authorization: Bearer $KEY" -d "$D" "$B/api/v1/bookmarks" curl -s -o /dev/null -w "write without key: %{http_code}\n" -X POST -H "$J" -d "$D" "$B/api/v1/bookmarks" curl -s -o /dev/null -w "write with wrong key: %{http_code}\n" -X POST -H "$J" -H "Authorization: Bearer ${KEY}x" -d "$D" "$B/api/v1/bookmarks" curl -s -o /dev/null -w "read without key: %{http_code}\n" "$B/api/v1/bookmarks" curl -s -o /dev/null -w "read with key: %{http_code}\n" -H "Authorization: Bearer $KEY" "$B/api/v1/bookmarks" curl -s -o /dev/null -w "wrong password exchange: %{http_code}\n" -X POST -H "$J" -d "{\"json\":{\"keyName\":\"agent\",\"email\":\"$ADMIN_EMAIL\",\"password\":\"wrong-password-0\"}}" "$B/api/trpc/apiKeys.exchange" curl -s -o /dev/null -w "open sign-up: %{http_code}\n" -X POST -H "$J" -d '{"name":"intruder","email":"intruder@example.com","password":"intruder-pass-1"}' "$B/api/auth/sign-up/email" ``` A fresh deploy prints `health: 200`, `exchange: ok`, `write with key: 201`, `write without key: 401`, `write with wrong key: 401`, `read without key: 401`, `read with key: 200`, `wrong password exchange: 401` and `open sign-up: 403`. ## Why Deploy KaraKeep on Railway? Railway is a singular platform to deploy your infrastructure stack. Railway will host your infrastructure so you don't have to deal with configuration, while allowing you to vertically and horizontally scale it. By deploying KaraKeep on Railway, you are one step closer to supporting a complete full-stack application with minimal burden. Host your servers, databases, AI agents, and more on Railway. - **Agent-ready** - no deployer fields, a contract block and one script that proves the key exchange, a bookmark write, the refusal of a write without a key and the closed sign-up. - **No open sign-up** - the admin exists before the public port opens, so nobody can claim a fresh URL. - **Data survives redeploys** - the app data and the search index each sit on a volume. - **Pinned** - the upstream, Meilisearch and Chrome images are pinned by digest or exact tag. - **No per-seat pricing** - unlimited bookmarks and API keys on your own domain. ## Common Use Cases - **Read-later and link archive** - save pages with a full-text copy that survives link rot. - **Pocket alternative** - bookmarks, tags, lists and highlights on infrastructure you own. - **Research collection for a team or an agent** - save sources over the REST API and search them later. - **Agent memory for web pages** - an LLM agent saves and retrieves links with an API key. ## Dependencies for KaraKeep Hosting - The karakeep, search and chrome services with their volumes, all created by the template. A custom domain and an inference provider key are optional. ### Deployment Dependencies - [KaraKeep repository](https://github.com/karakeep-app/karakeep) - [Official Docker image](https://github.com/karakeep-app/karakeep/pkgs/container/karakeep) - [Wrapper image source](https://github.com/bon5co/karakeep-railway) ## Similar templates - [Rocky Linux](https://railway.com/deploy/rocky-linux) — Hosted Rocky Linux 9 workspace with SSH and persistent storage. 🚀 - [Foundry Virtual Tabletop](https://railway.com/deploy/X5tR6G) — A Self-Hosted & Modern Roleplaying Platform - [Letta Code Remote](https://railway.com/deploy/letta-code-remote) — Run a Letta Code agent 24/7. No inbound ports, just deploy. Open this page in a browser: https://railway.com/deploy/karakeep-or-just-updated-bookmark-manage