{
  "manifest_version": "1",
  "slug": "paperless-ngx",
  "title": "Paperless-ngx",
  "headline": "Self-host Paperless-ngx",
  "description": "Run Paperless-ngx on an exe.dev VM: scan, OCR and search your paperwork, signed in with your exe.dev login, with mail-in scans and nightly exports.",
  "category": "productivity",
  "tags": [
    "paperless",
    "paperless-ngx",
    "document management",
    "ocr",
    "scanning",
    "dms",
    "docker compose",
    "postgres",
    "evernote alternative",
    "go paperless"
  ],
  "url": "https://exe.dev/deploy/paperless-ngx",
  "markdown_url": "https://exe.dev/deploy/paperless-ngx.md",
  "upstream": {
    "website": "https://docs.paperless-ngx.com",
    "source": "https://github.com/paperless-ngx/paperless-ngx",
    "docs": "https://docs.paperless-ngx.com",
    "license": "GPL-3.0"
  },
  "example_vm_name": "my-paperless",
  "time": "20 minutes",
  "stack": [
    {
      "name": "Paperless-ngx 3.5",
      "detail": "The official image in Docker Compose; web app, OCR with Tesseract, search, and the consume folder",
      "port": 8000,
      "data": "~/paperless/media"
    },
    {
      "name": "PostgreSQL 18",
      "detail": "Tags, correspondents, users and settings",
      "data": "~/paperless/pgdata"
    },
    {
      "name": "Valkey 9",
      "detail": "The task queue between the web app and the OCR workers"
    },
    {
      "name": "Nightly export",
      "detail": "A systemd timer running Paperless's document exporter; originals, OCR'd copies and a manifest",
      "data": "~/paperless/export"
    }
  ],
  "access": [
    {
      "url": "https://my-paperless.exe.xyz/",
      "who": "private",
      "what": "Paperless, signed in as you through your exe.dev login"
    }
  ],
  "delivers": [
    "Paperless-ngx with PostgreSQL and Valkey, pinned versions, restarting after a reboot.",
    "Single sign-on through exe.dev login; you're the Paperless admin, with no password to type.",
    "A test scan OCR'd and found by search, so you know the pipeline works.",
    "A consume folder you can drop files into over SSH.",
    "A nightly export of every document and its metadata, with a tested restore."
  ],
  "deployable": true,
  "deploy": {
    "new_vm_url": "https://exe.dev/new?prompt=Set%20up%20Paperless-ngx%20on%20this%20VM%20by%20following%20the%20exe.dev%20recipe%20at%20https%3A%2F%2Fexe.dev%2Fdeploy%2Fpaperless-ngx.md%3Fvia%3Ddeploy%20from%20top%20to%20bottom.%0A%0AThe%20recipe%27s%20example%20VM%20name%20is%20my-paperless.%20This%20VM%27s%20name%20is%20the%20output%20of%20%60hostname%60%3A%20use%20it%20wherever%20the%20recipe%20writes%20my-paperless.%20Skip%20the%20step%20that%20creates%20the%20VM%3B%20you%20are%20on%20it.%0A%0AYou%20are%20done%20when%20all%20of%20these%20are%20true.%20Check%20each%20one%20yourself%3A%0A-%20Paperless-ngx%20with%20PostgreSQL%20and%20Valkey%2C%20pinned%20versions%2C%20restarting%20after%20a%20reboot.%0A-%20Single%20sign-on%20through%20exe.dev%20login%3B%20you%27re%20the%20Paperless%20admin%2C%20with%20no%20password%20to%20type.%0A-%20A%20test%20scan%20OCR%27d%20and%20found%20by%20search%2C%20so%20you%20know%20the%20pipeline%20works.%0A-%20A%20consume%20folder%20you%20can%20drop%20files%20into%20over%20SSH.%0A-%20A%20nightly%20export%20of%20every%20document%20and%20its%20metadata%2C%20with%20a%20tested%20restore.%0A%0ARead%20the%20whole%20recipe%2C%20including%20the%20closed%20details.%20For%20initial%20setup%2C%0Afollow%20%22Install%20by%20hand%22%20first%2C%20skipping%20VM%20creation%20and%20SSH%3A%20Docker%2C%20the%0Asettings%2C%20the%20Compose%20stack%2C%20the%20test%20scan%2C%20and%20the%20nightly%20export.%20The%0Awalkthrough%20at%20the%20top%20is%20for%20the%20owner%20afterwards.%0AWork%20as%20exedev%20in%20~%2Fpaperless.%20Never%20overwrite%20an%20existing%20paperless.env%2C%0Apostgres.env%20or%20admin-password.%20Don%27t%20set%20up%20email%2C%20phone%20apps%2C%20AI%2C%20Tika%2C%0Aor%20extra%20OCR%20languages%20unless%20the%20owner%20asks%3B%20don%27t%20make%20the%20VM%20public%20or%0Ashare%20it.%20Don%27t%20run%20Restore%20or%20Update.%0AVerify%20docker.service%20is%20enabled%2C%20every%20container%20uses%20unless-stopped%2C%0Athe%20webserver%20is%20healthy%2C%20the%20log%20says%20it%20created%20the%20superuser%2C%20the%20test%0Ascan%20was%20consumed%20and%20a%20search%20for%20%22water%20heater%22%20finds%20it%2C%20and%20the%20export%0Atimer%20is%20enabled%20and%20its%20test%20run%20wrote%20manifest.json.%20Do%20not%20reboot.%0ANever%20paste%20the%20admin%20password%20into%20the%20chat%3B%20say%20it%27s%20in%0A~%2Fpaperless%2Fadmin-password.%20Finish%20by%20pointing%20the%20owner%20to%20%22Open%0APaperless%22%20and%20%22Get%20your%20paper%20in%22.%0A%0AFinish%20with%20the%20URLs%20I%20should%20open.%0A",
    "terminal": "curl -fsSL https://exe.dev/deploy/paperless-ngx/prompt.txt | ssh exe.dev new --prompt=/dev/stdin",
    "prompt": "Set up Paperless-ngx on this VM by following the exe.dev recipe at https://exe.dev/deploy/paperless-ngx.md?via=deploy from top to bottom.\n\nThe recipe's example VM name is my-paperless. This VM's name is the output of `hostname`: use it wherever the recipe writes my-paperless. Skip the step that creates the VM; you are on it.\n\nYou are done when all of these are true. Check each one yourself:\n- Paperless-ngx with PostgreSQL and Valkey, pinned versions, restarting after a reboot.\n- Single sign-on through exe.dev login; you're the Paperless admin, with no password to type.\n- A test scan OCR'd and found by search, so you know the pipeline works.\n- A consume folder you can drop files into over SSH.\n- A nightly export of every document and its metadata, with a tested restore.\n\nRead the whole recipe, including the closed details. For initial setup,\nfollow \"Install by hand\" first, skipping VM creation and SSH: Docker, the\nsettings, the Compose stack, the test scan, and the nightly export. The\nwalkthrough at the top is for the owner afterwards.\nWork as exedev in ~/paperless. Never overwrite an existing paperless.env,\npostgres.env or admin-password. Don't set up email, phone apps, AI, Tika,\nor extra OCR languages unless the owner asks; don't make the VM public or\nshare it. Don't run Restore or Update.\nVerify docker.service is enabled, every container uses unless-stopped,\nthe webserver is healthy, the log says it created the superuser, the test\nscan was consumed and a search for \"water heater\" finds it, and the export\ntimer is enabled and its test run wrote manifest.json. Do not reboot.\nNever paste the admin password into the chat; say it's in\n~/paperless/admin-password. Finish by pointing the owner to \"Open\nPaperless\" and \"Get your paper in\".\n\nFinish with the URLs I should open.\n",
    "prompt_url": "https://exe.dev/deploy/paperless-ngx/prompt.txt"
  },
  "published": "2026-11-21",
  "updated": "2026-11-21",
  "verified": "2026-11-21",
  "related": [
    "syncthing",
    "immich",
    "vaultwarden",
    "docker-compose",
    "chatwoot",
    "cal-diy"
  ],
  "alternatives": [
    "Evernote",
    "DEVONthink",
    "Google Drive",
    "Dropbox"
  ],
  "files": [
    "https://exe.dev/deploy/paperless-ngx/mail-to-consume.py",
    "https://exe.dev/deploy/paperless-ngx/make-test-scan.py"
  ]
}
