mirror of
https://github.com/penpot/penpot.git
synced 2025-01-08 07:50:43 -05:00
📚 Update documentation.
This commit is contained in:
parent
f72a09b698
commit
8f1b373c3d
3 changed files with 52 additions and 18 deletions
|
@ -38,10 +38,10 @@ services:
|
||||||
- 9090:9090
|
- 9090:9090
|
||||||
|
|
||||||
environment:
|
environment:
|
||||||
- APP_DATABASE_URI=postgresql://postgres/penpot
|
- PENPOT_DATABASE_URI=postgresql://postgres/penpot
|
||||||
- APP_DATABASE_USERNAME=penpot
|
- PENPOT_DATABASE_USERNAME=penpot
|
||||||
- APP_DATABASE_PASSWORD=penpot
|
- PENPOT_DATABASE_PASSWORD=penpot
|
||||||
- APP_REDIS_URI=redis://redis/0
|
- PENPOT_REDIS_URI=redis://redis/0
|
||||||
- EXTERNAL_UID=${CURRENT_USER_ID}
|
- EXTERNAL_UID=${CURRENT_USER_ID}
|
||||||
|
|
||||||
postgres:
|
postgres:
|
||||||
|
|
|
@ -145,14 +145,14 @@ application will also require configuration tweaks for make it work.
|
||||||
|
|
||||||
##### Goolge
|
##### Goolge
|
||||||
|
|
||||||
```
|
```sh
|
||||||
PENPOT_GOOGLE_CLIENT_ID=<client-id>
|
PENPOT_GOOGLE_CLIENT_ID=<client-id>
|
||||||
PENPOT_GOOGLE_CLIENT_SECRET=<client-secret>
|
PENPOT_GOOGLE_CLIENT_SECRET=<client-secret>
|
||||||
```
|
```
|
||||||
|
|
||||||
##### Gitlab
|
##### Gitlab
|
||||||
|
|
||||||
```
|
```sh
|
||||||
PENPOT_GITLAB_BASE_URI=https://gitlab.com
|
PENPOT_GITLAB_BASE_URI=https://gitlab.com
|
||||||
PENPOT_GITLAB_CLIENT_ID=<client-id>
|
PENPOT_GITLAB_CLIENT_ID=<client-id>
|
||||||
PENPOT_GITLAB_CLIENT_SECRET=<client-secret>
|
PENPOT_GITLAB_CLIENT_SECRET=<client-secret>
|
||||||
|
@ -160,22 +160,22 @@ PENPOT_GITLAB_CLIENT_SECRET=<client-secret>
|
||||||
|
|
||||||
##### Github
|
##### Github
|
||||||
|
|
||||||
```
|
```sh
|
||||||
PENPOT_GITHUB_CLIENT_ID=<client-id>
|
PENPOT_GITHUB_CLIENT_ID=<client-id>
|
||||||
PENPOT_GITHUB_CLIENT_SECRET=<client-secret>
|
PENPOT_GITHUB_CLIENT_SECRET=<client-secret>
|
||||||
```
|
```
|
||||||
|
|
||||||
##### LDAP
|
##### LDAP
|
||||||
|
|
||||||
```
|
```sh
|
||||||
PENPOT_LDAP_AUTH_HOST= (default undefined)
|
PENPOT_LDAP_AUTH_HOST=
|
||||||
PENPOT_LDAP_AUTH_PORT= (default undefined)
|
PENPOT_LDAP_AUTH_PORT=
|
||||||
PENPOT_LDAP_AUTH_VERSION=3
|
PENPOT_LDAP_AUTH_VERSION=3
|
||||||
PENPOT_LDAP_BIND_DN= (default undefined)
|
PENPOT_LDAP_BIND_DN=
|
||||||
PENPOT_LDAP_BIND_PASSWORD= (default undefined)
|
PENPOT_LDAP_BIND_PASSWORD=
|
||||||
PENPOT_LDAP_AUTH_SSL= (default false)
|
PENPOT_LDAP_AUTH_SSL=false
|
||||||
PENPOT_LDAP_AUTH_STARTTLS= (default false)
|
PENPOT_LDAP_AUTH_STARTTLS=false
|
||||||
PENPOT_LDAP_AUTH_BASE_DN= (default undefined)
|
PENPOT_LDAP_AUTH_BASE_DN=
|
||||||
PENPOT_LDAP_AUTH_USER_QUERY=(|(uid=$username)(mail=$username))
|
PENPOT_LDAP_AUTH_USER_QUERY=(|(uid=$username)(mail=$username))
|
||||||
PENPOT_LDAP_AUTH_USERNAME_ATTRIBUTE=uid
|
PENPOT_LDAP_AUTH_USERNAME_ATTRIBUTE=uid
|
||||||
PENPOT_LDAP_AUTH_EMAIL_ATTRIBUTE=mail
|
PENPOT_LDAP_AUTH_EMAIL_ATTRIBUTE=mail
|
||||||
|
@ -185,8 +185,42 @@ PENPOT_LDAP_AUTH_AVATAR_ATTRIBUTE=jpegPhoto
|
||||||
|
|
||||||
## Frontend ##
|
## Frontend ##
|
||||||
|
|
||||||
TODO
|
In comparison with backend frontend only has a few number of runtime
|
||||||
|
configuration options and are located in the
|
||||||
|
`<dist-root>/js/config.js` file. This file is completly optional; if
|
||||||
|
it exists, it is loaded by the main index.html.
|
||||||
|
|
||||||
|
The `config.js` consists in a bunch of globar variables that are read
|
||||||
|
by the frontend application on the bootstrap.
|
||||||
|
|
||||||
|
|
||||||
|
### Auth with 3rd party
|
||||||
|
|
||||||
|
If any of the following variables are defined, they will enable the
|
||||||
|
corresponding auth button in the login page
|
||||||
|
|
||||||
|
```js
|
||||||
|
var appGoogleClientID = "<google-client-id-here>";
|
||||||
|
var appGitlabClientID = "<google-client-id-here>";
|
||||||
|
var appGithubClientID = "<google-client-id-here>";
|
||||||
|
var appLoginWithLDAP = <true|false>;
|
||||||
|
```
|
||||||
|
|
||||||
|
**NOTE:** The configuration should match the backend configuration for
|
||||||
|
respective services.
|
||||||
|
|
||||||
|
|
||||||
## Exporter ##
|
## Exporter ##
|
||||||
|
|
||||||
TODO
|
The exporter application only have a single configuration option and
|
||||||
|
it can be provided using environment variables in the same way as
|
||||||
|
backend.
|
||||||
|
|
||||||
|
|
||||||
|
```sh
|
||||||
|
PENPOT_PUBLIC_URI=http://pubic-domain
|
||||||
|
```
|
||||||
|
|
||||||
|
This environment variable indicates where the exporter can access to
|
||||||
|
the public frontend application (because it uses special pages from it
|
||||||
|
to render the shapes in the underlying headless web browser).
|
||||||
|
|
|
@ -17,4 +17,4 @@
|
||||||
(js/Object.keys env)))))
|
(js/Object.keys env)))))
|
||||||
|
|
||||||
(defonce config
|
(defonce config
|
||||||
{:public-uri (:app-public-uri env "http://localhost:3449")})
|
{:public-uri (:penpot-public-uri env "http://localhost:3449")})
|
||||||
|
|
Loading…
Reference in a new issue