mirror of
https://github.com/penpot/penpot.git
synced 2025-01-10 00:40:30 -05:00
66 lines
2 KiB
Markdown
66 lines
2 KiB
Markdown
# Management Guide #
|
|
|
|
**TODO**
|
|
|
|
|
|
## Backend configuration parameters ##
|
|
|
|
Backend accepts a bunch of configuration parameters (detailed abowe),
|
|
that can be passed in different ways. The preferred one is using
|
|
environment variables.
|
|
|
|
|
|
This is a probably incomplete list of available options (with
|
|
respective defaults):
|
|
|
|
- `UXBOX_HTTP_SERVER_PORT=6060`
|
|
- `UXBOX_HTTP_SERVER_CORS=http://localhost:3449`
|
|
- `UXBOX_DATABASE_USERNAME=` (not defined, used from uri)
|
|
- `UXBOX_DATABASE_PASSWORD=` (not defined, used from uri)
|
|
- `UXBOX_DATABASE_URI=postgresql://127.0.0.1/uxbox`
|
|
- `UXBOX_MEDIA_DIRECTORY=resources/public/media`
|
|
- `UXBOX_MEDIA_URI=http://localhost:6060/media/`
|
|
- `UXBOX_ASSETS_DIRECTORY=resources/public/static`
|
|
- `UXBOX_ASSETS_URI=ehttp://localhost:6060/static/`
|
|
- `UXBOX_EMAIL_REPLY_TO=no-reply@nodomain.com`
|
|
- `UXBOX_EMAIL_FROM=no-reply@nodomain.com`
|
|
- `UXBOX_SMTP_HOST=` (default undefined)
|
|
- `UXBOX_SMTP_PORT=` (defaults undefined)
|
|
- `UXBOX_SMTP_USER=` (defaults undefined)
|
|
- `UXBOX_SMTP_PASSWORD=` (defaults undefined)
|
|
- `UXBOX_SMTP_SSL=` (defaults to `false`)
|
|
- `UXBOX_SMTP_TLS=` (defaults to `false`)
|
|
- `UXBOX_SMTP_ENABLED=false`
|
|
- `UXBOX_REGISTRATION_ENABLED=true`
|
|
- `UXBOX_REGISTRATION_DOMAIN_WHITELIST=""` (comma-separated domains, defaults to `""` which means that all domains are allowed)
|
|
- `UXBOX_DEBUG_HUMANIZE_TRANSIT=true`
|
|
|
|
|
|
## Collections import ##
|
|
|
|
This is the way we can preload default collections of images and icons to the
|
|
running platform.
|
|
|
|
First of that, you need to have a configuration file (edn format) like
|
|
this:
|
|
|
|
```clojure
|
|
{:icons
|
|
[{:name "Generic Icons 1"
|
|
:path "./icons/my-icons-collection/"
|
|
:regex #"^.*_48px\.svg$"}
|
|
]
|
|
:images
|
|
[{:name "Generic Images 1"
|
|
:path "./images/my-images-collection/"
|
|
:regex #"^.*\.(png|jpg|webp)$"}]}
|
|
```
|
|
|
|
You can found a real example in `sample_media/config.edn` (that also
|
|
has all the material design icon collections).
|
|
|
|
Then, you need to execute:
|
|
|
|
```bash
|
|
clojure -Adev -m uxbox.media-loader ../path/to/config.edn
|
|
```
|