1 files changed, 39 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..0e199b6
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,39 @@
+# net_services
+
+This is personal project about services on the network I provide for myself.
+
+I want to handle as much of my data myself. For privacy and for the challenge. I also want to serve apps for my friends.
+
+I set this up on a VPS with a static IP. I also bought a domain name `tvcloud.fr` to point to the VPS. Some services run on the VPS itself. Some others are run with Docker. Nginx is used as endpoint.
+
+## How-to
+
+1. Create a `.env`. See `example.env`.
+
+1. Build and run the services.
+	
+    ```
+    ./build.command
+    docker compose up
+    ```
+
+## Handling data
+
+Data of various types has to be handled in different ways.
+
+* **Passwords**: A KeePassXC database shared with Syncthing.
+
+* **Git repositories**: A remote server accesible over SSH for push. And also a web front-end (cgit).
+
+* **Calendars, to-dos, journals, and contacts**: A Radicale server.  
+    I could just synchronize the `.ics`/`.vcf` files, but a CalDAV/CarDAV server is compatible with mobile applications.
+
+* **Remote storage**: SFTP for large files. Syncthing for moderately large data that is better synchronized than downloaded manually.
+
+## Security
+
+TODO (sensitive data in tmpfs)
+
+### Firewalls
+
+TODO (OVH, iptables, docker+iptables+reboot bug)