0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2025-01-08 07:50:43 -05:00

📚 Minor organization improvement on docs directory.

This commit is contained in:
Andrey Antukh 2020-01-27 16:08:43 +01:00
parent 47ab946f81
commit 121d300cf7
5 changed files with 33 additions and 39 deletions

View file

@ -1,39 +0,0 @@
# Deployment Guide #
This document don't intend to be a complete guide of deployment. It
will only contain the essential tips for doing it and show an example
on how we are deploying it using docker and docker-compose.
## Docker Images ##
For build the production images, you need to execute the following
command:
```bash
./manage.sh build-images`
```
This command will build the following images:
- `uxbox-frontend:latest`
- `uxbox-frontend-dbg:latest` (with debug ready frontend build)
- `uxbox-backend:latest`
Complementary to the docker images you can build locally from this
repository, you can find additionnal flavors for backend and frontend
on external repositories:
* [Monogramm/docker-uxbox-frontend](https://github.com/Monogramm/docker-uxbox-frontend)
* [Monogramm/docker-uxbox-backend](https://github.com/Monogramm/docker-uxbox-backend)
## Docker Compose ##
Look at `docker/docker-compose.yml` for a complete example.
## SSL/TLS ##
The default images does not handles anything realted to ssl. They are
intended to be deployed behind a proxy (nginx,haproxy,...).

View file

@ -0,0 +1,33 @@
# Management Guide #
**TODO**
## 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
```