summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 20 insertions, 1 deletions
diff --git a/README.md b/README.md
index fd723c8..2546c5c 100644
--- a/README.md
+++ b/README.md
@@ -35,7 +35,7 @@ configure, feel free to copy
35[this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/uwsgi.config) 35[this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/uwsgi.config)
36to `/etc/uwsgi/apps-enabled/mat2-web.ini` and 36to `/etc/uwsgi/apps-enabled/mat2-web.ini` and
37[this one](https://0xacab.org/jvoisin/mat2-web/tree/master/config/nginx.config) 37[this one](https://0xacab.org/jvoisin/mat2-web/tree/master/config/nginx.config)
38to `/etc/nginx/site-enabled/mat2-web`. 38to `/etc/nginx/sites-enabled/mat2-web`.
39 39
40Nginx is the recommended web engine, but you can also use Apache if you prefer, 40Nginx is the recommended web engine, but you can also use Apache if you prefer,
41by copying [this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/apache2.config) 41by copying [this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/apache2.config)
@@ -73,6 +73,18 @@ collector cronjob to remove leftover files. Besides, it can create a
73the uploads folder, to ensure that the uploaded files won't be recoverable 73the uploads folder, to ensure that the uploaded files won't be recoverable
74between reboots. 74between reboots.
75 75
76
77# Deploy using Docker
78You can find the ready to run docker image here:
79https://0xacab.org/jvoisin/mat2-web/container_registry
80
81Example:
82`docker run -p 80:80 -d -e MAT2_ALLOW_ORIGIN_WHITELIST='https://myhost1.org' registry.0xacab.org/jvoisin/mat2-web:latest`
83
84Make sure to add
85`find /var/www/mat2-web/uploads/ -type f -mtime +1 -exec rm {} \;` as cron job
86run inside the container.
87
76# Development 88# Development
77Install docker and docker-compose and then run `docker-compose up` to setup 89Install docker and docker-compose and then run `docker-compose up` to setup
78the docker dev environment. Mat2-web is now accessible on your host machine at `localhost:5000`. 90the docker dev environment. Mat2-web is now accessible on your host machine at `localhost:5000`.
@@ -137,6 +149,13 @@ The `file` parameter is the base64 encoded file which will be cleaned.
137] 149]
138``` 150```
139 151
152# Docker
153There are two Dockerfiles present in this repository. The file called `Dockerfile.development` is used for development
154and `Dockerfile.production` is used for production deployments.
155
156You can find the automated docker builds in the registry of this
157repository: https://0xacab.org/jvoisin/mat2-web/container_registry
158
140# Custom templates 159# Custom templates
141 160
142You can override the default templates from `templates/` by putting replacements 161You can override the default templates from `templates/` by putting replacements