View Source Configuration
environment-file
Environment file
All configuration used by the app is stored in the .env file. You can find an example file in .env.sample, but you should copy it to .env and fill it with your own values (described below).
storage
Storage
| Variable | Values | Default | Required | Description |
|---|---|---|---|---|
| PRESENTATION_STORAGE | local, s3 | local | - | Define where the presentation files will be stored |
| AWS_ACCESS_KEY_ID | - | - | only for s3 | Your AWS Access Key ID |
| AWS_SECRET_ACCESS_KEY | - | - | only for s3 | Your AWS Secret Access Key |
| AWS_PRES_BUCKET | - | - | only for s3 | The name of the bucket where the presentation files will be stored |
| AWS_REGION | - | - | only for s3 | The region where the bucket is located |
mail
Mail
| Variable | Values | Default | Required | Description |
|---|---|---|---|---|
| MAIL_TRANSPORT | local, smtp | local | - | Define how the emails will be sent |
| MAIL_FROM | - | Claper | - | Email address used to send emails |
| MAIL_FROM_NAME | - | noreply@claper.co | - | Name used to send emails |
| SMTP_RELAY | - | - | only for smtp | SMTP relay server |
| SMTP_USERNAME | - | - | only for smtp | SMTP username |
| SMTP_PASSWORD | - | - | only for smtp | SMTP password |
| SMTP_PORT | - | 25 | - | SMTP port |
| SMTP_TLS | always, never, if_available | always | - | SMTP TLS |
| SMTP_AUTH | always, never, if_available | always | - | SMTP Auth |
| SMTP_SSL | true, false | true | - | SMTP SSL |
| ENABLE_MAILBOX_ROUTE | true, false | false | - | Enable/disable route to local mailbox (/dev/mailbox) |
| MAILBOX_USER | - | - | - | Basic auth user for mailbox route |
| MAILBOX_PASSWORD | - | - | - | Basic auth password for mailbox route |
application
Application
| Variable | Values | Default | Required | Description |
|---|---|---|---|---|
| ENABLE_ACCOUNT_CREATION | true, false | true | - | Enable/disable user registration |
| MAX_FILE_SIZE_MB | - | 15 | - | Max file size to upload in MB |
| GS_JPG_RESOLUTION | - | 300x300 | - | Resolution (DPI) of the JPG generated from PDF, higher resolution means bigger files but better quality |
production-docker
Production / Docker
You can use all local variables plus the following:
| Variable | Values | Default | Required | Description |
|---|---|---|---|---|
| DATABASE_URL | - | - | ✓ | Postgres connection string |
| SECRET_KEY_BASE | - | - | ✓ | Generate it with mix phx.gen.secret |
| ENDPOINT_HOST | - | localhost | - | Host used to access the app (used for url generation) |
| ENDPOINT_PORT | - | 80 | - | Port used to access the app (used for url generation) |
| PORT | - | 4000 | - | Port to listen to |