summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 11 insertions, 9 deletions
diff --git a/README.md b/README.md
index a10f558..22ff44d 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,12 @@ serious, yet.
16There is a demo instance deployed a [mat2-web.dustri.org](https://mat2-web.dustri.org). 16There is a demo instance deployed a [mat2-web.dustri.org](https://mat2-web.dustri.org).
17Please don't upload any sensitive files to it. 17Please don't upload any sensitive files to it.
18 18
19# Vue Frontend
20![Frontend GIF Preview](https://0xacab.org/jfriedli/mat2-quasar-frontend/raw/2dd5de537088d67fe4167bf5b2e1f5dacf2fa537/mat-frontend.gif?inline=true)
21There is a SPA Frontend available at https://0xacab.org/jfriedli/mat2-quasar-frontend. It consumes
22the RESTful API of this project. As a fallback for non JS users it redirects to this web app.
23To set it up checkout the [Readme](https://0xacab.org/jfriedli/mat2-quasar-frontend/blob/master/README.md).
24
19# How to deploy it? 25# How to deploy it?
20 26
21mat2 is available in [Debian stable](https://packages.debian.org/stable/mat2). 27mat2 is available in [Debian stable](https://packages.debian.org/stable/mat2).
@@ -46,7 +52,11 @@ Note that you can add multiple hosts from which you want to accept API requests.
46a space. 52a space.
47**IMPORTANT:** The default value if the variable is not set is: `Access-Control-Allow-Origin: *` 53**IMPORTANT:** The default value if the variable is not set is: `Access-Control-Allow-Origin: *`
48 54
49Configure another environment variable: `MAT2_MAX_FILES_BULK_DOWNLOAD=10` 55Configure the following environment variables:
56
57 - `MAT2_MAX_FILES_BULK_DOWNLOAD=10` Max number of files that can be grouped for a bulk download.
58 - `MAT2_MAX_FILE_AGE_FOR_REMOVAL=900` Seconds a file in the upload folder is kept.
59 After that it will be deleted. Default `15 * 60`
50 60
51This specifies the max number of files that can be bulk downloaded using the api. 61This specifies the max number of files that can be bulk downloaded using the api.
52Note: Each file has a max file size of 16mb 62Note: Each file has a max file size of 16mb
@@ -60,10 +70,6 @@ systemctl restart nginx/apache/…
60 70
61It should now be working. 71It should now be working.
62 72
63You should add `find /var/www/mat2-web/uploads/ -type f -mtime +1 -exec rm {} \;`
64in a crontab to remove files that people might have uploaded but never
65downloaded.
66
67# Deploy via Ansible 73# Deploy via Ansible
68 74
69If you happen to be using [Ansible](https://www.ansible.com/), there's an 75If you happen to be using [Ansible](https://www.ansible.com/), there's an
@@ -86,10 +92,6 @@ https://0xacab.org/jvoisin/mat2-web/container_registry
86Example: 92Example:
87`docker run -p 80:80 -d -e MAT2_ALLOW_ORIGIN_WHITELIST='https://myhost1.org' registry.0xacab.org/jvoisin/mat2-web:latest` 93`docker run -p 80:80 -d -e MAT2_ALLOW_ORIGIN_WHITELIST='https://myhost1.org' registry.0xacab.org/jvoisin/mat2-web:latest`
88 94
89Make sure to add
90`find /var/www/mat2-web/uploads/ -type f -mtime +1 -exec rm {} \;` as cron job
91run inside the container.
92
93# Development 95# Development
94Install docker and docker-compose and then run `docker-compose up` to setup 96Install docker and docker-compose and then run `docker-compose up` to setup
95the docker dev environment. Mat2-web is now accessible on your host machine at `localhost:5000`. 97the docker dev environment. Mat2-web is now accessible on your host machine at `localhost:5000`.