From 40678fb39911a69a14c640174e86bf119ac43751 Mon Sep 17 00:00:00 2001
From: TiynGER <kantemarten@googlemail.com>
Date: Tue, 18 May 2021 00:11:26 +0200
Subject: [PATCH] matrix: added main page and docker image page

---
 wiki/docker-images/matrixdotorg_-_synapse.md | 51 ++++++++++++++++++++
 wiki/linux/mkinitcpio.md                     | 19 ++++++++
 wiki/matrix.md                               | 24 +++++++++
 3 files changed, 94 insertions(+)
 create mode 100644 wiki/docker-images/matrixdotorg_-_synapse.md
 create mode 100644 wiki/linux/mkinitcpio.md
 create mode 100644 wiki/matrix.md

diff --git a/wiki/docker-images/matrixdotorg_-_synapse.md b/wiki/docker-images/matrixdotorg_-_synapse.md
new file mode 100644
index 0000000..af85381
--- /dev/null
+++ b/wiki/docker-images/matrixdotorg_-_synapse.md
@@ -0,0 +1,51 @@
+# matrixdotorg - synapse
+
+The official container and documentation was made by
+[matrixdotorg](https://hub.docker.com/matrixdotorg/synapse).
+
+## Volumes
+
+Set the following volumes in the `volumes:` section of the docker-compose file.
+
+| Volume-Name | Container mount | Description                     |
+| ----------- | --------------- | ------------------------------- |
+| `matrix`    | `/data`         | storage for all homeserver data |
+
+## Ports
+
+Set the following ports in the `ports:` section.
+
+| Container Port | Recommended outside port | Protocol | Description                       |
+| -------------- | ------------------------ | -------- | --------------------------------- |
+| `3478`         | `3478`                   | TCP      | TURN over TLS                     |
+| `5349`         | `5349`                   | TCP      | TURN over TLS                     |
+| `8008`         | `8008`                   | TCP      | standard port for matrix protocol |
+
+## Rebuild
+
+```shell
+#!/bin/sh
+docker-compose down
+docker pull matrixdotorg/synapse
+docker-compose up -d
+```
+
+## Docker-Compose.yml
+
+```yaml
+version: '3.3'
+
+services:
+  app:
+    image: matrixdotorg/synapse
+    restart: always
+    volumes:
+      - matrix:/data
+    ports:
+     - "3478:3478"
+     - "5349:5349"
+     - "8008:8008"
+volumes:
+    matrix:
+        driver: local
+```
diff --git a/wiki/linux/mkinitcpio.md b/wiki/linux/mkinitcpio.md
new file mode 100644
index 0000000..b6689c6
--- /dev/null
+++ b/wiki/linux/mkinitcpio.md
@@ -0,0 +1,19 @@
+# mkinitcpio
+
+`mkinitcpio` is a script to create an initial ramdisk environment.
+
+## Troubleshooting
+
+### '/lib/modules/xxxxxxx' is not a valid kernel module directory
+
+When you encounter an error like the header of this section when running
+`mkinitcpio` try first to reinstall the `linux`, `linux-headers` and
+`filesystem` packages.
+If that does not fix it continue.
+Look into the `/lib/modules` directory.
+There should be a directory called `4.9.8-1-ARCH` or similar.
+Now run `mkinitcpio -k 4.9.8-1-ARCH -g /boot/image.img` and move the image
+to the correct location `/boot/initramfs-linux.img` in the boot directory (back
+up the old one).
+After that reboot and it should again work fine (Source:
+[Unix Stackexchange](https://unix.stackexchange.com/questions/395402/lib-modules-4-9-8-1-arch-is-not-a-valid-kernel-module-directory)).
diff --git a/wiki/matrix.md b/wiki/matrix.md
new file mode 100644
index 0000000..f369e7e
--- /dev/null
+++ b/wiki/matrix.md
@@ -0,0 +1,24 @@
+# Matrix
+
+[Matrix](https://matrix.org) is an open communication protocol.
+
+## Server
+
+A (home-)server can be setup via docker with the
+[matrixdotorg image](./docker-images/matrixdotorg_-_synapse.md).
+
+After the setup the registration is disabled.
+To enable registration go to the `homeserver.yaml`
+and locate the following lines:
+
+```yaml
+## Registration ##
+
+# Enable registration for new users.
+enable_registration: False
+```
+
+Set `enable_registration` to `True` to enable sign up.
+
+It is recommended to use a reverse proxy (like [nginx](./nginx.md)) for the 8008
+port.