diff --git a/docs/02-Frontend-Guide.md b/docs/02-Frontend-Developer-Guide.md similarity index 100% rename from docs/02-Frontend-Guide.md rename to docs/02-Frontend-Developer-Guide.md diff --git a/docs/03-Backend-Guide.md b/docs/03-Backend-Developer-Guide.md similarity index 100% rename from docs/03-Backend-Guide.md rename to docs/03-Backend-Developer-Guide.md diff --git a/docs/04-Common-Guide.md b/docs/04-Common-Developer-Guide.md similarity index 100% rename from docs/04-Common-Guide.md rename to docs/04-Common-Developer-Guide.md diff --git a/docs/05-Deployment-Guide.md b/docs/05-Deployment-Guide.md deleted file mode 100644 index 832b70a27..000000000 --- a/docs/05-Deployment-Guide.md +++ /dev/null @@ -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,...). diff --git a/docs/05-Management-Guide.md b/docs/05-Management-Guide.md new file mode 100644 index 000000000..67d2c4761 --- /dev/null +++ b/docs/05-Management-Guide.md @@ -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 +```