planka/server/.env.sample

## Required

BASE_URL=http://localhost:1337
DATABASE_URL=postgresql://postgres@localhost/planka
SECRET_KEY=notsecretkey

## Optional

# TRUST_PROXY=0
# TOKEN_EXPIRES_IN=365 # In days

# related: https://github.com/knex/knex/issues/2354
# As knex does not pass query parameters from the connection string we
# have to use environment variables in order to pass the desired values, e.g.
# PGSSLMODE=<value>

# Configure knex to accept SSL certificates
# KNEX_REJECT_UNAUTHORIZED_SSL_CERTIFICATE=false

# DEFAULT_ADMIN_EMAIL=demo@demo.demo # Do not remove if you want to prevent this user from being edited/deleted
# DEFAULT_ADMIN_PASSWORD=demo
# DEFAULT_ADMIN_NAME=Demo Demo
# DEFAULT_ADMIN_USERNAME=demo

# OIDC_ISSUER=
# OIDC_CLIENT_ID=
# OIDC_CLIENT_SECRET=
# OIDC_SCOPES=openid email profile
# OIDC_ADMIN_ROLES=admin
# OIDC_ROLES_ATTRIBUTE=groups

## Do not edit this

TZ=UTC
ref: Prettify env sample 2022-08-09 19:17:19 +02:00			`## Required`

Initial commit 2019-08-31 04:07:25 +05:00			`BASE_URL=http://localhost:1337`
Fix linting errors, fix default database url. Closes #193 2021-12-30 00:28:27 +05:00			`DATABASE_URL=postgresql://postgres@localhost/planka`
Add secret key to environment variables, update readme 2019-10-04 04:19:46 +05:00			`SECRET_KEY=notsecretkey`
feat: Improve security of access tokens (#279) Closes #275 2022-08-09 18:03:21 +02:00
ref: Prettify env sample 2022-08-09 19:17:19 +02:00			`## Optional`

			`# TRUST_PROXY=0`
			`# TOKEN_EXPIRES_IN=365 # In days`

feat: Allow postgres connections that require ssl mode (#409) Closes #261 2023-03-06 13:54:52 +01:00			`# related: https://github.com/knex/knex/issues/2354`
			`# As knex does not pass query parameters from the connection string we`
			`# have to use environment variables in order to pass the desired values, e.g.`
			`# PGSSLMODE=<value>`

			`# Configure knex to accept SSL certificates`
			`# KNEX_REJECT_UNAUTHORIZED_SSL_CERTIFICATE=false`

fix: Make default admin environment variables optional Closes #526 2023-10-20 21:52:12 +02:00			`# DEFAULT_ADMIN_EMAIL=demo@demo.demo # Do not remove if you want to prevent this user from being edited/deleted`
			`# DEFAULT_ADMIN_PASSWORD=demo`
			`# DEFAULT_ADMIN_NAME=Demo Demo`
			`# DEFAULT_ADMIN_USERNAME=demo`

fix: OIDC finalization and refactoring 2023-10-17 19:18:19 +02:00			`# OIDC_ISSUER=`
			`# OIDC_CLIENT_ID=`
feat: Improve OIDC SSO (#524) The OIDC implementation merged in https://github.com/plankanban/planka/pull/491 is flawed for multiple reasons. It assumes that the access_token returned by the IDP has to be a JWT parseable by the RP which is not the case [1]. Many major IDPs do issue tokens which are not JWTs and RPs should not rely on the contents of these at all. The only signed token which has a standardized format for direct RP consumption is the OIDC ID token (id_token), but this by default doesn't contain many claims, especially role claims are omitted from them by default for size reasons. To get these additional claims into the ID token, one needs an IDP with support for the "claims" parameter. It requires manual specification of the JWKS URL which is mandatory in any OIDC discovery document and thus never needs to be manually specified. It also makes the questionable decision to use a client-side code flow with PKCE where a normal code flow would be much more appropriate as all user data is processed in the backend which can securely hold a client secret (confidential client). This has far wider IDP support, is safer (due to direct involvement of the IDP in obtaining user information) and doesn't require working with ID tokens and claim parameters. By using a server-side code flow we can also offload most complexity to the server alone, no longer requiring an additional OIDC library on the web client. Also silent logout doesn't work on most IDPs for security reasons, one needs to actually redirect the user over to the IDP, which then prompts them once more if they actually want to log out. This implementation should work with any OIDC-compliant IDP and even OAuth 2.0-only IDPs as long as they serve and OIDC discovery document. [1] rfc-editor.org/rfc/rfc6749#section-5.1 2023-10-19 14:39:21 +02:00			`# OIDC_CLIENT_SECRET=`
fix: OIDC finalization and refactoring 2023-10-17 19:18:19 +02:00			`# OIDC_SCOPES=openid email profile`
			`# OIDC_ADMIN_ROLES=admin`
			`# OIDC_ROLES_ATTRIBUTE=groups`

ref: Prettify env sample 2022-08-09 19:17:19 +02:00			`## Do not edit this`
feat: Improve security of access tokens (#279) Closes #275 2022-08-09 18:03:21 +02:00
			`TZ=UTC`