Skip to main content

Deploy with an agent

Copy agent prompt

Before you start

Connect your AWS account using the Spring Winter quickstart. You need postgreSQL, a compatible Redis broker and durable document and data files. Check the upstream deployment instructions and pin a release before you deploy. Source repository.

Create and connect the database

  1. Create a private SQL database with PostgreSQL for this deployment. If you already have a database for this deployment, verify that the engine and version match the pinned app release. Wait for the database to be ready.
  2. Open Connect on the database. Use the writer endpoint, port, database name and application credentials. Create the application database and role if needed. Confirm that the application and migration process can reach the private writer.
  3. Set PAPERLESS_DBENGINE=postgresql and the release’s PAPERLESS_DB* settings. Make the Redis-compatible broker reachable and configure PAPERLESS_REDIS. Attach durable media and data storage before startup. Put secret values in runtime configuration or the migration process’s secret store.
  4. Start Paperless-ngx and wait for migrations before uploading documents.

Configure the deployment

  1. Select a Spring Winter project in the AWS Region you want to use. Confirm where persistent or non-HTTP components will run before creating resources.
  2. Use the official Paperless-ngx image on port 8000.
  3. Set PAPERLESS_URL, PAPERLESS_SECRET_KEY, PAPERLESS_REDIS and the selected release’s PAPERLESS_DB* settings.
  4. Keep document media and data on durable storage.
  5. Account for the consume and export directories if you use file ingestion or exports.
  6. Use a persistent host for the standard mount-based layout.
When you run the HTTP app on Spring Winter, set a health path that returns HTTP 200 without signing in. Use Runtime variables for runtime configuration. Task storage is temporary. Verify that every file you need after replacement goes to durable storage.

Verify the deployment

Check the deployment in History if you created Spring Winter compute. Wait for the workflow to succeed, then test the application over HTTPS. Upload a non-sensitive sample, wait for OCR, search its text and verify its download after restart.