From ffbdc9c4e69bbd392de9225693570fa3e249161b Mon Sep 17 00:00:00 2001
From: Julien Oculi <xdrz.jot.sr@gmail.com>
Date: Tue, 4 Jun 2024 13:05:26 +0200
Subject: [PATCH] initial commit

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b6b7129
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Serveur de portfolio de cohabit
+
+Sert les portfofolio (site static) depuis la branche `main` de
+`https://git.cohabit.fr/[user]/.portfolio/`.
+
+> [!NOTE]
+>
+> La racine par default est `'/dist'` et la page par default `/dist/index.html`
+> (mode power user).
+>
+> Si `/dist/index.html` n'existe pas la racine devient `'/'` et la page par
+> defaut `/README.md` (mode wysiwyg user).
+
+Une rediection html peut être utilisée pour "changer la racine" ou rediriger
+vers un site externe.
+
+```html
+<meta http-equiv="refresh" content="0;URL=${destination}" />
+```
+
+> [!IMPORTANT]
+>
+> Chaque utilisateur (cohabit) se voit attribuer le sous domaine
+> `https://[user_subdomain].portfolio.cohabit.fr`.
+>
+> Chaque portfolio et donc isolé et ne (peut) partager aucune information
+> (cookie, scripts, xss, ...) avec les autres portfolios et domaines de
+> [cohabit](https://cohabit.fr).
+
+Formats :
+
+- `user` : `${firstname}.${lastname}`
+- `user_subdomain` : `${firstname}-${lastname}`