cookbook skeleton

This commit is contained in:
Quentin 2024-01-22 11:01:47 +01:00
parent 77f14e0f14
commit 76d399e94f
Signed by: quentin
GPG key ID: E9602264D639FF68
14 changed files with 113 additions and 15 deletions

View file

@ -5,23 +5,41 @@ sort_by = "weight"
template = "documentation.html" template = "documentation.html"
+++ +++
## Minimal deployment This cookbook will guide you from your first steps
- Static user management to a real deployment of Aerogramme.
- Single-node Garage storage
- TLS encryption
- Integration with a service manager
- SMTP server integration (MTA)
## Standard deployment ## Single-node, minimal deployment
- LDAP user management
- Garage cluster storage A minimal deployment will allow you to deploy Aerogramme on a single-server
- Integration in an orchestrator in a way that it works for a small production deployment.
- Auto-discovery However, as Aerogramme is a distributed-first server,
you will not benefit from all of its nice properties, and many manual
work will be required.
- [Static user management](@/documentation/cookbook/static-user-management.md)
- [Local storage](@/documentation/cookbook/single-node-garage-storage.md)
- [TLS encryption](@/documentation/cookbook/tls-encryption.md)
- [Integration with a service manager](@/documentation/cookbook/service-manager.md) (systemd or docker)
- [SMTP server integration](@/documentation/cookbook/smtp-server.md) (MTA)
## Multi-nodes, standard deployment
Aerogramme is intended for multi-nodes deployment. This guide
will cover the specificities introduced by a multi-node deployment.
- [LDAP user management](@/documentation/cookbook/ldap.md)
- [Distributed storage](@/documentation/cookbook/garage-cluster-storage.md)
- [Orchestrators](@/documentation/cookbook/orchestrators.md)
- [Auto-discovery](@/documentation/cookbook/autodiscovery.md)
## Lifecycle ## Lifecycle
- Updates
- Observability Hopefully you will love Aerogramme, and thus you will have to do some maintainance on it.
- Backups
- [Updates](@/documentation/cookbook/updates.md)
- [Observability](@/documentation/cookbook/observability.md)
- [Backups](@/documentation/cookbook/backups.md)
## Hardened flavor ## Hardened flavor
- Manual configuration
- [Manual configuration](@/documentation/cookbook/manual-hardened.md)

View file

@ -0,0 +1,6 @@
+++
title = "Auto-discovery"
weight = 90
+++
Todo

View file

@ -0,0 +1,6 @@
+++
title = "Backups"
weight = 120
+++
Todo

View file

@ -0,0 +1,6 @@
+++
title = "Distributed Storage"
weight = 70
+++
Todo

View file

@ -0,0 +1,6 @@
+++
title = "LDAP User Management"
weight = 60
+++
LDAP

View file

@ -0,0 +1,6 @@
+++
title = "Hardened configuration"
weight = 130
+++
Todo

View file

@ -0,0 +1,6 @@
+++
title = "Observability"
weight = 110
+++
Todo

View file

@ -0,0 +1,6 @@
+++
title = "Orchestrators"
weight = 80
+++
Todo

View file

@ -0,0 +1,6 @@
+++
title = "Service Managers (eg. systemd)"
weight = 40
+++
Todo

View file

@ -0,0 +1,7 @@
+++
title = "Local storage"
weight = 20
+++
Todo

View file

@ -0,0 +1,6 @@
+++
title = "SMTP servers"
weight = 50
+++
Todo

View file

@ -0,0 +1,7 @@
+++
title = "Static User Management"
weight = 10
+++
Todo

View file

@ -0,0 +1,6 @@
+++
title = "TLS"
weight = 30
+++
Todo

View file

@ -0,0 +1,6 @@
+++
title = "Updates"
weight = 100
+++
Todo