diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 46 |
1 files changed, 27 insertions, 19 deletions
| @@ -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 | ||
| 10 | This is an online version of [mat2](https://0xacab.org/jvoisin/mat2). | 10 | This is an online version of [mat2](https://0xacab.org/jvoisin/mat2). |
| 11 | Keep in mind that this is a beta version, don't rely on it for anything | 11 | Keep 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 | ||
| 21 | Since mat2 isn't available in debian stable yet, you might want to add this to | 21 | Since 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 |
| 23 | following to your `/etc/apt/preferences.d/` to be able to install `mat2` | ||
| 24 | via apt: | ||
| 23 | 25 | ||
| 24 | ``` | 26 | ``` |
| 25 | Package: * | 27 | Package: * |
| @@ -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 | ||
| 42 | Since uwsgi isn't fun to configure, feel free to copy [this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/uwsgi.config) | 44 | Since [uWSGI](https://uwsgi-docs.readthedocs.io/en/latest/) isn't fun to |
| 43 | to `/etc/uwsgi/apps-enabled/mat2-web.ini` and [this one](https://0xacab.org/jvoisin/mat2-web/tree/master/config/nginx.config) | 45 | configure, feel free to copy |
| 46 | [this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/uwsgi.config) | ||
| 47 | to `/etc/uwsgi/apps-enabled/mat2-web.ini` and | ||
| 48 | [this one](https://0xacab.org/jvoisin/mat2-web/tree/master/config/nginx.config) | ||
| 44 | to `/etc/nginx/site-enabled/mat2-web`. | 49 | to `/etc/nginx/site-enabled/mat2-web`. |
| 45 | 50 | ||
| 46 | Nginx is the recommended web engine, but you can also use Apache if you prefer, | 51 | Nginx is the recommended web engine, but you can also use Apache if you prefer, |
| 47 | by copying [this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/apache2.config) | 52 | by copying [this file](https://0xacab.org/jvoisin/mat2-web/tree/master/config/apache2.config) |
| 48 | to your `/etc/apache2/sites-enabled/mat2-web` file. | 53 | to your `/etc/apache2/sites-enabled/mat2-web` file. |
| 49 | 54 | ||
| 50 | Finally, restart `uwsgi` and your web server: | 55 | Finally, restart uWSGI and your web server: |
| 51 | 56 | ||
| 52 | ``` | 57 | ``` |
| 53 | systemctl restart uwsgi | 58 | systemctl restart uwsgi |
| @@ -62,14 +67,17 @@ downloaded. | |||
| 62 | 67 | ||
| 63 | # Deploy via Ansible | 68 | # Deploy via Ansible |
| 64 | 69 | ||
| 65 | If you happen to use Ansible, there's an Ansible role to deploy mat2-web on | 70 | If you happen to be using [Ansible](https://www.ansible.com/), there's an |
| 66 | Debian: [ansible-role-mat2-web](https://github.com/systemli/ansible-role-mat2-web) | 71 | Ansible 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 | ||
| 68 | The role install mat2-web as uWSGI service (run as dedicated system user), | 75 | The role installs mat2-web as a uWSGI service, and runs it as a dedicated |
| 69 | installs bubblewrap for mat2 sandboxing and creates a garbage collector | 76 | system user, installs bubblewrap to sandbox mat2 sandboxing and creates a garbage |
| 70 | cronjob to remove leftover files . Besides, it supports to create a dm-crypt | 77 | collector cronjob to remove leftover files . Besides, it can create a |
| 71 | volume 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 |
| 72 | files. | 79 | the uploads folder, to ensure that the uploaded files won't be recoverable |
| 80 | between reboots. | ||
| 73 | 81 | ||
| 74 | # Threat model | 82 | # Threat model |
| 75 | 83 | ||
