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 durable index storage or a documented rebuild process. Check the upstream deployment instructions and pin a release before you deploy. Source repository.

Data dependencies

Typesense stores its collections in its own data directory. Provision persistent storage or plan index rebuilds before starting the service.

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 typesense/typesense on port 8108 with /health.
  3. Configure a data directory and bootstrap API key through the supported settings for the selected release.
  4. Use search-only keys in clients.
  5. Keep indexes on a persistent host or managed service unless you can rebuild them after task replacement.
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. Create a test collection, import sample records and confirm a search-only key can query but cannot modify them.