aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 17 insertions, 20 deletions
diff --git a/README.md b/README.md
index 26a7856..5bf9f58 100644
--- a/README.md
+++ b/README.md
@@ -5,21 +5,25 @@ deuxfleurs.fr
## Our abstraction stack
-We try to build a generic abstraction stack between our different resources (CPU, RAM, disk, etc.) and our services (Chat, Storage, etc.):
-
- * ansible (physical node conf)
- * nomad (schedule containers)
- * consul (distributed key value store / lock / service discovery)
- * garage/glusterfs (file storage)
- * stolon + postgresql (distributed relational database)
- * docker (container tool)
- * bottin (LDAP server, auth)
+We try to build a generic abstraction stack between our different resources (CPU, RAM, disk, etc.) and our services (Chat, Storage, etc.), we develop our own tools when needed:
+
+ * **[garage](https://git.deuxfleurs.fr/Deuxfleurs/garage/):** S3-compatible lightweight object store for self-hosted geo-distributed deployments (we also have a legacy glusterfs cluster)
+ * **[diplonat](https://git.deuxfleurs.fr/Deuxfleurs/diplonat):** network automation (firewalling, upnp igd)
+ * **[bottin](https://git.deuxfleurs.fr/Deuxfleurs/bottin):** authentication and authorization (LDAP protocol, consul backend)
+ * **[guichet](https://git.deuxfleurs.fr/Deuxfleurs/guichet):** a dashboard for our users and administrators
+ * **ansible:** physical node configuration
+ * **nomad:** schedule containers and handle their lifecycle
+ * **consul:** distributed key value store + lock + service discovery
+ * **stolon + postgresql:** distributed relational database
+ * **docker:** package, distribute and isolate applications
Some services we provide:
- * Chat (Matrix/Riot)
- * Email (Postfix/Dovecot/Sogo)
- * Storage (Seafile)
+ * **Websites:** garage (static) + fediverse blog (plume)
+ * **Chat:** Synapse + Element Web (Matrix protocol)
+ * **Email:** Postfix SMTP + Dovecot IMAP + opendkim DKIM + Sogo webmail (legacy) | Alps webmail (experimental)
+ * **Storage:** Seafile (legacy) | Nextcloud (experimental)
+ * **Visio:** Jitsi
As a generic abstraction is provided, deploying new services should be easy.
@@ -40,14 +44,6 @@ To ease the development, we make the choice of a fully integrated environment
## Start hacking
-### Clone the repository
-
-```
-git clone https://gitlab.com/superboum/deuxfleurs.fr.git
-git submodule init
-git submodule update
-```
-
### Deploying/Updating new services is done from your machine
*The following instructions are provided for ops that already have access to the servers.*
@@ -82,6 +78,7 @@ alias bind_df="ssh \
-L 8500:127.0.0.1:8500 \
-L 8082:traefik-admin.service.2.cluster.deuxfleurs.fr:8082 \
-L 5432:psql-proxy.service.2.cluster.deuxfleurs.fr:5432 \
+ -L 1389:bottin2.service.2.cluster.deuxfleurs.fr:389 \
<a server from the cluster>"
```