Kurrier

https://www.kurrier.org/docs
Admin
Kurrier is a self-hosted, developer-friendly workspace offering unified access to email, calendars,...
Tokens:9,534
Snippets:148
Trust Score:5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Quick start (Docker)

Source: https://www.kurrier.org/docs/installation

Clone the repository and copy the example environment file.

```bash
git clone --branch deploy --single-branch https://github.com/kurrier-org/kurrier.git kurrier
cd kurrier
cp example.env .env
cp -r init/* .
docker compose up -d
```

--------------------------------

### Local Setup - ngrok example

Source: https://www.kurrier.org/docs/installation

Example using ngrok to create a public tunnel URL for local setup.

```bash
ngrok http <port>
```

--------------------------------

### Hosted Setup - .env update

Source: https://www.kurrier.org/docs/installation

Update your .env file with your domain for hosted setup.

```env
WEB_URL=https://www.yourdomain.com
```

--------------------------------

### Environment Variables

Source: https://www.kurrier.org/docs/installation

Example environment variables for Kurrier.

```env
REDIS_PASSWORD=replace_with_your_redis_password
RLS_CLIENT_PASSWORD=replace_with_your_rls_client_password
TYPESENSE_API_KEY=supersecretkey
POSTGRES_PASSWORD=your-super-secret-and-long-postgres-password
JWT_SECRET=your-super-secret-jwt-token-with-at-least-32-characters-long
ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJhbm9uIiwKICAgICJpc3MiOiAic3VwYWJhc2UtZGVtbyIsCiAgICAiaWF0IjogMTY0MTc2OTIwMCwKICAgICJleHAiOiAxNzk5NTM1NjAwCn0.dc_X5iR_VP_qT0zsiyj_I_OZ2T9FtRU2BBNWN8Bu4GE
SERVICE_ROLE_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJzZXJ2aWNlX3JvbGUiLAogICAgImlzcyI6ICJzdXBhYmFzZS1kZW1vIiwKICAgICJpYXQiOiAxNjQxNzY5MjAwLAogICAgImV4cCI6IDE3OTk1MzU2MDAKfQ.DaYlNEoUrrEn2Ig7tqibS-PHK5vgusbcbo7X36XVt4Q
DASHBOARD_USERNAME=supabase
DASHBOARD_PASSWORD=this_password_is_insecure_and_should_be_updated
SECRET_KEY_BASE=UpNVntn3cDxHJpq99YMc1T1AQgQpc8kfYTuRgBiYa15BLrx8etQoXz3gZv1/u2oq
VAULT_ENC_KEY=your-encryption-key-32-chars-min
```

--------------------------------

### Development Setup

Source: https://www.kurrier.org/docs/contributing

Steps to clone the repository, set up environment variables, initialize the database, and start the development server.

```bash
git clone git@github.com:kurrier-org/kurrier.git
cd kurrier/db
cp example.develop.env .env
cp example.develop.env .env.develop
cp -rn init/* .
docker compose up -d
cd ..
pnpm install && pnpm run dev
```

--------------------------------

### Me Response Example

Source: https://www.kurrier.org/docs/api/api-routes/me

Example of a successful response from the GET /me endpoint, returning the authenticated user's userId.

```json
{
  "userId": "8f7c0e1e-d334-4f63-9df8-bb45d0cf94a3"
}
```

--------------------------------

### Local Setup - .env update

Source: https://www.kurrier.org/docs/installation

Update your .env file with the generated public URL for local tunneling.

```env
LOCAL_TUNNEL_URL=https://your-ngrok-tunnel-url.ngrok-free.app
```

--------------------------------

### Monitor Worker Logs

Source: https://www.kurrier.org/docs/getting-started

You can monitor the background worker logs using Docker Compose.

```bash
docker compose logs -f worker
```

--------------------------------

### Run Kurrier

Source: https://www.kurrier.org/docs/installation

Command to run Kurrier after setting up environment variables.

```bash
docker compose up -d
```

--------------------------------

### Stop Kurrier

Source: https://www.kurrier.org/docs/installation

Command to stop Kurrier.

```bash
docker compose down
```

--------------------------------

### Create a webhook request body example

Source: https://www.kurrier.org/docs/api/api-routes/webhooks

Example JSON payload for creating a new webhook subscription.

```json
{
"ownerId": "be7a7201-76db-4b73-a5e0-ad6a1b93cf1f",
"identityId": "1a9b317a-8a84-493a-b9f8-83a3800861e2",
"url": "http://www.myapp.com/api/webhooks/kurrier",
"events": ["message.received"]
}
```

--------------------------------

### Identity Object Format Example

Source: https://www.kurrier.org/docs/api/api-routes/identities

Example response object for an identity.

```json
{
    "id":"1a9b317a-8a84-493a-b9f8-83a3800861e2",
    "owner_id":"be7a7201-76db-4b73-a5e0-ad6a1b93cf1f",
    "kind":"email",
    "public_id":"9ANdDSgvj5",
    "value":"me@myapp.com",
    "incoming_domain":false,
    "domain_identity_id":"b4950019-500a-44a6-9b24-08b2517f1b3d",
    "dns_records":"null",
    "meta":"{}",
    "provider_id":"c4248dd5-46f2-48f5-9d5b-91b7e7d67c74",
    "smtp_account_id":null,
    "status":"unverified",
    "created_at":"2025-11-15 10:47:23.60418+00",
    "updated_at":"2025-11-15 10:47:23.60418+00"
}
```

--------------------------------

### Webhook delivery format example

Source: https://www.kurrier.org/docs/api/api-routes/webhooks

Example JSON payload for a webhook POST request received by your application.

```json
{
   "event": "message.received",
   "data": {
     "message": {...},
     "rawEmail": ...
   }
}
```

--------------------------------

### GET /me Endpoint

Source: https://www.kurrier.org/docs/api/api-routes/me

The GET /me endpoint to retrieve authenticated user information.

```http
GET /me
```

--------------------------------

### Least-Privilege Custom IAM Policy for SES

Source: https://www.kurrier.org/docs/providers/ses

An example JSON policy that grants the minimum required access for Kurrier to interact with SES, S3, and SNS for inbound email processing.

```json
{
  "Version": "2012-10-17",
  "Statement": [
    /* ---------- SES (classic) – receipt rule sets & quotas ---------- */
    {
      "Sid": "SESClassicRulesAndQuota",
      "Effect": "Allow",
      "Action": [
        "ses:GetSendQuota",
        "ses:DescribeActiveReceiptRuleSet",
        "ses:ListReceiptRuleSets",
        "ses:CreateReceiptRuleSet",
        "ses:SetActiveReceiptRuleSet",
        "ses:DescribeReceiptRuleSet",
        "ses:CreateReceiptRule",
        "ses:UpdateReceiptRule",
        "ses:SetReceiptRulePosition",
        "ses:DeleteReceiptRule"
      ],
      "Resource": "*"
    },

    /* ---------- SESv2 – identities & sending ---------- */
    {
      "Sid": "SESv2IdentitiesAndSend",
      "Effect": "Allow",
      "Action": [
        "ses:SendEmail",                         // SESv2 send
        "ses:CreateEmailIdentity",
        "ses:GetEmailIdentity",
        "ses:DeleteEmailIdentity",
        "ses:PutEmailIdentityMailFromAttributes"
      ],
      "Resource": "*"
    },

    /* ---------- S3 – create bucket, lock it down, configure notifications ---------- */
    {
      "Sid": "S3BucketMgmtForInbound",
      "Effect": "Allow",
      "Action": [
        "s3:CreateBucket",
        "s3:HeadBucket",
        "s3:PutBucketPolicy",
        "s3:PutPublicAccessBlock",
        "s3:PutBucketNotificationConfiguration",
        "s3:ListBucket",
        "s3:GetBucketLocation"
      ],
      "Resource": [
        "arn:aws:s3:::kurrier-*-ses-inbound",
        "arn:aws:s3:::kurrier-*-ses-inbound/*"
      ]
    },

    /* ---------- SNS – create topic, set policy, subscribe Kurrier webhook ---------- */
    {
      "Sid": "SNSMgmtForInbound",
      "Effect": "Allow",
      "Action": [
        "sns:CreateTopic",
        "sns:GetTopicAttributes",
        "sns:SetTopicAttributes",
        "sns:ListSubscriptionsByTopic",
        "sns:Subscribe"
      ],
      "Resource": "*"
    },

    /* ---------- STS – used to build bucket/topic policies with your account id ---------- */
    {
      "Sid": "STSCallerIdentity",
      "Effect": "Allow",
      "Action": ["sts:GetCallerIdentity"],
      "Resource": "*"
    }
  ]
}
```

--------------------------------

### Standard Upgrade Process

Source: https://www.kurrier.org/docs/upgrading

This command sequence is used for the standard upgrade process of Kurrier.

```bash
docker compose down
git pull origin deploy
docker compose up -d
```

--------------------------------

### Upgrading from v1.0.5 and earlier

Source: https://www.kurrier.org/docs/upgrading

These commands are specific to upgrading Kurrier from version v1.0.5 and earlier, involving copying configuration directories.

```bash
cd kurrier/db
cp -r ./init/caddy/ caddy
cp -r ./init/webdav/ webdav
```

--------------------------------

### Upgrading from v0.0.91 and earlier

Source: https://www.kurrier.org/docs/upgrading

These commands are specific to upgrading Kurrier from version v0.0.91 and earlier, involving copying different configuration directories.

```bash
cd kurrier/db
cp -r ./init/dav_config/ dav_config
cp -r ./init/dav_data/ dav_data
```

--------------------------------

### Bearer Token Authentication

Source: https://www.kurrier.org/docs/api/authentication

How to include your API key in the Authorization header for authentication.

```http
Authorization: Bearer YOUR_API_KEY
```

--------------------------------

### API Base URL

Source: https://www.kurrier.org/docs/api/authentication

The base URL for all Kurrier API endpoints.

```text
https://your-domain.com/api/kurrier
```

--------------------------------

### Mailgun API Key Field

Source: https://www.kurrier.org/docs/providers/mailgun

The configuration field for the Mailgun API key in Kurrier.

```markdown
Field| Description| Example  
---|---|---  
**MAILGUN_API_KEY**|  Your private API key from the Mailgun dashboard| `key-9f6a41e71113d30cadeb28c-1ae02a08-07217cd`
```

--------------------------------

### Email Send Response

Source: https://www.kurrier.org/docs/api/api-routes/email

On success, Kurrier returns a JSON payload with a unique message id.

```json
{
  "messageId": "3c152a84-6559-4094-a1da-3f1a3209866d"
}
```
Tokens:
Raw