From cffd902815662aa298186e78c1a7b307f7022200 Mon Sep 17 00:00:00 2001 From: Quentin Date: Mon, 18 Jan 2021 08:06:19 +0100 Subject: Add some documentation + add a requirements file --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 26a7856..5dc02d1 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,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 \ " ``` -- cgit v1.2.3 From 6c8c861dd50aebf4a12232ecc1fab12c5f83bf03 Mon Sep 17 00:00:00 2001 From: Quentin Dufour Date: Mon, 18 Jan 2021 16:46:08 +0100 Subject: Update README --- README.md | 33 ++++++++++++++------------------- 1 file changed, 14 insertions(+), 19 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 26a7856..f0324d0 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,24 @@ 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.): +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: - * 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) + * **[garage](https://git.deuxfleurs.fr/Deuxfleurs/garage/):** object storage (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) + * **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 +43,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.* -- cgit v1.2.3 From 7e637a070cd48e8a5c24ac5cbedc7ef72e60cfd4 Mon Sep 17 00:00:00 2001 From: Quentin Dufour Date: Mon, 18 Jan 2021 16:49:46 +0100 Subject: Add guichet in our readme Signed-off-by: Quentin Dufour --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 2e8ac35..c411edf 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ We try to build a generic abstraction stack between our different resources (CPU * **[garage](https://git.deuxfleurs.fr/Deuxfleurs/garage/):** object storage (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 -- cgit v1.2.3 From 0be20b22a6aecc52c6f76f3f773cd023e95b76d3 Mon Sep 17 00:00:00 2001 From: Quentin Dufour Date: Mon, 18 Jan 2021 16:51:06 +0100 Subject: Upgrade garage description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index c411edf..5bf9f58 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ deuxfleurs.fr 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/):** object storage (we also have a legacy glusterfs cluster) + * **[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 -- cgit v1.2.3