Skip to content
Snippets Groups Projects
Commit 15a11395 authored by jvoisin's avatar jvoisin
Browse files

Improve a bit the README

parent bb5997ff
Branches master
No related tags found
No related merge requests found
Pipeline #23134 failed
``` ```
_ ___ _ _ ___ _
| | |__ \ | | | | |__ \ | |
_ __ ___ __ _| |_ ) |_______ _____| |__ Trashing your meta, _ __ ___ __ _| |_ ) | ___ __ _____| |__ Trashing your meta,
| '_ ` _ \ / _` | __| / /______\ \ /\ / / _ \ '_ \ keeping your data, | '_ ` _ \ / _` | __| / / |___|\ \ /\ / / _ \ '_ \ keeping your data,
| | | | | | (_| | |_ / /_ \ V V / __/ |_) | within your browser. | | | | | | (_| | |_ / /_ \ V V / __/ |_) | within your browser.
|_| |_| |_|\__,_|\__|____| \_/\_/ \___|_.__/ |_| |_| |_|\__,_|\__|____| \_/\_/ \___|_.__/
``` ```
...@@ -18,8 +18,10 @@ Please don't upload any sensitive files on it. ...@@ -18,8 +18,10 @@ Please don't upload any sensitive files on it.
# How to deploy it? # How to deploy it?
Since mat2 isn't available in debian stable yet, you might want to add this to Since mat2 isn't available in Debian stable
/etc/apt/preferences.d/ to be able to install `mat2` via apt. [yet](https://0xacab.org/jvoisin/mat2/issues/76), you might want to add the
following to your `/etc/apt/preferences.d/` to be able to install `mat2`
via apt:
``` ```
Package: * Package: *
...@@ -39,15 +41,18 @@ Then: ...@@ -39,15 +41,18 @@ Then:
# chown -R www-data:www-data ./mat2-web # chown -R www-data:www-data ./mat2-web
``` ```
Since uwsgi isn't fun to configure, feel free to copy [this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/uwsgi.config) Since [uWSGI](https://uwsgi-docs.readthedocs.io/en/latest/) isn't fun to
to `/etc/uwsgi/apps-enabled/mat2-web.ini` and [this one](https://0xacab.org/jvoisin/mat2-web/tree/master/config/nginx.config) configure, feel free to copy
[this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/uwsgi.config)
to `/etc/uwsgi/apps-enabled/mat2-web.ini` and
[this one](https://0xacab.org/jvoisin/mat2-web/tree/master/config/nginx.config)
to `/etc/nginx/site-enabled/mat2-web`. to `/etc/nginx/site-enabled/mat2-web`.
Nginx is the recommended web engine, but you can also use Apache if you prefer, Nginx is the recommended web engine, but you can also use Apache if you prefer,
by copying [this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/apache2.config) by copying [this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/apache2.config)
to your `/etc/apache2/sites-enabled/mat2-web` file. to your `/etc/apache2/sites-enabled/mat2-web` file.
Finally, restart `uwsgi` and your web server: Finally, restart uWSGI and your web server:
``` ```
systemctl restart uwsgi systemctl restart uwsgi
...@@ -62,14 +67,17 @@ downloaded. ...@@ -62,14 +67,17 @@ downloaded.
# Deploy via Ansible # Deploy via Ansible
If you happen to use Ansible, there's an Ansible role to deploy mat2-web on If you happen to be using [Ansible](https://www.ansible.com/), there's an
Debian: [ansible-role-mat2-web](https://github.com/systemli/ansible-role-mat2-web) Ansible role to deploy mat2-web on Debian, thanks to the amazing
[systemli](https://www.systemli.org/en/index.html) people:
The role install mat2-web as uWSGI service (run as dedicated system user), [ansible-role-mat2-web](https://github.com/systemli/ansible-role-mat2-web)
installs bubblewrap for mat2 sandboxing and creates a garbage collector
cronjob to remove leftover files . Besides, it supports to create a dm-crypt The role installs mat2-web as a uWSGI service, and runs it as a dedicated
volume with random key for the uploads folder in order to protect the uploaded system user, installs bubblewrap to sandbox mat2 sandboxing and creates a garbage
files. collector cronjob to remove leftover files . Besides, it can create a
[dm-crypt](https://en.wikipedia.org/wiki/Dm-crypt) volume with random key for
the uploads folder, to ensure that the uploaded files won't be recoverable
between reboots.
# Threat model # Threat model
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment