bewcloud/.env.sample

PORT=8000

POSTGRESQL_HOST="postgresql" # docker container name or external hostname/IP
POSTGRESQL_USER="postgres"
POSTGRESQL_PASSWORD="fake"
POSTGRESQL_DBNAME="bewcloud"
POSTGRESQL_PORT=5432
POSTGRESQL_CAFILE=""

JWT_SECRET="fake"
PASSWORD_SALT="fake"

MFA_KEY="fake" # optional, if you want to enable multi-factor authentication
MFA_SALT="fake" # optional, if you want to enable multi-factor authentication

OIDC_CLIENT_ID="fake" # optional, if you want to enable SSO (Single Sign-On)
OIDC_CLIENT_SECRET="fake" # optional, if you want to enable SSO (Single Sign-On)

SMTP_USERNAME="fake" # optional, if you want to enable signup email verification or multi-factor authentication via email
SMTP_PASSWORD="fake" # optional, if you want to enable signup email verification or multi-factor authentication via email
Make it public! 2024-03-16 08:40:24 +00:00			`PORT=8000`

Build + offer docker image and docker-compose.yml file for easier self-hosting Tweak login and auth for IP-based setups and setups without email enabled. 2024-04-09 12:22:05 +00:00			`POSTGRESQL_HOST="postgresql" # docker container name or external hostname/IP`
Make it public! 2024-03-16 08:40:24 +00:00			`POSTGRESQL_USER="postgres"`
			`POSTGRESQL_PASSWORD="fake"`
Update .env.sample 2024-03-18 08:16:30 +00:00			`POSTGRESQL_DBNAME="bewcloud"`
Make it public! 2024-03-16 08:40:24 +00:00			`POSTGRESQL_PORT=5432`
			`POSTGRESQL_CAFILE=""`

			`JWT_SECRET="fake"`
			`PASSWORD_SALT="fake"`

Add Optional 2FA Support (#61) * Add TOTP MFA Support * Add Passkey MFA Support It's not impossible I missed some minor cleanup, but most things make sense and there isn't a lot of obvious duplication anymore. --------- Co-authored-by: Bruno Bernardino <me@brunobernardino.com> 2025-05-29 16:30:28 +00:00			`MFA_KEY="fake" # optional, if you want to enable multi-factor authentication`
			`MFA_SALT="fake" # optional, if you want to enable multi-factor authentication`

Implement (optional) SSO via OIDC (OpenID Connect) (#64) This implements optional SSO via OIDC for logging in and signing up (for the first admin sign up or if sign up is allowed). The most requested feature! Tested with Authentik and Google! It includes a new `SimpleCache` interface (in-memory, using [`caches`](https://developer.mozilla.org/en-US/docs/Web/API/Window/caches)) for storing the state and code challenges. Closes #13 2025-06-05 17:10:40 +00:00			`OIDC_CLIENT_ID="fake" # optional, if you want to enable SSO (Single Sign-On)`
			`OIDC_CLIENT_SECRET="fake" # optional, if you want to enable SSO (Single Sign-On)`

Migrate email provider (from Brevo to generic SMTP) (#67) This means we now need to have the text and HTML content set in the code, which is arguably better. In order to avoid allowing legacy Brevo API Key support, this will also introduce breaking changes and will be released as v2.0.0. I took the opportunity to remove a few deprecated things (like legacy ENV-based config), upgrade PostgreSQL, and pin a specific version in `docker-compose.yml`, since I don't plan to do breaking releases anytime soon, and upgrading PostgreSQL should be fine from now on if the version is pinned. If you were using Brevo with an API Key, they support SMTP as well, just update your config. If you were using ENV-based config, check `bewcloud.config.sample.ts`to create your `bewcloud.config.ts`. If you need help upgrading you PostgreSQL container, I've written a simple guide [step-by-step guide](https://news.onbrn.com/step-by-step-guide-upgrading-postgresql-docker-containers/). 2025-06-10 09:28:13 +00:00			`SMTP_USERNAME="fake" # optional, if you want to enable signup email verification or multi-factor authentication via email`
			`SMTP_PASSWORD="fake" # optional, if you want to enable signup email verification or multi-factor authentication via email`