summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjvoisin2019-03-01 19:24:37 +0100
committerjvoisin2019-03-01 19:24:37 +0100
commit15a1139577809b64a9f5e8048e52b643525a79a9 (patch)
treeae8a66cb5a4605959dc35c01dae115be13d54438
parentbb5997ff03ac578879f772ad5a91492446843787 (diff)
Improve a bit the README
-rw-r--r--README.md46
1 files changed, 27 insertions, 19 deletions
diff --git a/README.md b/README.md
index 35fbb2a..b12e1ea 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
1``` 1```
2 _ ___ _ 2 _ ___ _
3 | | |__ \ | | 3 | | |__ \ | |
4 _ __ ___ __ _| |_ ) |_______ _____| |__ Trashing your meta, 4 _ __ ___ __ _| |_ ) | ___ __ _____| |__ Trashing your meta,
5 | '_ ` _ \ / _` | __| / /______\ \ /\ / / _ \ '_ \ keeping your data, 5| '_ ` _ \ / _` | __| / / |___|\ \ /\ / / _ \ '_ \ keeping your data,
6 | | | | | | (_| | |_ / /_ \ V V / __/ |_) | within your browser. 6| | | | | | (_| | |_ / /_ \ V V / __/ |_) | within your browser.
7 |_| |_| |_|\__,_|\__|____| \_/\_/ \___|_.__/ 7|_| |_| |_|\__,_|\__|____| \_/\_/ \___|_.__/
8 ``` 8```
9 9
10This is an online version of [mat2](https://0xacab.org/jvoisin/mat2). 10This is an online version of [mat2](https://0xacab.org/jvoisin/mat2).
11Keep in mind that this is a beta version, don't rely on it for anything 11Keep in mind that this is a beta version, don't rely on it for anything
@@ -18,8 +18,10 @@ Please don't upload any sensitive files on it.
18 18
19# How to deploy it? 19# How to deploy it?
20 20
21Since mat2 isn't available in debian stable yet, you might want to add this to 21Since mat2 isn't available in Debian stable
22/etc/apt/preferences.d/ to be able to install `mat2` via apt. 22[yet](https://0xacab.org/jvoisin/mat2/issues/76), you might want to add the
23following to your `/etc/apt/preferences.d/` to be able to install `mat2`
24via apt:
23 25
24``` 26```
25Package: * 27Package: *
@@ -39,15 +41,18 @@ Then:
39# chown -R www-data:www-data ./mat2-web 41# chown -R www-data:www-data ./mat2-web
40``` 42```
41 43
42Since uwsgi isn't fun to configure, feel free to copy [this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/uwsgi.config) 44Since [uWSGI](https://uwsgi-docs.readthedocs.io/en/latest/) isn't fun to
43to `/etc/uwsgi/apps-enabled/mat2-web.ini` and [this one](https://0xacab.org/jvoisin/mat2-web/tree/master/config/nginx.config) 45configure, feel free to copy
46[this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/uwsgi.config)
47to `/etc/uwsgi/apps-enabled/mat2-web.ini` and
48[this one](https://0xacab.org/jvoisin/mat2-web/tree/master/config/nginx.config)
44to `/etc/nginx/site-enabled/mat2-web`. 49to `/etc/nginx/site-enabled/mat2-web`.
45 50
46Nginx is the recommended web engine, but you can also use Apache if you prefer, 51Nginx is the recommended web engine, but you can also use Apache if you prefer,
47by copying [this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/apache2.config) 52by copying [this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/apache2.config)
48to your `/etc/apache2/sites-enabled/mat2-web` file. 53to your `/etc/apache2/sites-enabled/mat2-web` file.
49 54
50Finally, restart `uwsgi` and your web server: 55Finally, restart uWSGI and your web server:
51 56
52``` 57```
53systemctl restart uwsgi 58systemctl restart uwsgi
@@ -62,14 +67,17 @@ downloaded.
62 67
63# Deploy via Ansible 68# Deploy via Ansible
64 69
65If you happen to use Ansible, there's an Ansible role to deploy mat2-web on 70If you happen to be using [Ansible](https://www.ansible.com/), there's an
66Debian: [ansible-role-mat2-web](https://github.com/systemli/ansible-role-mat2-web) 71Ansible role to deploy mat2-web on Debian, thanks to the amazing
72[systemli](https://www.systemli.org/en/index.html) people:
73[ansible-role-mat2-web](https://github.com/systemli/ansible-role-mat2-web)
67 74
68The role install mat2-web as uWSGI service (run as dedicated system user), 75The role installs mat2-web as a uWSGI service, and runs it as a dedicated
69installs bubblewrap for mat2 sandboxing and creates a garbage collector 76system user, installs bubblewrap to sandbox mat2 sandboxing and creates a garbage
70cronjob to remove leftover files . Besides, it supports to create a dm-crypt 77collector cronjob to remove leftover files . Besides, it can create a
71volume with random key for the uploads folder in order to protect the uploaded 78[dm-crypt](https://en.wikipedia.org/wiki/Dm-crypt) volume with random key for
72files. 79the uploads folder, to ensure that the uploaded files won't be recoverable
80between reboots.
73 81
74# Threat model 82# Threat model
75 83