2022-07-28 15:54:20 +02:00
# Configuration
2022-07-28 14:51:22 +02:00
## 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).
2022-09-05 21:27:02 +02:00
### Storage
2022-07-28 14:51:22 +02:00
Variable | Values | Default | Required | Description
--- | --- | --- | --- | ---
PRESENTATION_STORAGE | local, s3 | local | - | Define where the presentation files will be stored
2023-09-23 14:05:23 +02:00
PRESENTATION_STORAGE_DIR | - | priv/static (/app/uploads for Docker) | - | If `local` storage is used, this is the directory where the presentation files will be stored. Compile-time config, so you need to recompile the app if you change it (or rebuild the Docker image).
2022-07-28 14:51:22 +02:00
AWS_ACCESS_KEY_ID | - | - | _ only for s3 _ | Your AWS Access Key ID
AWS_SECRET_ACCESS_KEY | - | - | _ only for s3 _ | Your AWS Secret Access Key
2022-12-01 14:16:18 +01:00
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
2022-09-05 21:27:02 +02:00
### Mail
Variable | Values | Default | Required | Description
--- | --- | --- | --- | ---
2022-07-29 11:35:36 +02:00
MAIL_TRANSPORT | local, smtp | local | - | Define how the emails will be sent
2022-07-28 14:51:22 +02:00
MAIL_FROM | - | Claper | - | Email address used to send emails
MAIL_FROM_NAME | - | noreply@claper .co | - | Name used to send emails
2022-09-05 21:27:02 +02:00
SMTP_RELAY | - | - | _ only for smtp _ | SMTP relay server
SMTP_USERNAME | - | - | _ only for smtp _ | SMTP username
SMTP_PASSWORD | - | - | _ only for smtp _ | SMTP password
2022-07-29 11:35:36 +02:00
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
2022-09-05 21:27:02 +02:00
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
Variable | Values | Default | Required | Description
--- | --- | --- | --- | ---
2022-09-05 12:31:18 +02:00
ENABLE_ACCOUNT_CREATION | true, false | true | - | Enable/disable user registration
2023-04-21 12:46:43 +02:00
MAX_FILE_SIZE_MB | - | 15 | - | Max file size to upload in MB
2023-07-02 11:04:07 +02:00
GS_JPG_RESOLUTION | - | 300x300 | - | Resolution (DPI) of the JPG generated from PDF, higher resolution means bigger files but better quality
2022-07-28 14:51:22 +02:00
## Production / Docker
You can use all local variables plus the following:
Variable | Values | Default | Required | Description
--- | --- | --- | --- | ---
DATABASE_URL | - | - | ✓ | Postgres connection string
2022-07-29 12:14:43 +02:00
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)
2022-07-30 16:41:06 +02:00
PORT | - | 4000 | - | Port to listen to