KM Koushik
04d0f4b123
* feat: support standard AWS env vars and default credential chain Replace non-standard AWS_ACCESS_KEY / AWS_SECRET_KEY with the AWS-standard AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY. The old names are kept as fallbacks in the runtimeEnv for backward compatibility. Both vars are now optional. When omitted, the credentials object is not passed to SESv2Client, STSClient, or SNSClient — the AWS SDK then falls back to its default provider chain (IAM roles, ECS task roles, instance profiles, etc.), which is the recommended approach for cloud-native deployments. Closes #316 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * refactor: extract shared getAwsCredentialOptions helper and add partial-config guard - Move the credential spread logic into a single credentials.ts helper so SESv2Client, STSClient, and SNSClient all share one implementation - Throw a clear error if only one of AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY is set, preventing silent fallback to the default provider chain with a half-configured environment Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: align AWS env vars in docker and docs * fix: use alias import for AWS credentials helper --------- Co-authored-by: purva <purvahk08@gmail.com> Co-authored-by: Purva Kandalgaonkar <136103488+purva-8@users.noreply.github.com>
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_ID="<your-aws-access-key-id>" \
|
|
-e AWS_SECRET_ACCESS_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.
|