From 904f0f78be421c400fdb7d37599435b7c334e027 Mon Sep 17 00:00:00 2001 From: Saverio Trioni <476895+rewritten@users.noreply.github.com> Date: Thu, 26 Mar 2026 14:00:27 +0100 Subject: [PATCH] docs: document missing ENV variables for mailing and assets (fixes #827) Co-Authored-By: Claude Sonnet 4.6 --- .env.example | 1 + README.md | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.env.example b/.env.example index af728a53..93252879 100644 --- a/.env.example +++ b/.env.example @@ -22,6 +22,7 @@ MAIL_LINK_HOST=localhost:3000 MAIL_LINK_PROTO=http # Email provider +MAILER_SENDER=noreply@timeoverflow.org SMTP_PASSWORD=XXXXXXXX SMTP_DOMAIN=www.timeoverflow.org SMTP_USER_NAME=my_username@timeoverflow.org diff --git a/README.md b/README.md index a8b39b8d..7b7ccfa0 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,8 @@ In order to configure the application you can use the following ENV variables: | `SECRET_KEY_BASE` | Secret key for the application, generate a new one with the command `rails secret` | | | `DATABASE_URL` | Database URL, the format is `postgresql://user:password@host:port/database` | | | `RAILS_SERVE_STATIC_FILES` | Tell the application to serve static files (you might want to turn this off if you are using an external web server to serve files from the `public` folder) | `true` | +| `RAILS_ASSET_HOST` | CDN or external host to serve assets from (ie: `cdn.mydomain.tld`) | | +| `ASSETS_PRECOMPILE` | Set to `true` to enable asset precompilation with compression during startup | | | `RAILS_LOG_TO_STDOUT` | Tell the application to log to STDOUT (useful for Docker) | `true` | | `RAILS_LOG_LEVEL` | Log level for the application (use `debug` for maximum information) | `info` | | `RAILS_MAX_THREADS` | Maximum number of threads to use in the application (use `1` if multithreading is not desired) | `5` | @@ -83,7 +85,8 @@ In order to configure the application you can use the following ENV variables: | `STORAGE_PROVIDER` | Storage provider for the application (currently the application supports `local` and `amazon`) | `amazon` | | `FORCE_SSL` | Force SSL connections | `false` | | `MAIL_LINK_HOST` | Host to use in the links sent by email (use your domain without protocol `mydomain.tld`) | | -| `MAIL_LINK_PROTOCOL` | Protocol to use in the previous host defined for links sent by email | `https` | +| `MAIL_LINK_PROTO` | Protocol to use in the previous host defined for links sent by email | `https` | +| `MAILER_SENDER` | Email address used as the sender for Devise emails (ie: `noreply@mydomain.tld`) | `please-change-me-at-config-initializers-devise@example.com` | | `SMTP_ADDRESS` | SMTP server address (ie: `smtp.mailgun.org`) | | | `SMTP_PORT` | SMTP server port (ie: `587`) | | | `SMTP_DOMAIN` | SMTP domain (usually the application's domain) | |