Skip to content

docs: document missing ENV variables for mailing and assets #833

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rewritten wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: document missing ENV variables for mailing and assets #833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand All @@ -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) | |
Expand Down
Loading