roundcube/README.md

102 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2024-04-26 20:08:57 +00:00
[Roundcube](https://roundcube.net/) webmail interface with postgres backend and
oauth login.
2016-10-28 13:43:44 +00:00
2016-10-31 10:13:03 +00:00
# Environment Variables
2024-04-26 20:08:57 +00:00
2017-10-06 16:27:06 +00:00
## DOMAINS
2024-04-26 20:08:57 +00:00
2017-10-06 16:27:06 +00:00
Semicolon seperated list of domains to listen to.
2016-10-28 13:43:44 +00:00
2016-10-31 10:13:03 +00:00
## DB_USER
2024-04-26 20:08:57 +00:00
2016-10-28 13:43:44 +00:00
Name of the database user.
2016-10-31 10:13:03 +00:00
## DB_PASSWORD
2024-04-26 20:08:57 +00:00
2016-10-28 13:43:44 +00:00
Password for the database user.
2016-10-31 10:13:03 +00:00
## DB_HOST
2024-04-26 20:08:57 +00:00
2016-10-28 13:43:44 +00:00
Database host.
2016-10-31 10:13:03 +00:00
## DB_NAME
2024-04-26 20:08:57 +00:00
2016-10-28 13:43:44 +00:00
Database name.
2016-10-31 10:13:03 +00:00
## IMAP_HOST
2024-04-26 20:08:57 +00:00
2016-10-28 13:43:44 +00:00
- default: tls://%n
IMAP host to authenticate users against.
2016-10-31 10:13:03 +00:00
## SMTP_HOST
2024-04-26 20:08:57 +00:00
2016-10-28 13:43:44 +00:00
- default: tls://%n
SMTP host for sending mails.
2016-10-31 10:13:03 +00:00
## SMTP_PORT
2024-04-26 20:08:57 +00:00
2016-10-28 13:43:44 +00:00
- default: 587
Port for the SMTP host.
2016-10-31 10:13:03 +00:00
## SECRET_KEY
2024-04-26 20:08:57 +00:00
2016-10-28 13:43:44 +00:00
Secret key for session secrets.
2016-10-31 10:13:03 +00:00
## CIPHER_METHOD
2024-04-26 20:08:57 +00:00
2016-10-28 13:43:44 +00:00
- default: AES-256-CBC
Encryption algorithm for session secrets.
2022-03-14 09:02:16 +00:00
## OAUTH_PROVIDER_NAME
2024-04-26 20:08:57 +00:00
2022-03-14 09:02:16 +00:00
Name of the oauth provider on the roundcube login page.
## OAUTH_CLIENT_ID
2024-04-26 20:08:57 +00:00
2022-03-14 09:02:16 +00:00
Client id for oauth login.
## OAUTH_CLIENT_SECRET
2024-04-26 20:08:57 +00:00
2022-03-14 09:02:16 +00:00
Client secret for oauth login.
## OAUTH_AUTH_URI
2024-04-26 20:08:57 +00:00
2022-03-14 09:02:16 +00:00
Auth uri for oauth login.
2024-04-26 20:08:57 +00:00
Example for keycloak:
`https://example.com/realms/master/protocol/openid-connect/auth`
2022-03-14 09:02:16 +00:00
## OAUTH_TOKEN_URI
2024-04-26 20:08:57 +00:00
2022-03-14 09:02:16 +00:00
Token uri for oauth login.
2024-04-26 20:08:57 +00:00
Example for keycloak:
`https://example.com/realms/master/protocol/openid-connect/token`
2022-03-14 09:02:16 +00:00
## OAUTH_IDENTITY_URI
2024-04-26 20:08:57 +00:00
2022-03-14 09:02:16 +00:00
Userinfo uri for oauth login.
2024-04-26 20:08:57 +00:00
Example for keycloak:
`https://example.com/realms/master/protocol/openid-connect/userinfo`
## MANAGESIEVE_HOST
2022-03-14 09:02:16 +00:00
2024-04-26 20:08:57 +00:00
Where to connect to managesieve.
2019-06-21 11:58:29 +00:00
2016-10-31 10:13:03 +00:00
# Ports
2024-04-26 20:08:57 +00:00
2016-10-28 13:43:44 +00:00
- 80
2016-10-31 10:13:03 +00:00
# Capabilities
2024-04-26 20:08:57 +00:00
2016-10-28 14:24:42 +00:00
- CHOWN
2016-10-28 13:43:44 +00:00
- DAC_OVERRIDE
- NET_BIND_SERVICE
- SETGID
- SETUID