Michał Ordon
62d7c44efc
* feat: add REDIS_KEY_PREFIX env var for Redis ACL namespace isolation Adds optional REDIS_KEY_PREFIX env var that prefixes all Redis keys (BullMQ queues via `prefix` option, cache/lock/rate-limit keys via `redisKey()` helper). When unset, behavior is unchanged (BullMQ defaults to "bull:", cache keys are unprefixed). This enables self-hosters using Redis ACL multi-tenancy to restrict useSend to its own key namespace (e.g. `~usesend:*`). 16 files changed across env schema, Redis module, 9 BullMQ queue/worker files, and 5 direct Redis key operation sites. * docs: add REDIS_KEY_PREFIX to self-host assets and fix docker run example Add REDIS_KEY_PREFIX env var to docker/prod/compose.yml, .env.example, .env.selfhost.example, and self-hosting docs. Fix missing trailing backslashes in standalone docker run example. * fix(redis): disable ioredis ready check and BullMQ version check Redis ACL blocks INFO command (in @dangerous category). ioredis uses INFO for ready check, BullMQ uses it for version detection. Without these flags, BullMQ workers fail to initialize and silently stop processing jobs. - Add enableReadyCheck: false to ioredis connection - Add skipVersionCheck: true to all 5 Queue + 5 Worker constructors * fix(redis): add skipVersionCheck to remaining BullMQ job queues Add skipVersionCheck: true to Queue and Worker constructors in all 4 job files (campaign-scheduler, cleanup-email-bodies, usage-job, webhook-cleanup) to match the pattern already used in service files. This prevents BullMQ version mismatch errors when using REDIS_KEY_PREFIX with Redis ACL namespace isolation.
70 lines
2.5 KiB
Markdown
70 lines
2.5 KiB
Markdown
# Docker Setup for useSend
|
|
|
|
The following guide will walk you through setting up useSend using Docker. You can choose between a production setup using Docker Compose or a standalone container.
|
|
|
|
## Prerequisites
|
|
|
|
Before you begin, ensure that you have the following installed:
|
|
|
|
- Docker
|
|
- Docker Compose (if using the Docker Compose setup)
|
|
- Node.js 20.19 or newer (Prisma requires at least v20.19 in the build image)
|
|
|
|
## Option 1: Production Docker Compose Setup
|
|
|
|
This setup includes PostgreSQL, Redis and the useSend application.
|
|
|
|
1. Download the Docker Compose file from the useSend repository: [compose.yml](https://github.com/usesend/usesend/blob/main/docker/prod/compose.yml)
|
|
2. Navigate to the directory containing the `compose.yml` file.
|
|
3. Create a `.env` file in the same directory. Copy the contents of `.env.selfhost.example`
|
|
4. Run the following command to start the containers:
|
|
|
|
```
|
|
docker-compose --env-file ./.env up -d
|
|
```
|
|
|
|
This will start the PostgreSQL database, Redis and the useSend application containers.
|
|
|
|
5. Access the useSend application by visiting `http://localhost:3000` in your web browser.
|
|
|
|
## Option 2: Standalone Docker Container
|
|
|
|
If you prefer to host the useSend application on your container provider of choice, you can use the pre-built Docker image from DockerHub or GitHub's Package Registry. Note that you will need to provide your own database and SMTP host.
|
|
|
|
1. Pull the useSend Docker image:
|
|
|
|
```
|
|
docker pull usesend/usesend
|
|
```
|
|
|
|
Or, if using GitHub's Package Registry:
|
|
|
|
```
|
|
docker pull ghcr.io/usesend/usesend
|
|
```
|
|
|
|
2. Run the Docker container, providing the necessary environment variables for your database and SMTP host:
|
|
|
|
```
|
|
docker run -d \
|
|
-p 3000:3000 \
|
|
-e NEXTAUTH_URL="<your-nextauth-url>" \
|
|
-e NEXTAUTH_SECRET="<your-nextauth-secret>" \
|
|
-e DATABASE_URL="<your-database-url>" \
|
|
-e REDIS_URL="<your-redis-url>" \
|
|
-e AWS_ACCESS_KEY="<your-aws-access-key-id>" \
|
|
-e AWS_SECRET_KEY="<your-aws-secret-access-key>" \
|
|
-e AWS_DEFAULT_REGION="<your-aws-region>" \
|
|
-e GITHUB_ID="<your-github-client-id>" \
|
|
-e GITHUB_SECRET="<your-github-client-secret>" \
|
|
usesend/usesend
|
|
```
|
|
|
|
Replace the placeholders with your actual database and aws details.
|
|
|
|
1. Access the useSend application by visiting the URL you provided in the `NEXTAUTH_URL` environment variable in your web browser.
|
|
|
|
## Success
|
|
|
|
You have now successfully set up useSend using Docker. You can start sending emails efficiently. If you encounter any issues or have further questions, please refer to the official useSend documentation or seek assistance from the community.
|