Self-hosted email delivery platform that enables applications to send emails via HTTP APIs while handling SMTP delivery, templates, storage, security, and analytics. Fully self-hostable alternative to services like SendGrid or Mailgun.
Go email-relayemail-routinghttp-to-smtpmail-deliverymailchimp-alternativemailgun-alternativemailsendermailservermailtemplatemailtestpostmark-alternativesend-emailsendgrid-alternativesendmailtransactional-emailtransactional-outbox
chore: comment .env.example
Jonas Kaninda72a8d4ca2443
diff --git a/.env.example b/.env.exampleindex 2161bec..b472794 100644--- a/.env.example+++ b/.env.example@@ -1,4 +1,7 @@+# Server+# HTTP server portPOSTA_PORT=9000+# Database (PostgreSQL)POSTA_DB_HOST=localhostPOSTA_DB_USER=postaPOSTA_DB_PASSWORD=posta@@ -7,23 +10,47 @@ POSTA_DB_PORT=5432POSTA_DB_SSL_MODE=disable# PostgreSQL connection string (overrides individual DB settings)POSTA_DB_URL=+# RedisPOSTA_REDIS_ADDR=localhost:6379POSTA_REDIS_PASSWORD=++# JWT signing secret — change this in production!POSTA_JWT_SECRET=change-me-in-production++# Store emails without sending (useful for development)POSTA_DEV_MODE=false+# Hourly email limit per userPOSTA_RATE_LIMIT_HOURLY=100+# Daily email limit per userPOSTA_RATE_LIMIT_DAILY=1000++# Default admin credentialsPOSTA_ADMIN_PASSWORD=admin1234++# Enable Swagger UI and ReDocPOSTA_OPENAPI_DOCS=true++# Enable Prometheus metricsPOSTA_METRICS_ENABLED=false-# POSTA_WEB_DIR=web/dist # For develoment++# Vue build directory (uncomment for development)+# POSTA_WEB_DIR=web/dist+# Public URLPOSTA_WEB_URL=https://posta.example.com+# Allowed CORS originsPOSTA_CORS_ORIGINS=*++# Worker+# Run worker in server processPOSTA_EMBEDDED_WORKER=false+# Worker concurrencyPOSTA_WORKER_CONCURRENCY=10+# Email retry attemptsPOSTA_WORKER_MAX_RETRIES=5++# Webhook delivery retry attemptsPOSTA_WEBHOOK_MAX_RETRIES=3+# Webhook request timeout in secondsPOSTA_WEBHOOK_TIMEOUT_SECS=10POSTA_ENV=production-diff --git a/README.md b/README.mdindex f3172fe..14d7a86 100644--- a/README.md+++ b/README.md@@ -1,7 +1,7 @@# Posta<p align="center">- <img src="logo.png" alt="Posta" width="120" />+ <img src="https://raw.githubusercontent.com/jkaninda/posta/main/logo.png" alt="Posta" width="150" /></p>[](https://github.com/jkaninda/posta/actions/workflows/ci.yml)@@ -16,26 +16,6 @@It provides a developer-friendly and fully self-hostable alternative to services such as SendGrid, and Mailgun.------# Why Posta--Posta provides a complete email delivery platform that you can run in your own infrastructure.--* HTTP API for sending emails-* Template engine with versioning and localization-* Background job processing with Redis and Asynq-* Multiple SMTP servers and shared SMTP pools-* Domain verification with SPF, DKIM, and DMARC checks-* Contact management and bounce suppression-* Webhooks and event streaming-* Prometheus metrics and health probes-* Admin dashboard and API documentation--Posta is designed for developers who want full control over their email infrastructure without relying on third-party services.------# Send Your First EmailExample request:@@ -286,41 +266,6 @@ Email: [email protected]Password: admin1234```------# Configuration--Configuration is provided through environment variables.--| Variable | Default | Description |-| -------------------------- | ----------------------- | ------------------------------------ |-| POSTA_PORT | 9000 | HTTP server port |-| POSTA_DB_HOST | localhost | PostgreSQL host |-| POSTA_DB_USER | posta | PostgreSQL user |-| POSTA_DB_PASSWORD | posta | PostgreSQL password |-| POSTA_DB_NAME | posta | PostgreSQL database name |-| POSTA_DB_PORT | 5432 | PostgreSQL port |-| POSTA_DB_SSL_MODE | disable | PostgreSQL SSL mode |-| POSTA_DB_URL | | PostgreSQL connection string (overrides individual DB settings) |-| POSTA_REDIS_ADDR | localhost:6379 | Redis address |-| POSTA_REDIS_PASSWORD | | Redis password |-| POSTA_JWT_SECRET | change-me-in-production | JWT signing secret |-| POSTA_DEV_MODE | false | Store emails without sending |-| POSTA_RATE_LIMIT_HOURLY | 100 | Hourly email limit per user |-| POSTA_RATE_LIMIT_DAILY | 1000 | Daily email limit per user |-| POSTA_ADMIN_EMAIL | [email protected] | Default admin email |-| POSTA_ADMIN_PASSWORD | admin1234 | Default admin password |-| POSTA_OPENAPI_DOCS | true | Enable Swagger UI and ReDoc |-| POSTA_METRICS_ENABLED | false | Enable Prometheus metrics |-| POSTA_WEB_DIR | web/dist | Vue build directory |-| POSTA_WEB_URL | | Public URL |-| POSTA_CORS_ORIGINS | * | Allowed CORS origins (comma-separated) |-| POSTA_EMBEDDED_WORKER | false | Run worker in server process |-| POSTA_WORKER_CONCURRENCY | 10 | Worker concurrency |-| POSTA_WORKER_MAX_RETRIES | 5 | Email retry attempts |-| POSTA_WEBHOOK_MAX_RETRIES | 3 | Webhook delivery retry attempts |-| POSTA_WEBHOOK_TIMEOUT_SECS | 10 | Webhook request timeout in seconds |----# Dashboard