Penpot/penpot
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2025-01-06 14:50:20 -05:00
Code Issues Activity

📚 Minor update on docs.

Browse source
This commit is contained in:
Andrey Antukh 2020-06-23 14:00:16 +02:00
parent cfaf09a5c1
commit 41c6917260
2 changed files with 20 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/03-Backend-Developer-Guide.md
View file

@ -7,8 +7,8 @@ application.
## Fixtures ##
This is a development feature that allows populate the database with a
good amount of random content (usually used for just test the
application or perform performance tweaks on queries).
good amount of content (usually used for just test the application or
perform performance tweaks on queries).
In order to load fixtures, enter to the REPL environment executing the
`bin/repl` script, and then execute `(uxbox.fixtures/run :small)`.
@ -30,15 +30,10 @@ in the aplication. All users uses the following pattern:
Where `N` is a number from 0 to 49 on the default fixture parameters.
If you have a REPL access to the running process, you can execute it
from there:
## Sample media ##
There is also a media collection with some libraries (material design
icons and some colors). It may be loaded with:
```bash
clojure -Adev -m uxbox.media-loader ../sample_media/config.edn
```clojure
(require 'uxbox.fixtures)
(uxbox.fixtures/run :small)
```
You have more information at 05-Management-Guide.md document.

27
docs/05-Management-Guide.md
View file

@ -6,9 +6,8 @@
**Only available at build time!**
- `-e UXBOX_PUBLIC_URL=...` (defaults to `http://localhost:6060`)
- `-e UXBOX_PUBLIC_URI=...` (defaults to `http://localhost:6060`)
- `-e UXBOX_DEMO_WARNING=...` (defaults to `true`)
- `-e UXBOX_THEME=...` (defaults to `light`, accepts `dark` to enable UXBOX dark theme)
## Backend configuration parameters ##
@ -21,23 +20,23 @@ 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_PUBLIC_URI=http://localhost:3449/`
- `UXBOX_DATABASE_USERNAME=` (default undefined, used from uri)
- `UXBOX_DATABASE_PASSWORD=` (default undefined, 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_SENDMAIL_BACKEND=console`
- `UXBOX_SENDMAIL_REPLY_TO=no-reply@nodomain.com`
- `UXBOX_SENDMAIL_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_SMTP_PORT=` (default undefined)
- `UXBOX_SMTP_USER=` (default undefined)
- `UXBOX_SMTP_PASSWORD=` (default undefined)
- `UXBOX_SMTP_SSL=` (default to `false`)
- `UXBOX_SMTP_TLS=` (default to `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`
@ -55,7 +54,7 @@ user=>
```
## Collections import ##
## Import collections ##
This is the way we can preload default collections of images and icons to the
running platform.