2020-01-27 10:08:43 -05:00
|
|
|
# Management Guide #
|
|
|
|
|
|
|
|
|
|
**TODO**
|
|
|
|
|
|
2020-04-08 03:57:29 -05:00
|
|
|
## Frontend configuration parameters ##
|
|
|
|
|
|
2020-08-18 12:40:49 -05:00
|
|
|
Not needed.
|
2020-04-08 03:57:29 -05:00
|
|
|
|
2020-01-27 10:08:43 -05:00
|
|
|
|
2020-03-08 07:41:23 -05:00
|
|
|
## Backend configuration parameters ##
|
|
|
|
|
|
2020-07-25 18:15:55 -05:00
|
|
|
Backend accepts a bunch of configuration parameters (detailed above),
|
2020-03-08 07:41:23 -05:00
|
|
|
that can be passed in different ways. The preferred one is using
|
|
|
|
|
environment variables.
|
|
|
|
|
|
2020-03-08 07:44:06 -05:00
|
|
|
This is a probably incomplete list of available options (with
|
|
|
|
|
respective defaults):
|
2020-03-08 07:41:23 -05:00
|
|
|
|
2021-01-26 16:14:27 -05:00
|
|
|
- `PENPOT_HTTP_SERVER_PORT=6060`
|
|
|
|
|
- `PENPOT_PUBLIC_URI=http://localhost:3449`
|
|
|
|
|
- `PENPOT_DATABASE_USERNAME=<username>`
|
|
|
|
|
- `PENPOT_DATABASE_PASSWORD=<password>`
|
|
|
|
|
- `PENPOT_DATABASE_URI=postgresql://127.0.0.1/penpot`
|
|
|
|
|
- `PENPOT_STORAGE_FS_DIRECTORY=resources/public/assets`
|
|
|
|
|
- `PENPOT_LOCAL_ASSETS_URI=http://localhost:6060/assets/internal`
|
|
|
|
|
- `PENPOT_SMTP_DEFAULT_REPLY_TO=no-reply@example.com`
|
|
|
|
|
- `PENPOT_SMTP_DEFAULT_FROM=no-reply@example.com`
|
|
|
|
|
- `PENPOT_SMTP_ENABLED=` (default false, prints to console)
|
|
|
|
|
- `PENPOT_SMTP_HOST=` (default undefined)
|
|
|
|
|
- `PENPOT_SMTP_PORT=` (default undefined)
|
|
|
|
|
- `PENPOT_SMTP_USER=` (default undefined)
|
|
|
|
|
- `PENPOT_SMTP_PASSWORD=` (default undefined)
|
|
|
|
|
- `PENPOT_SMTP_SSL=` (default to `false`)
|
|
|
|
|
- `PENPOT_SMTP_TLS=` (default to `false`)
|
|
|
|
|
- `PENPOT_REDIS_URI=redis://localhost/0`
|
|
|
|
|
- `PENPOT_REGISTRATION_ENABLED=true`
|
|
|
|
|
- `PENPOT_REGISTRATION_DOMAIN_WHITELIST=""` (comma-separated domains, defaults to `""` which means that all domains are allowed)
|
|
|
|
|
- `PENPOT_DEBUG=true`
|
2020-08-18 12:40:49 -05:00
|
|
|
|
2021-01-26 16:14:27 -05:00
|
|
|
- `PENPOT_LDAP_AUTH_HOST=` (default undefined)
|
|
|
|
|
- `PENPOT_LDAP_AUTH_PORT=` (default undefined)
|
|
|
|
|
- `PENPOT_LDAP_AUTH_VERSION=3`
|
|
|
|
|
- `PENPOT_LDAP_BIND_DN=` (default undefined)
|
|
|
|
|
- `PENPOT_LDAP_BIND_PASSWORD=` (default undefined)
|
|
|
|
|
- `PENPOT_LDAP_AUTH_SSL=` (default `false`)
|
|
|
|
|
- `PENPOT_LDAP_AUTH_STARTTLS=` (default `false`)
|
|
|
|
|
- `PENPOT_LDAP_AUTH_BASE_DN=` (default undefined)
|
|
|
|
|
- `PENPOT_LDAP_AUTH_USER_QUERY=(|(uid=$username)(mail=$username))`
|
|
|
|
|
- `PENPOT_LDAP_AUTH_USERNAME_ATTRIBUTE=uid`
|
|
|
|
|
- `PENPOT_LDAP_AUTH_EMAIL_ATTRIBUTE=mail`
|
|
|
|
|
- `PENPOT_LDAP_AUTH_FULLNAME_ATTRIBUTE=displayName`
|
|
|
|
|
- `PENPOT_LDAP_AUTH_AVATAR_ATTRIBUTE=jpegPhoto`
|
2020-03-08 07:41:23 -05:00
|
|
|
|
2021-01-26 16:14:27 -05:00
|
|
|
- `PENPOT_GITLAB_CLIENT_ID=` (default undefined)
|
|
|
|
|
- `PENPOT_GITLAB_CLIENT_SECRET=` (default undefined)
|
|
|
|
|
- `PENPOT_GITLAB_BASE_URI=` (default https://gitlab.com)
|
2020-08-17 08:04:21 -05:00
|
|
|
|
2021-01-26 16:14:27 -05:00
|
|
|
- `PENPOT_GITHUB_CLIENT_ID=` (default undefined)
|
|
|
|
|
- `PENPOT_GITHUB_CLIENT_SECRET=` (default undefined)
|
2020-12-02 17:31:25 -05:00
|
|
|
|
2020-04-08 06:54:30 -05:00
|
|
|
## REPL ##
|
|
|
|
|
|
|
|
|
|
The production environment by default starts a server REPL where you
|
|
|
|
|
can connect and perform diagnosis operations. For this you will need
|
|
|
|
|
`netcat` or `telnet` installed in the server.
|
|
|
|
|
|
|
|
|
|
```bash
|
2020-12-02 17:31:25 -05:00
|
|
|
$ rlwrap netcat localhost 6062
|
2020-04-08 06:54:30 -05:00
|
|
|
user=>
|
|
|
|
|
```
|
