1# auth-boilerplate
 2
 3This web-app features:
 4* a working folder-based file structure,
 5* a basic authentication service,
 6* a basic SMTP implementation,
 7* a Dockerfile for convenience,
 8* a GitHub workflow to create packages.
 9
10
11## Environment
12
13All environment variables are optional, but some features might be disabled depending on what you have set.
14
15* `APP_PORT`: defaults to `3000`.
16* `APP_BASE_URL`: defaults to `http://localhost:<port>`.
17* `APP_PEPPER`: random string, used for password hashing.
18* `APP_REGISTRATION_ENABLED`: defaults to `true`.
19* `APP_SMTP_EMAIL`: email address you want to send mails from.
20* `APP_SMTP_PASSWORD`: password for said email address.
21* `APP_SMTP_HOST`: host for the SMTP server.
22* `APP_SMTP_PORT`: port for the SMTP server.
23
24This application also looks for a `.env` file in the current directory.
25
26
27## License
28
29auth-boilerplate is licensed under MIT.