diff --git a/astro.config.mjs b/astro.config.mjs index 0a75f4c..16cd87c 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -215,6 +215,10 @@ export default defineConfig({ label: 'Deploy OpenClaw (Marketplace, CLI)', slug: 'tutorials/deploy-openclaw-marketplace-cli', }, + { + label: 'Manage ZCP with Terraform / OpenTofu', + slug: 'tutorials/manage-infrastructure-terraform', + }, ], }, @@ -422,11 +426,11 @@ export default defineConfig({ collapsed: true, items: [ { label: 'MongoDB 8.0', slug: 'public-cloud/marketplace/mongodb' }, - { label: 'MariaDB 11.4', slug: 'public-cloud/marketplace/mariadb' }, - { label: 'MySQL 8.4', slug: 'public-cloud/marketplace/mysql' }, - { label: 'PostgreSQL 17', slug: 'public-cloud/marketplace/postgresql' }, - { label: 'Valkey 9.0', slug: 'public-cloud/marketplace/valkey' }, - { label: 'Elasticsearch 8', slug: 'public-cloud/marketplace/elasticsearch' }, + { label: 'MariaDB 11.8', slug: 'public-cloud/marketplace/mariadb' }, + { label: 'MySQL', slug: 'public-cloud/marketplace/mysql' }, + { label: 'PostgreSQL', slug: 'public-cloud/marketplace/postgresql' }, + { label: 'Valkey 9.1', slug: 'public-cloud/marketplace/valkey' }, + { label: 'Elasticsearch 9', slug: 'public-cloud/marketplace/elasticsearch' }, { label: 'InfluxDB 2', slug: 'public-cloud/marketplace/influxdb' }, ], }, @@ -459,7 +463,7 @@ export default defineConfig({ { label: 'DevOps & Source Control', collapsed: true, - items: [{ label: 'GitLab CE 18.11', slug: 'public-cloud/marketplace/gitlab' }], + items: [{ label: 'GitLab CE 19.1', slug: 'public-cloud/marketplace/gitlab' }], }, { label: 'Networking & VPN', diff --git a/public/icons/marketplace/headplane-dark.svg b/public/icons/marketplace/headplane-dark.svg new file mode 100644 index 0000000..6178374 --- /dev/null +++ b/public/icons/marketplace/headplane-dark.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/public/icons/marketplace/headplane.png b/public/icons/marketplace/headplane.png deleted file mode 100644 index 1e9a4e5..0000000 Binary files a/public/icons/marketplace/headplane.png and /dev/null differ diff --git a/public/icons/marketplace/headplane.svg b/public/icons/marketplace/headplane.svg new file mode 100644 index 0000000..a106898 --- /dev/null +++ b/public/icons/marketplace/headplane.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/src/content/docs/changelog/index.md b/src/content/docs/changelog/index.md index f4331c9..5a2e718 100644 --- a/src/content/docs/changelog/index.md +++ b/src/content/docs/changelog/index.md @@ -38,6 +38,52 @@ One-click application images for compute instances. The official command-line tool for the platform. The entries below mirror the CLI's [`CHANGELOG.md`](https://github.com/zsoftly/zcp-cli/blob/main/CHANGELOG.md) on GitHub. +### v0.0.23: July 8, 2026 + +**`--wait` now reports the real instance state.** The platform's cached state sometimes lags minutes +behind reality, so `instance create/start/stop --wait` kept waiting on a VM already up. The CLI now +polls the live state endpoint, which reconciles with the hypervisor, and returns as soon as the VM +is running. + +- **Corrected `instance delete --delete-public-ip` help**: the platform does not release the + auto-assigned public IP on delete yet (an API-side fix is in progress). The option, prompt, and + help now say so plainly. Release the address manually with `zcp ip release ` after + deleting. + +### v0.0.22: July 7, 2026 + +**DNS records display and delete correctly.** The DNS service models records as record sets +addressed by name and type. `zcp dns show` and `record-create` now display record content +(multi-value sets included), and `dns record-delete` works with `--name` and `--type`. Record names +are relative: the CLI appends the zone for you. + +- **`egress create` reports honestly** when the platform accepts a rule but never lists it, instead + of failing with a confusing lookup error. +- **Automated validation now covers the command reference**: a script checks all 264 examples + against the built CLI, and we rewrote six sections to match the real command trees. +- **L2 instances work, and `instance create` examples run as pasted**, contributed by first-time + community contributor [@cokerrd](https://github.com/cokerrd): the new `--is-public` option + unblocks `--network-type L2`, and the required `--network-plan` and `--storage-category` options + are now in every example. + +### v0.0.21: July 2, 2026 + +**Profile defaults now apply to create commands.** With defaults configured through +`zcp profile add`, create and mutate commands no longer error asking for `--region`/`--project`. Set +them once. List and get commands already worked this way. + +- **First-run guidance**: the installers print copy-paste setup for the production defaults + (`--region yul-1 --project default-9`), and the docs use them throughout. +- **We verify every example slug against the live catalog** (templates, plans, backup and load + balancer plans), so examples run as pasted. + +### v0.0.20: June 30, 2026 + +**`zcp instance delete` requests release of the VM's auto-assigned public IP by default**, so no +address stays allocated and billed after the VM is gone. Pass `--delete-public-ip=false` to keep the +address. Manually acquired and source-NAT addresses are unaffected. See the v0.0.23 note: the +platform-side release is not active yet. + ### v0.0.19: June 21, 2026 **Manage IAM from the CLI: sub-users, roles, and permissions.** Everything in the portal's Profile @@ -227,6 +273,28 @@ consistent response format. A large set of command groups arrived: ## Terraform / OpenTofu provider -Manage ZCP infrastructure as code. The provider is in active development at +Manage ZCP infrastructure as code with the official provider, published as `zsoftly/zcp` on the +[OpenTofu registry](https://search.opentofu.org/provider/zsoftly/zcp) and the +[Terraform Registry](https://registry.terraform.io/providers/zsoftly/zcp). Source code lives at [github.com/zsoftly/terraform-provider-zcp](https://github.com/zsoftly/terraform-provider-zcp). -Released versions will be listed here. + +### v0.1.0: July 8, 2026 + +**First public release, live on both registries.** 38 resources and 12 data sources cover everything +the `zcp` CLI supports: instances, volumes, snapshots and backups, VPCs and networks, firewall and +egress rules, load balancers, auto-scaling, Kubernetes clusters, DNS, object storage, VPN, and +account governance. Every resource supports `terraform import`, and we sign every release. + +```hcl +terraform { + required_providers { + zcp = { + source = "zsoftly/zcp" + version = "~> 0.1" + } + } +} +``` + +Set `ZCP_BEARER_TOKEN` in your environment, then run `terraform init` or `tofu init`. Generate the +token in the console under **Account → API Keys**. diff --git a/src/content/docs/fr/changelog/index.md b/src/content/docs/fr/changelog/index.md index a8d8734..929ba2a 100644 --- a/src/content/docs/fr/changelog/index.md +++ b/src/content/docs/fr/changelog/index.md @@ -40,6 +40,57 @@ Images d'applications en un clic pour les instances de calcul. L'outil en ligne de commande officiel de la plateforme. Les entrées ci-dessous reflètent le [`CHANGELOG.md`](https://github.com/zsoftly/zcp-cli/blob/main/CHANGELOG.md) du CLI sur GitHub. +### v0.0.23 : 8 juillet 2026 + +**`--wait` rapporte désormais l'état réel de l'instance.** L'état en cache de la plateforme accuse +parfois plusieurs minutes de retard sur la réalité, si bien que `instance create/start/stop --wait` +continuait d'attendre une VM déjà démarrée. Le CLI interroge maintenant le point de terminaison +d'état en direct, réconcilié avec l'hyperviseur, et rend la main dès que la VM est en marche. + +- **Aide corrigée pour `instance delete --delete-public-ip`** : la plateforme ne libère pas encore + l'adresse IP publique attribuée automatiquement lors de la suppression (un correctif est en cours + côté API). L'option, l'invite et l'aide l'indiquent désormais clairement. Libérez l'adresse + manuellement avec `zcp ip release ` après la suppression. + +### v0.0.22 : 7 juillet 2026 + +**Les enregistrements DNS s'affichent et se suppriment correctement.** Le service DNS modélise les +enregistrements comme des ensembles d'enregistrements adressés par nom et type. `zcp dns show` et +`record-create` affichent maintenant le contenu des enregistrements (ensembles à valeurs multiples +inclus), et `dns record-delete` fonctionne avec `--name` et `--type`. Les noms d'enregistrements +sont relatifs : le CLI ajoute la zone pour vous. + +- **`egress create` rapporte honnêtement** lorsque la plateforme accepte une règle qui n'apparaît + jamais dans la liste des règles, au lieu d'échouer avec une erreur de recherche déroutante. +- **La validation automatisée couvre désormais la référence des commandes** : un script confronte + les 264 exemples au CLI compilé, et nous avons réécrit six sections selon les arborescences + réelles des commandes. +- **Les instances L2 fonctionnent et les exemples de `instance create` s'exécutent tels quels**, + contribution de [@cokerrd](https://github.com/cokerrd), qui signe ici sa première contribution + communautaire : la nouvelle option `--is-public` débloque `--network-type L2`, et les options + requises `--network-plan` et `--storage-category` figurent désormais dans chaque exemple. + +### v0.0.21 : 2 juillet 2026 + +**Les valeurs par défaut du profil s'appliquent maintenant aux commandes de création.** Avec des +valeurs par défaut configurées via `zcp profile add`, les commandes de création et de modification +n'exigent plus `--region`/`--project`. Configurez-les une fois, comme le permettaient déjà les +commandes de liste et de lecture. + +- **Accompagnement au premier lancement** : les installateurs affichent la configuration à + copier-coller pour les valeurs par défaut de production (`--region yul-1 --project default-9`), + reprises dans toute la documentation. +- **Nous confrontons chaque slug d'exemple au catalogue en production** (modèles, plans, plans de + sauvegarde et d'équilibreur de charge), donc les exemples s'exécutent tels quels. + +### v0.0.20 : 30 juin 2026 + +**`zcp instance delete` demande par défaut la libération de l'adresse IP publique attribuée +automatiquement**, pour ne plus laisser d'adresses allouées et facturées après la suppression de la +VM. Passez `--delete-public-ip=false` pour conserver l'adresse. Les adresses acquises manuellement +et les adresses source-NAT ne sont pas touchées. Voir la note de la v0.0.23 : la libération côté +plateforme n'est pas encore active. + ### v0.0.19 : 21 juin 2026 **Gérer l'IAM depuis la CLI : sous-utilisateurs, rôles et permissions.** Tout ce qui se trouve dans @@ -254,6 +305,29 @@ arrivé : ## Fournisseur Terraform / OpenTofu -Gérez l'infrastructure ZCP comme du code. Le fournisseur est en développement actif sur -[github.com/zsoftly/terraform-provider-zcp](https://github.com/zsoftly/terraform-provider-zcp) ; les -versions publiées seront listées ici. +Gérez l'infrastructure ZCP comme du code avec le fournisseur officiel, publié sous `zsoftly/zcp` sur +le [registre OpenTofu](https://search.opentofu.org/provider/zsoftly/zcp) et le +[registre Terraform](https://registry.terraform.io/providers/zsoftly/zcp). Le code source se trouve +sur [github.com/zsoftly/terraform-provider-zcp](https://github.com/zsoftly/terraform-provider-zcp). + +### v0.1.0 : 8 juillet 2026 + +**Première version publique, disponible sur les deux registres.** 38 ressources et 12 sources de +données couvrent tout ce que le CLI `zcp` prend en charge : instances, volumes, instantanés et +sauvegardes, VPC et réseaux, règles de pare-feu et de sortie, équilibreurs de charge, mise à +l'échelle automatique, grappes Kubernetes, DNS, stockage objet, VPN et gouvernance de compte. Chaque +ressource prend en charge `terraform import`, et nous signons chaque version publiée. + +```hcl +terraform { + required_providers { + zcp = { + source = "zsoftly/zcp" + version = "~> 0.1" + } + } +} +``` + +Définissez `ZCP_BEARER_TOKEN` dans votre environnement, puis exécutez `terraform init` ou +`tofu init`. Générez le jeton dans la console sous **Compte → Clés API**. diff --git a/src/content/docs/fr/index.mdx b/src/content/docs/fr/index.mdx index 303bef1..fc9fb37 100644 --- a/src/content/docs/fr/index.mdx +++ b/src/content/docs/fr/index.mdx @@ -184,7 +184,7 @@ hero:

Terraform / OpenTofu

-

Gérez l'infrastructure ZCP comme du code. Fournisseur en développement sur github.com/zsoftly/terraform-provider-zcp.

+

Gérez l'infrastructure ZCP comme du code. Offert sous le nom zsoftly/zcp dans les registres Terraform et OpenTofu.

diff --git a/src/content/docs/fr/public-cloud/api/quickstart.mdx b/src/content/docs/fr/public-cloud/api/quickstart.mdx index 347e586..142906f 100644 --- a/src/content/docs/fr/public-cloud/api/quickstart.mdx +++ b/src/content/docs/fr/public-cloud/api/quickstart.mdx @@ -757,13 +757,11 @@ echo $body["message"] . "\n"; ### Infrastructure comme code (IaC) -:::note - -Un fournisseur **Terraform** ZSoftly sera bientôt disponible. Il permettra de gérer les machines -virtuelles, les réseaux et le stockage de manière déclarative. Des exemples de configuration seront -publiés ici. - -::: +Le fournisseur officiel **Terraform / OpenTofu** gère les machines virtuelles, les réseaux, +Kubernetes, le DNS, le stockage et plus encore, de manière déclarative. Vous le trouvez sous +`zsoftly/zcp` dans le [registre Terraform](https://registry.terraform.io/providers/zsoftly/zcp) et +le [registre OpenTofu](https://search.opentofu.org/provider/zsoftly/zcp). Commencez par le +[tutoriel Terraform / OpenTofu](/tutorials/manage-infrastructure-terraform) (en anglais). ### Gestion de la configuration diff --git a/src/content/docs/fr/public-cloud/marketplace/authentik.md b/src/content/docs/fr/public-cloud/marketplace/authentik.md index 7fa6937..0decdd6 100644 --- a/src/content/docs/fr/public-cloud/marketplace/authentik.md +++ b/src/content/docs/fr/public-cloud/marketplace/authentik.md @@ -2,18 +2,23 @@ title: Authentik --- -Authentik est un fournisseur d'identité libre qui centralise l'authentification de vos applications. -Il prend en charge le SSO via OAuth 2.0, OpenID Connect, SAML, LDAP et le proxy/forward-auth, avec -des flux, des politiques et un portail utilisateur en libre-service flexibles. Ce guide déploie -Authentik avec sa pile Docker Compose officielle. +Authentik est un fournisseur d'identité open source qui centralise l'authentification de vos +applications. Il prend en charge le SSO avec OAuth 2.0, OpenID Connect, SAML, LDAP et +proxy/forward-auth, avec des flux, des politiques et un portail utilisateur en libre-service. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Authentik préconfigurée arrive bientôt. Pour l'instant, déployez une instance **Ubuntu -24.04 LTS** neuve depuis la marketplace et suivez les étapes ci-dessous pour installer Authentik -vous-même. +| Composant | Version | +| ---------- | --------------- | +| Authentik | 2026.5.4 | +| PostgreSQL | 18 | +| Docker | Dernière stable | +| Ubuntu | 24.04 LTS | -::: +Authentik exécute ses conteneurs serveur et worker avec PostgreSQL, sous forme de pile Docker +Compose. Redis n'est plus requis. Authentik a déplacé la mise en cache, les tâches d'arrière-plan et +la communication WebSocket vers PostgreSQL, si bien que la pile se limite à PostgreSQL, au serveur +et au worker. ## Prérequis @@ -23,100 +28,95 @@ vous-même. | RAM | 2 Go | 4 Go | | Stockage | 20 Go | 40 Go | -## Déployer l'instance de base +## Variables d'environnement -1. Dans le portail ZSoftly Cloud, ouvrez **Apps**, sélectionnez **Authentik** et cliquez sur - **Deploy**, ou créez une instance **Ubuntu 24.04 LTS** depuis **Instances → Create**. Les deux - vous donnent une VM Ubuntu 24.04 propre. -2. Choisissez un forfait conforme aux prérequis ci-dessus et sélectionnez votre région (YOW-1 ou - YUL-1). -3. Lorsque l'instance est **Running**, connectez-vous en SSH: +Vous pouvez les définir au déploiement d'Authentik depuis la Marketplace. Laissez un champ de mot de +passe vide pour générer automatiquement une valeur aléatoire sécurisée. -```bash -ssh ubuntu@ -``` +| Variable | Description | +| ------------------------------ | --------------------------------------------------------- | +| `AUTHENTIK_HOSTNAME` | Nom d'hôte public ou IP depuis lequel Authentik est servi | +| `AUTHENTIK_BOOTSTRAP_EMAIL` | Adresse courriel du compte initial `akadmin` | +| `AUTHENTIK_BOOTSTRAP_PASSWORD` | Mot de passe du compte initial `akadmin` | + +## Démarrage -4. Mettez le système à jour: +### 1. Se connecter à la machine virtuelle ```bash -sudo apt update && sudo apt upgrade -y +ssh ubuntu@ ``` -## Installer Authentik - -Authentik fournit une pile Docker Compose officielle. Installez donc d'abord Docker Engine et le -plugin Compose. +### 2. Attendre la configuration au premier démarrage -Configurez le dépôt APT officiel de Docker pour Ubuntu 24.04 LTS (`noble`): +Au premier démarrage, un script génère les valeurs d'administration, de base de données et de clé +secrete, écrit le fichier d'environnement, puis démarre la pile avec Docker Compose. Cela prend 1 a +2 minutes. Suivez la progression: ```bash -sudo apt install -y ca-certificates curl -sudo install -m 0755 -d /etc/apt/keyrings -sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc -sudo chmod a+r /etc/apt/keyrings/docker.asc -sudo tee /etc/apt/sources.list.d/docker.sources >/dev/null <:9000 ``` -## Configurer Authentik +Connectez-vous avec l'adresse courriel `akadmin` et le mot de passe génère. HTTPS est aussi +disponible sur le port 9443 avec un certificat autosigné. + +## Gérer Authentik -Téléchargez les images et démarrez la pile: +Authentik s'exécute comme pile Docker Compose dans `/opt/authentik`. ```bash -sudo docker compose pull -sudo docker compose up -d -``` +# Vérifier l'état +cd /opt/authentik && docker compose ps -Authentik sert HTTP sur le port 9000 et HTTPS sur le port 9443 par défaut. Terminez la configuration -de premier démarrage en accédant au flux initial-setup, qui crée le compte `akadmin` par défaut et -définit son mot de passe: +# Redémarrer +cd /opt/authentik && docker compose restart -```text -http://:9000/if/flow/initial-setup/ +# Voir les journaux +cd /opt/authentik && docker compose logs -f ``` -Pour un déploiement de production, faites pointer un enregistrement DNS vers la VM et placez -Authentik derrière TLS. Vous pouvez utiliser le HTTPS intégré sur le port 9443, ou le placer -derrière un reverse proxy (Caddy, nginx ou Traefik) qui termine TLS et redirige vers le port 9000. +Configuration d'environnement: `/opt/authentik/.env`. Les données de base de données, médias et +certificats sont stockées sous `/opt/authentik`. -## Ouvrir le pare-feu +## Sécurité -L'instance n'autorise que SSH (port 22) en externe par défaut. Ouvrez les ports qu'Authentik sert et -ajoutez-les aux règles réseau/sécurité de l'instance dans le portail: +Les ports 9000 (HTTP) et 9443 (HTTPS) sont ouverts sur l'interface réseau de la machine virtuelle. +UFW est activé et autorise ces ports ainsi que SSH (port 22). Authentik sert un certificat autosigné +par defaut sur 9443. + +**Pour limiter l'accès à une adresse IP précise:** ```bash -sudo ufw allow 9000/tcp -sudo ufw allow 9443/tcp +sudo ufw delete allow 9000/tcp +sudo ufw delete allow 9443/tcp +sudo ufw allow from to any port 9000 +sudo ufw allow from to any port 9443 ``` -## Étapes suivantes +**En production**, pointez un enregistrement DNS vers la machine virtuelle et placez Authentik +derriere TLS, soit avec le HTTPS intégré sur 9443 et votre propre certificat, soit avec un proxy +inverse (Caddy, nginx ou Traefik) qui termine TLS et relaie vers le port 9000. + +## Prochaines étapes - [Documentation Authentik](https://docs.goauthentik.io/) -- [Guide d'installation d'Authentik](https://docs.goauthentik.io/install-config/install/docker-compose/) +- [Reference de configuration](https://docs.goauthentik.io/docs/install-config/configuration/) diff --git a/src/content/docs/fr/public-cloud/marketplace/coolify.md b/src/content/docs/fr/public-cloud/marketplace/coolify.md index b926fcc..c4cb1d0 100644 --- a/src/content/docs/fr/public-cloud/marketplace/coolify.md +++ b/src/content/docs/fr/public-cloud/marketplace/coolify.md @@ -2,17 +2,19 @@ title: Coolify --- -Coolify est une PaaS open source et auto-hébergée, alternative directe à Heroku, Netlify et Vercel. -Elle déploie des applications, des bases de données et des services sur votre propre serveur grâce à -des workflows basés sur Git et à un tableau de bord web, tout en gardant l'ensemble de vos données -sous votre contrôle. +Coolify est une plateforme PaaS (Platform as a Service) open source auto-hébergée qui constitue une +alternative à Heroku, Netlify et Vercel. Elle permet de déployer des applications, des bases de +données et des services sur votre propre infrastructure à l'aide de flux Git et d'un tableau de bord +web, tout en conservant un contrôle total sur vos données. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Coolify préconfigurée arrive bientôt. Pour l'instant, déployez une instance **Ubuntu 24.04 -LTS** neuve depuis la marketplace et suivez les étapes ci-dessous pour installer Coolify vous-même. - -::: +| Composant | Version | +| -------------- | --------------- | +| Coolify | 4.1.2 | +| Docker | Dernière stable | +| Docker Compose | Dernière stable | +| Ubuntu | 24.04 LTS | ## Prérequis @@ -22,74 +24,88 @@ LTS** neuve depuis la marketplace et suivez les étapes ci-dessous pour installe | RAM | 2 Go | 4 Go | | Stockage | 30 Go | 60 Go | -## Déployer l'instance de base +Coolify héberge également les applications, les bases de données et les services que vous déployez. +Il est donc important de dimensionner correctement l'instance en fonction des charges de travail +prévues. -1. Dans le portail ZSoftly Cloud, ouvrez **Apps** et passez à l'onglet **Marketplace**. Il s'ouvre - sur **Featured** par défaut, sélectionnez donc **Marketplace** à côté. Choisissez votre région - (YOW-1 ou YUL-1), recherchez **Ubuntu 24.04 LTS** et cliquez sur **Deploy**. Vous pouvez aussi - créer l'instance depuis **Instances → Create**. Dans les deux cas, vous obtenez une VM Ubuntu - 24.04 propre. +## Démarrage - ![L'onglet Marketplace du portail ZSoftly Cloud, avec le sélecteur de région, la liste des catégories, la barre de recherche et les boutons Deploy](../../../../../assets/marketplace/deploy-marketplace-tab.webp) +### 1. Se connecter à la machine virtuelle - ![Recherche d'une application dans le Marketplace, la barre de recherche filtrant le catalogue jusqu'à une carte Deploy correspondante](../../../../../assets/marketplace/deploy-marketplace-search.webp) +```bash +ssh ubuntu@ +``` -2. Choisissez un plan qui répond aux prérequis ci-dessus. +### 2. Attendre la configuration au premier démarrage -3. Lorsque l'instance est **Running**, connectez-vous en SSH: +Lors du premier démarrage, un script génère les secrets de l'application et démarre l'ensemble de la +pile Coolify avec Docker Compose. Cette opération prend environ 1 à 2 minutes. Vous pouvez suivre la +progression avec la commande suivante: ```bash -ssh ubuntu@ +journalctl -u coolify-first-boot.service -f ``` -4. Mettez le système à jour: +Le message de connexion (MOTD) confirme quand Coolify est prêt. -```bash -sudo apt update && sudo apt upgrade -y +### 3. Créer le compte administrateur + +Ouvrez le tableau de bord dans votre navigateur: + +```text +http://:8000 ``` -## Installer Coolify +Le premier compte créé devient l'administrateur racine. Définissez immédiatement une adresse +courriel et un mot de passe forts, car l'inscription se ferme après le premier utilisateur. + +### 4. Configurer l'instance + +1. Dans les **paramètres (Settings)**, définissez le domaine de l'instance afin que Coolify émette + des certificats TLS Let's Encrypt et serve le tableau de bord en HTTPS. Coolify inclut un proxy + inverse intégré qui gère le routage et les certificats pour le tableau de bord et vos + applications déployées. Le DNS doit pointer vers la machine virtuelle avant l'émission des + certificats. +2. Connectez une source Git (GitHub, GitLab ou dépôt générique) pour commencer à déployer des + applications. + +## Gérer Coolify -Coolify fournit un installeur officiel en une ligne qui met en place Docker, Docker Compose et la -pile Coolify complète pour vous. Exécutez-le en tant que root: +Coolify s'exécute comme pile Docker Compose dans `/data/coolify/source`. ```bash -curl -fsSL https://cdn.coollabs.io/coolify/install.sh | sudo bash -``` +# Vérifier l'état +cd /data/coolify/source && docker compose ps + +# Redémarrer +cd /data/coolify/source && docker compose restart -L'installeur télécharge les images requises et démarre chaque service. Une fois terminé, il affiche -l'URL du tableau de bord. Rien d'autre n'a besoin d'être installé manuellement. +# Voir les journaux +cd /data/coolify/source && docker compose logs -f +``` -## Configurer Coolify +Un résumé des URL et des chemins est écrit dans `/data/coolify/info.txt`. -1. Ouvrez le tableau de bord dans votre navigateur à l'adresse `http://:8000`. -2. Le premier compte que vous créez devient l'administrateur racine. Définissez immédiatement une - adresse e-mail et un mot de passe robustes, car les inscriptions se ferment après le premier - utilisateur. -3. Sous **Settings**, définissez le domaine de votre instance afin que Coolify puisse émettre des - certificats TLS Let's Encrypt et servir le tableau de bord en HTTPS. Coolify inclut un reverse - proxy Traefik intégré qui gère le routage et les certificats à la fois pour le tableau de bord et - pour vos applications déployées, aucun proxy distinct n'est donc nécessaire. -4. Ajoutez la clé SSH publique de votre serveur et connectez une source Git (GitHub, GitLab ou un - dépôt générique) pour commencer à déployer des applications. +## Sécurité -## Ouvrir le pare-feu +Les ports 8000 (tableau de bord), 6001 (temps réel), 6002 (terminal), 80 et 443 sont ouverts sur +l'interface réseau de la machine virtuelle. UFW est activé et autorise ces ports ainsi que SSH (port +22). Les ports 80 et 443 servent vos applications déployées et TLS. -Par défaut, l'instance n'autorise que le SSH (port 22) depuis l'extérieur. Ouvrez les ports dont -Coolify a besoin et ajoutez-les aux règles réseau/sécurité de l'instance dans le portail: +Lorsque vous configurez un domaine personnalisé avec Let's Encrypt, accédez au tableau de bord en +HTTPS sur le port 443. Vous pouvez ensuite fermer les ports 8000, 6001 et 6002 si l'accès direct +n'est plus nécessaire: ```bash -sudo ufw allow 8000/tcp -sudo ufw allow 80/tcp -sudo ufw allow 443/tcp -sudo ufw allow 6001/tcp -sudo ufw allow 6002/tcp +sudo ufw delete allow 8000/tcp +sudo ufw delete allow 6001/tcp +sudo ufw delete allow 6002/tcp ``` -Les ports 80 et 443 servent vos applications déployées et le TLS. Les ports 6001 et 6002 sont -utilisés par les fonctionnalités temps réel et terminal de Coolify. +Terminez rapidement la configuration administrateur après le premier démarrage afin que personne +d'autre ne puisse réclamer le compte racine. -## Étapes suivantes +## Prochaines étapes - [Documentation Coolify](https://coolify.io/docs) -- [Guide d'installation de Coolify](https://coolify.io/docs/get-started/installation) +- [Démarrer avec Coolify](https://coolify.io/docs/get-started/introduction) diff --git a/src/content/docs/fr/public-cloud/marketplace/dify.md b/src/content/docs/fr/public-cloud/marketplace/dify.md index b7afd74..2079d44 100644 --- a/src/content/docs/fr/public-cloud/marketplace/dify.md +++ b/src/content/docs/fr/public-cloud/marketplace/dify.md @@ -2,17 +2,22 @@ title: Dify --- -Dify est une plateforme libre pour créer des applications LLM et des agents d'IA. Elle combine un -constructeur de flux de travail visuel, des pipelines de génération augmentée par récupération -(RAG), la gestion des invites et un cadre d'agents, afin que les équipes puissent concevoir, tester -et déployer des applications d'IA générative depuis une seule interface. +Dify est une plateforme open source pour creer des applications LLM et des agents IA. Elle combine +un constructeur visuel de workflows, des pipelines de génération augmentée par récupération (RAG), +la gestion des prompts et un cadre d'agents pour concevoir, tester et déployer des applications d'IA +générative depuis une seule interface. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Dify préconstruite arrive bientôt. Pour l'instant, déployez une instance **Ubuntu 24.04 -LTS** neuve depuis la place de marché et suivez les étapes ci-dessous pour installer Dify vous-même. +| Composant | Version | +| -------------- | --------------- | +| Dify | 1.15.0 | +| Docker | Dernière stable | +| Docker Compose | Dernière stable | +| Ubuntu | 24.04 LTS | -::: +Dify s'exécute comme pile Docker Compose multi-conteneurs (API, worker, web, PostgreSQL, Redis, +stockage vectoriel Weaviate et nginx). ## Prérequis @@ -22,121 +27,84 @@ LTS** neuve depuis la place de marché et suivez les étapes ci-dessous pour ins | RAM | 4 Go | 8 Go | | Stockage | 40 Go | 80 Go | -Dify fonctionne comme une pile Docker Compose multi-conteneurs (API, worker, web, base de données, -magasin de vecteurs et nginx), de sorte que les besoins en RAM et en stockage augmentent avec -l'utilisation. +Les besoins en RAM et en stockage augmentent avec l'utilisation. -## Déployer l'instance de base +## Démarrage -1. Dans le portail ZSoftly Cloud, ouvrez **Apps** et passez à l'onglet **Marketplace**. Il s'ouvre - sur **Featured** par défaut, sélectionnez donc **Marketplace** à côté. Choisissez votre région - (YOW-1 ou YUL-1), recherchez **Ubuntu 24.04 LTS** et cliquez sur **Deploy**. Vous pouvez aussi - créer l'instance depuis **Instances → Create**. Dans les deux cas, vous obtenez une VM Ubuntu - 24.04 propre. - - ![L'onglet Marketplace du portail ZSoftly Cloud, avec le sélecteur de région, la liste des catégories, la barre de recherche et les boutons Deploy](../../../../../assets/marketplace/deploy-marketplace-tab.webp) - - ![Recherche d'une application dans le Marketplace, la barre de recherche filtrant le catalogue jusqu'à une carte Deploy correspondante](../../../../../assets/marketplace/deploy-marketplace-search.webp) - -2. Choisissez un plan qui répond aux prérequis ci-dessus. - -3. Lorsque l'instance est **Running**, connectez-vous en SSH: +### 1. Se connecter à la machine virtuelle ```bash ssh ubuntu@ ``` -4. Mettez le système à jour: +### 2. Attendre la configuration au premier démarrage + +Au premier démarrage, un script génère les secrets internes de base de données et Redis, écrit le +fichier d'environnement, puis démarre la pile avec Docker Compose. Cela prend quelques minutes, le +temps que les conteneurs deviennent sains. Suivez la progression: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u dify-first-boot.service -f ``` -## Installer Dify +Le message de connexion (MOTD) confirme quand Dify est prêt et affiche les identifiants internes. -Dify est fourni sous forme de pile Docker Compose, installez donc d'abord Docker Engine et le plugin -Compose. +### 3. Terminer la configuration administrateur -Configurez le dépôt APT officiel de Docker pour Ubuntu 24.04 LTS (`noble`): +Ouvrez un navigateur et terminez la configuration administrateur unique: -```bash -sudo apt install -y ca-certificates curl -sudo install -m 0755 -d /etc/apt/keyrings -sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc -sudo chmod a+r /etc/apt/keyrings/docker.asc -sudo tee /etc/apt/sources.list.d/docker.sources >/dev/null </install ``` -Installez Docker Engine et le plugin Compose: +Creez le compte administrateur (adresse courriel et mot de passe de votre choix), puis +connectez-vous a `http:///`. -```bash -sudo apt update -sudo apt install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -``` +### 4. Ajouter un fournisseur de modèle -Autorisez l'utilisateur `ubuntu` à exécuter Docker sans sudo, puis rouvrez votre session SSH: +Depuis **Settings → Model Provider**, ajoutez un fournisseur LLM (comme OpenAI, Anthropic ou un +point de terminaison Ollama auto-hébergé) avant de creer des applications. -```bash -sudo usermod -aG docker ubuntu -``` +### 5. Consulter les identifiants génères -Clonez la dernière version de Dify, copiez le fichier d'environnement et démarrez la pile: +Les mots de passe internes de PostgreSQL et Redis sont écrits dans un fichier réservé à root: ```bash -sudo apt install -y git jq -git clone --branch "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r .tag_name)" https://github.com/langgenius/dify.git -cd dify/docker -cp .env.example .env -docker compose up -d +sudo cat /etc/dify/credentials.txt ``` -Confirmez que tous les conteneurs sont actifs: +## Gérer Dify -```bash -docker compose ps -``` +Dify s'exécute comme pile Docker Compose dans `/opt/dify/docker`. -## Configurer Dify +```bash +# Vérifier l'état +cd /opt/dify/docker && docker compose ps -Le conteneur nginx de la pile publie les ports 80 et 443. Ouvrez un navigateur et effectuez la -configuration initiale de l'administrateur: +# Redémarrer +cd /opt/dify/docker && docker compose restart -```text -http:///install +# Voir les journaux +cd /opt/dify/docker && docker compose logs -f ``` -Créez le compte administrateur, puis connectez-vous à `http:///`. Depuis **Settings → -Model Provider**, ajoutez un fournisseur de LLM (tel qu'OpenAI, Anthropic ou un point de terminaison -Ollama auto-hébergé) avant de créer des applications. - -Pour la production, modifiez `dify/docker/.env` afin de définir une URL publique et d'activer HTTPS. -Dify peut terminer TLS via son nginx intégré (définissez `NGINX_HTTPS_ENABLED=true` et montez les -certificats), ou vous pouvez l'exécuter derrière votre propre proxy inverse. Appliquez les -modifications avec: +Configuration d'environnement: `/opt/dify/docker/.env`. Les données persistantes sont stockées sous +`/opt/dify/docker/volumes`. -```bash -cd ~/dify/docker -docker compose down && docker compose up -d -``` +## Sécurité -## Ouvrir le pare-feu +Les ports 80 et 443 sont ouverts sur l'interface réseau de la machine virtuelle. UFW est activé et +autorise SSH (port 22), HTTP (80) et HTTPS (443). -L'instance n'autorise par défaut que SSH (port 22) en externe. Ouvrez les ports dont Dify a besoin -et ajoutez-les aux règles réseau/sécurité de l'instance dans le portail: +Dify sert HTTP en clair par défaut. **En production**, placez Dify derrière votre propre proxy +inverse avec TLS, ou configurez HTTPS et l'URL publique dans `/opt/dify/docker/.env`. Appliquez les +changements `.env` avec: ```bash -sudo ufw allow 80/tcp -sudo ufw allow 443/tcp +cd /opt/dify/docker && docker compose down && docker compose up -d ``` -## Étapes suivantes +## Prochaines étapes - [Documentation Dify](https://docs.dify.ai/) -- [Guide d'installation Dify](https://docs.dify.ai/en/getting-started/install-self-hosted/docker-compose) +- [Guide d'auto-hébergément Dify](https://docs.dify.ai/en/getting-started/install-self-hosted/docker-compose) diff --git a/src/content/docs/fr/public-cloud/marketplace/docker.md b/src/content/docs/fr/public-cloud/marketplace/docker.md index 4f380f1..001d68d 100644 --- a/src/content/docs/fr/public-cloud/marketplace/docker.md +++ b/src/content/docs/fr/public-cloud/marketplace/docker.md @@ -14,6 +14,15 @@ Compose préinstallés, prêt pour déployer toute charge de travail conteneuris | Plugin Docker Compose | Dernière stable | | Ubuntu | 24.04 LTS | +:::note + +Docker Engine 29 stocke les images dans le magasin d'images containerd lors d'une installation +neuve. Les images que vous téléchargez ou construisez y sont conservées plutôt que dans l'ancien +pilote de stockage, ce qui modifie la sortie de certaines commandes `docker image` et active les +images multiplateformes par défaut. + +::: + ## Bien démarrer ### 1. Connectez-vous à votre VM diff --git a/src/content/docs/fr/public-cloud/marketplace/drupal.md b/src/content/docs/fr/public-cloud/marketplace/drupal.md index cdf64fb..b925d44 100644 --- a/src/content/docs/fr/public-cloud/marketplace/drupal.md +++ b/src/content/docs/fr/public-cloud/marketplace/drupal.md @@ -2,18 +2,24 @@ title: Drupal --- -Drupal est un système de gestion de contenu libre pour créer aussi bien des sites simples que des -applications complexes riches en contenu. Son modèle d'entités, sa taxonomie et son écosystème de -modules permettent aux équipes de définir des types de contenu personnalisés, des flux éditoriaux et -des sites multilingues sans écrire la tuyauterie elles-mêmes. +Drupal est un système de gestion de contenu open source pour les sites et applications riches en +contenu. Son modèle d'entités, sa taxonomie et son écosystème de modules permettent aux équipes de +créer des types de contenu personnalisés, des flux éditoriaux et des sites multilingues sans écrire +elles-mêmes le code sous-jacent. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Drupal préconstruite arrive bientôt. Pour l'instant, déployez une instance **Ubuntu 24.04 -LTS** neuve depuis la place de marché et suivez les étapes ci-dessous pour installer Drupal -vous-même. +| Composant | Version | +| --------- | --------- | +| Drupal | 11.4.1 | +| PHP | 8.3 | +| Apache | Dernière | +| MariaDB | Dernière | +| Drush | 13 | +| Ubuntu | 24.04 LTS | -::: +Drupal s'exécute sur une pile LAMP native (Apache, MariaDB, PHP). Le site est préinstallé avec le +profil **Standard**. Il est donc prêt à utiliser dès que la machine virtuelle démarre. ## Prérequis @@ -23,117 +29,98 @@ vous-même. | RAM | 2 Go | 4 Go | | Stockage | 20 Go | 40 Go | -Drupal 11 fonctionne sur une pile LAMP (Linux, Apache, MySQL/MariaDB, PHP 8.3+). Les besoins en -stockage augmentent avec les téléversements de médias et le nombre de modules installés. - -## Déployer l'instance de base - -1. Dans le portail ZSoftly Cloud, ouvrez **Apps** et passez à l'onglet **Marketplace**. Il s'ouvre - sur **Featured** par défaut, sélectionnez donc **Marketplace** à côté. Choisissez votre région - (YOW-1 ou YUL-1), recherchez **Ubuntu 24.04 LTS** et cliquez sur **Deploy**. Vous pouvez aussi - créer l'instance depuis **Instances → Create**. Dans les deux cas, vous obtenez une VM Ubuntu - 24.04 propre. +Les besoins de stockage augmentent avec les téléversements de médias et le nombre de modules +installés. - ![L'onglet Marketplace du portail ZSoftly Cloud, avec le sélecteur de région, la liste des catégories, la barre de recherche et les boutons Deploy](../../../../../assets/marketplace/deploy-marketplace-tab.webp) +## Démarrage - ![Recherche d'une application dans le Marketplace, la barre de recherche filtrant le catalogue jusqu'à une carte Deploy correspondante](../../../../../assets/marketplace/deploy-marketplace-search.webp) - -2. Choisissez un plan qui répond aux prérequis ci-dessus. - -3. Lorsque l'instance est **Running**, connectez-vous en SSH: +### 1. Se connecter à la machine virtuelle ```bash ssh ubuntu@ ``` -4. Mettez le système à jour: +### 2. Attendre la configuration au premier démarrage + +Au premier démarrage, un script crée la base de données, installe le site Drupal avec Drush, puis +génère les mots de passe administrateur et base de données. Cela prend 1 à 2 minutes. Suivez la +progression: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u drupal-first-boot.service -f ``` -## Installer la pile LAMP +Le message de connexion (MOTD) confirme quand Drupal est prêt. -Installez Apache, MariaDB, PHP 8.3 et les extensions PHP dont Drupal a besoin: +### 3. Récupérer les identifiants administrateur + +Le mot de passe administrateur, ainsi que les identifiants de base de données, sont écrits dans un +fichier réservé à root: ```bash -sudo apt install -y apache2 mariadb-server \ - php php-cli php-mysql php-gd php-xml php-mbstring php-curl php-zip php-intl php-apcu \ - libapache2-mod-php composer git unzip +sudo cat /root/.credentials/drupal.txt ``` -Sécurisez la base de données et répondez aux invites (définissez un mot de passe root, supprimez les -utilisateurs anonymes et interdisez la connexion root à distance): +### 4. Se connecter à l'administration -```bash -sudo mysql_secure_installation +Ouvrez le site dans un navigateur: + +```text +http:/// ``` -Créez une base de données et un utilisateur dédié pour Drupal: +Connectez-vous depuis la page d'administration: -```bash -sudo mysql <<'SQL' -CREATE DATABASE drupal CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci; -CREATE USER 'drupal'@'localhost' IDENTIFIED BY 'change-this-password'; -GRANT ALL PRIVILEGES ON drupal.* TO 'drupal'@'localhost'; -FLUSH PRIVILEGES; -SQL +```text +http:///user/login ``` -## Installer Drupal +| Champ | Valeur | +| ----------------- | -------------------------------------- | +| Nom d'utilisateur | `admin` | +| Mot de passe | Depuis `/root/.credentials/drupal.txt` | + +## Gérer Drupal -Créez le projet avec Composer et confiez la propriété du répertoire racine à Apache: +Drupal est servi par Apache avec MariaDB. Les deux services sont gérés par systemd. ```bash -cd /var/www -sudo composer create-project drupal/recommended-project drupal -sudo chown -R www-data:www-data /var/www/drupal -``` +# Etat des services +systemctl status apache2 +systemctl status mariadb -Pointez Apache vers le répertoire racine `web/` et activez la réécriture d'URL: +# Redémarrer le serveur web +sudo systemctl restart apache2 -```bash -sudo tee /etc/apache2/sites-available/drupal.conf >/dev/null <<'EOF' - - DocumentRoot /var/www/drupal/web - - AllowOverride All - Require all granted - - ErrorLog ${APACHE_LOG_DIR}/drupal-error.log - CustomLog ${APACHE_LOG_DIR}/drupal-access.log combined - -EOF -sudo a2ensite drupal -sudo a2dissite 000-default -sudo a2enmod rewrite -sudo systemctl reload apache2 +# Exécuter des commandes Drush depuis la racine du projet +cd /var/www/drupal && vendor/bin/drush status +cd /var/www/drupal && vendor/bin/drush cache:rebuild ``` -## Terminer l'installateur Web +| Chemin | Rôle | +| ------------------------------------------------ | ----------------------------- | +| `/var/www/drupal` | Racine du projet | +| `/var/www/drupal/web` | Racine web | +| `/var/www/drupal/web/sites/default/settings.php` | Configuration du site | +| `/var/www/drupal/web/sites/default/files` | Fichiers et médias téléversés | -Ouvrez le site dans un navigateur et suivez l'assistant de configuration: +## Sécurité -```text -http:/// -``` +Le port 80 est ouvert sur l'interface réseau de la machine virtuelle. UFW est activé et autorise SSH +(port 22) et HTTP (port 80). L'image sert uniquement HTTP en clair. -Choisissez le profil **Standard**, puis saisissez le nom de la base de données, l'utilisateur et le -mot de passe créés ci-dessus. L'installateur écrit `web/sites/default/settings.php` et crée le -compte administrateur. Pour la production, placez l'instance derrière votre propre domaine et -activez HTTPS (par exemple avec Certbot et le greffon Apache). +:::caution -## Ouvrir le pare-feu +Le site est livré avec `$settings['trusted_host_patterns']` configuré pour autoriser tout hôte +(`^.+$`). Avant de publier le site sur un domaine public, resserrez ce réglage dans +`/var/www/drupal/web/sites/default/settings.php` afin qu'il corresponde à votre nom d'hôte. -L'instance n'autorise par défaut que SSH (port 22) en externe. Ouvrez HTTP et HTTPS, et ajoutez les -mêmes ports aux règles réseau/sécurité de l'instance dans le portail: +::: -```bash -sudo ufw allow 80/tcp -sudo ufw allow 443/tcp -``` +**En production**, placez l'instance derrière un proxy inverse avec TLS (par exemple Nginx ou Caddy) +afin que le site soit servi en HTTPS, puis mettez à jour `trusted_host_patterns` en conséquence. -## Étapes suivantes +## Prochaines étapes - [Documentation Drupal](https://www.drupal.org/docs) -- [Installer Drupal](https://www.drupal.org/docs/getting-started/installing-drupal) +- [Documentation Drush](https://www.drush.org/) diff --git a/src/content/docs/fr/public-cloud/marketplace/elasticsearch.md b/src/content/docs/fr/public-cloud/marketplace/elasticsearch.md index 5037060..a3d1c14 100644 --- a/src/content/docs/fr/public-cloud/marketplace/elasticsearch.md +++ b/src/content/docs/fr/public-cloud/marketplace/elasticsearch.md @@ -1,5 +1,5 @@ --- -title: Elasticsearch 8 +title: Elasticsearch 9 --- Elasticsearch est un moteur distribué de recherche et d'analyse RESTful basé sur Apache Lucene. Il @@ -10,7 +10,7 @@ l'analyse de données en temps réel. | Composant | Version | | ------------- | --------- | -| Elasticsearch | 8.x | +| Elasticsearch | 9.x | | Ubuntu | 24.04 LTS | ## Variables d'environnement @@ -40,7 +40,7 @@ Au premier démarrage, un script de configuration s'exécute automatiquement. Il - réinitialise le mot de passe du superutilisateur `elastic` avec une valeur générée aléatoirement; - enregistre le mot de passe dans `/etc/elasticsearch/elastic-password.txt`. -Elasticsearch 8 prend de 60 à 90 secondes pour démarrer avant que la réinitialisation du mot de +Elasticsearch 9 prend de 60 à 90 secondes pour démarrer avant que la réinitialisation du mot de passe puisse s'exécuter. La durée totale du premier démarrage est d'environ 2 à 3 minutes. Suivez la progression: @@ -60,7 +60,7 @@ Ce fichier contient le mot de passe du superutilisateur `elastic`. Il est lisibl ### 4. Connectez-vous à Elasticsearch -Elasticsearch 8 utilise HTTPS avec un certificat autosigné par défaut. Utilisez `-k` pour ignorer la +Elasticsearch 9 utilise HTTPS avec un certificat autosigné par défaut. Utilisez `-k` pour ignorer la vérification du certificat lors des connexions locales, ou utilisez le certificat CA situé à `/etc/elasticsearch/certs/http_ca.crt`. @@ -133,7 +133,7 @@ curl -k -u elastic:"" https://localhost:9200 :::caution -Elasticsearch 8 active la sécurité par défaut. L'utilisateur `elastic` dispose d'un accès complet au +Elasticsearch 9 active la sécurité par défaut. L'utilisateur `elastic` dispose d'un accès complet au cluster. Créez des utilisateurs à portée de rôle pour chaque application. ::: diff --git a/src/content/docs/fr/public-cloud/marketplace/forgejo.md b/src/content/docs/fr/public-cloud/marketplace/forgejo.md index 43cae9b..9a5df3d 100644 --- a/src/content/docs/fr/public-cloud/marketplace/forgejo.md +++ b/src/content/docs/fr/public-cloud/marketplace/forgejo.md @@ -4,16 +4,20 @@ title: Forgejo Forgejo est une forge Git auto-hébergée, maintenue comme un fork communautaire de Gitea. Elle regroupe l'hébergement de dépôts, les pull requests, le suivi des tickets, les paquets et les -actions CI dans un seul binaire Go qui tourne bien sur du matériel modeste. L'interface web -s'exécute sur le port 3000 et Git via SSH sur le port 22. +actions CI dans un seul binaire Go qui tourne bien sur du matériel modeste. Cette image fournit la +ligne LTS de Forgejo, publiée chaque mois d'avril et prise en charge environ 15 mois. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Forgejo préconfigurée arrive bientôt. Pour l'instant, déployez une nouvelle instance -**Ubuntu 24.04 LTS** depuis la marketplace et suivez les étapes ci-dessous pour installer Forgejo -vous-même. +| Composant | Version | +| ---------- | --------------- | +| Forgejo | 15.0.3 (LTS) | +| PostgreSQL | 18 | +| Docker | Dernière stable | +| Ubuntu | 24.04 LTS | -::: +Forgejo s'exécute avec PostgreSQL sous forme de pile Docker Compose. L'interface web est servie sur +le port 3000 et Git via SSH sur le port 2222, ce qui laisse le démon SSH de la VM sur le port 22. ## Prérequis @@ -23,102 +27,120 @@ vous-même. | RAM | 1 Go | 2 Go | | Stockage | 20 Go | 40 Go | -## Déployer l'instance de base +## Variables d'environnement + +Vous pouvez définir ces variables au moment du déploiement depuis la marketplace. Laissez un champ +de mot de passe vide pour qu'une valeur aléatoire sûre soit générée automatiquement. + +| Variable | Description | +| ------------------------ | ------------------------------------------------------------------ | +| `FORGEJO_ADMIN_PASSWORD` | Mot de passe du compte initial `zadmin` | +| `FORGEJO_DB_PASSWORD` | Mot de passe de l'utilisateur PostgreSQL `forgejo` | +| `FORGEJO_DOMAIN` | Nom d'hôte public utilisé dans les URL de clonage, par défaut l'IP | -1. Dans le portail ZSoftly Cloud, ouvrez **Apps**, sélectionnez **Forgejo** et cliquez sur - **Deploy**, ou créez une instance **Ubuntu 24.04 LTS** depuis **Instances → Create**. Dans les - deux cas, vous obtenez une VM Ubuntu 24.04 propre. -2. Choisissez un plan qui répond aux prérequis ci-dessus et sélectionnez votre région (YOW-1 ou - YUL-1). -3. Lorsque l'instance est **Running**, connectez-vous en SSH : +## Démarrage + +### 1. Connectez-vous à votre VM ```bash ssh ubuntu@ ``` -4. Mettez le système à jour : +### 2. Attendez la configuration au premier démarrage + +Au premier démarrage, un script génère le mot de passe de la base de données, démarre Forgejo et +PostgreSQL avec Docker Compose, puis crée le compte administrateur. Comptez 1 à 2 minutes. Suivez la +progression: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u forgejo-first-boot.service -f ``` -## Installer Forgejo +Le message de connexion (MOTD) confirme que Forgejo est prêt et affiche les identifiants +d'administration. + +### 3. Récupérez les identifiants d'administration -Installez d'abord Git et quelques dépendances : +Les identifiants sont aussi écrits dans un fichier réservé à root: ```bash -sudo apt install -y git git-lfs +sudo cat /etc/forgejo/credentials.txt ``` -Téléchargez le dernier binaire Forgejo et installez-le dans `/usr/local/bin`. Consultez la -[page de téléchargement Forgejo](https://forgejo.org/download/) pour la version actuelle et -remplacez `15.0.3` ci-dessous si une version plus récente est disponible : +### 4. Accédez à l'interface web -```bash -wget -O forgejo \ - https://codeberg.org/forgejo/forgejo/releases/download/v15.0.3/forgejo-15.0.3-linux-amd64 -sudo cp forgejo /usr/local/bin/forgejo -sudo chmod 755 /usr/local/bin/forgejo +Ouvrez un navigateur à l'adresse: + +```text +http://:3000 ``` -Créez un utilisateur système `git` dédié sous lequel Forgejo s'exécute : +Connectez-vous en tant que `zadmin` avec le mot de passe généré. L'installateur web est verrouillé, +l'instance est donc configurée dès son démarrage. -```bash -sudo adduser --system --shell /bin/bash --gecos 'Git Version Control' \ - --group --disabled-password --home /home/git git -``` +:::note -Créez les répertoires de données et de configuration : +`admin` est un nom d'utilisateur réservé dans Forgejo, le compte administrateur s'appelle donc +`zadmin`. + +::: + +### 5. Clonez via SSH + +Ajoutez votre clé publique dans **Paramètres → Clés SSH / GPG**, puis clonez sur le port 2222: ```bash -sudo mkdir -p /var/lib/forgejo -sudo chown git:git /var/lib/forgejo && sudo chmod 750 /var/lib/forgejo -sudo mkdir /etc/forgejo -sudo chown root:git /etc/forgejo && sudo chmod 770 /etc/forgejo +git clone ssh://git@:2222//.git ``` -Installez le service systemd fourni avec Forgejo, puis activez-le et démarrez-le : +## Gérer Forgejo + +Forgejo et PostgreSQL s'exécutent sous forme de pile Docker Compose dans `/opt/forgejo`. ```bash -sudo wget -O /etc/systemd/system/forgejo.service \ - https://codeberg.org/forgejo/forgejo/raw/branch/forgejo/contrib/systemd/forgejo.service -sudo systemctl daemon-reload -sudo systemctl enable --now forgejo -sudo systemctl status forgejo +# Vérifier l'état +cd /opt/forgejo && docker compose ps + +# Redémarrer +cd /opt/forgejo && docker compose restart + +# Consulter les journaux +cd /opt/forgejo && docker compose logs -f server ``` -## Configurer Forgejo +Les données des dépôts se trouvent dans `/opt/forgejo/data/forgejo` et la base de données dans +`/opt/forgejo/data/postgres`. La configuration est générée dans +`/opt/forgejo/data/forgejo/gitea/conf/app.ini`, et la plupart des réglages peuvent être remplacés +par des variables d'environnement `FORGEJO__section__KEY` dans le fichier compose. -Forgejo écoute sur le port 3000. Ouvrez `http://:3000` dans un navigateur pour exécuter -l'assistant d'installation initial. Acceptez la base de données SQLite par défaut pour une petite -instance, ou orientez Forgejo vers PostgreSQL/MySQL pour des déploiements plus importants. +## Sécurité -Avant de terminer, définissez l'**Application URL** sur l'adresse de votre serveur et créez le -premier compte administrateur en bas du formulaire. Le premier utilisateur enregistré devient -l'administrateur. L'assistant écrit ses paramètres dans `/etc/forgejo/app.ini`. Renforcez donc les -permissions des fichiers ensuite : +Les ports 3000 (HTTP) et 2222 (Git via SSH) sont ouverts sur l'interface réseau de la VM. UFW est +activé et autorise ces ports ainsi que SSH (port 22). -```bash -sudo chmod 750 /etc/forgejo -sudo chmod 640 /etc/forgejo/app.ini -``` +Chaque VM génère ses propres `SECRET_KEY` et `INTERNAL_TOKEN` au premier démarrage de Forgejo, si +bien qu'aucun déploiement ne partage ses secrets de chiffrement avec un autre. -Pour une configuration de production, placez Forgejo derrière un reverse proxy tel que nginx avec un -certificat TLS, puis servez l'interface en HTTPS au lieu d'exposer directement le port 3000. +:::caution -## Ouvrir le pare-feu +Ne copiez pas `app.ini` d'une VM à l'autre et ne changez pas `SECRET_KEY` après usage. Les secrets +de double authentification et les identifiants stockés deviendraient impossibles à déchiffrer. + +::: -L'instance n'autorise par défaut que le SSH (port 22) en externe. Ouvrez le ou les ports dont -Forgejo a besoin et ajoutez-les aux règles réseau/de sécurité de l'instance dans le portail : +**Pour restreindre l'accès à une adresse IP précise:** ```bash -sudo ufw allow 3000/tcp +sudo ufw delete allow 3000/tcp +sudo ufw allow from to any port 3000 ``` -Git via SSH utilise le port 22 existant. Pour exécuter plutôt le serveur SSH intégré de Forgejo sur -un port distinct, ouvrez également ce port (par exemple `sudo ufw allow 2222/tcp`). +**En production**, pointez un enregistrement DNS vers la VM et placez Forgejo derrière un reverse +proxy TLS (Caddy, nginx ou Traefik), puis définissez `FORGEJO_DOMAIN` pour que les URL de clonage +correspondent. -## Étapes suivantes +## Prochaines étapes - [Documentation Forgejo](https://forgejo.org/docs/latest/) -- [Guide d'installation Forgejo](https://forgejo.org/docs/latest/admin/installation/binary/) +- [Guide d'administration Forgejo](https://forgejo.org/docs/latest/admin/) +- [Forgejo Actions](https://forgejo.org/docs/latest/user/actions/) diff --git a/src/content/docs/fr/public-cloud/marketplace/ghost.md b/src/content/docs/fr/public-cloud/marketplace/ghost.md index df19af2..0e68fa6 100644 --- a/src/content/docs/fr/public-cloud/marketplace/ghost.md +++ b/src/content/docs/fr/public-cloud/marketplace/ghost.md @@ -2,18 +2,19 @@ title: Ghost --- -Ghost est une plateforme de publication open source pour les blogs, les infolettres et les sites -d'adhésion. Elle associe un éditeur rapide et une distribution d'e-mails intégrée à une interface -épurée pilotée par des thèmes. L'outil officiel `ghost-cli` installe et gère un déploiement de -production sur Ubuntu. +Ghost est une plateforme de publication open source pour blogues, infolettres et sites avec +abonnements. Elle associe un éditeur rapide et l'envoi de courriels intégré à une interface publique +rapide, pilotée par des thèmes. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Ghost préconfigurée arrive bientôt. Pour l'instant, déployez une nouvelle instance -**Ubuntu 24.04 LTS** depuis la marketplace et suivez les étapes ci-dessous pour installer Ghost -vous-même. - -::: +| Composant | Version | +| --------- | --------- | +| Ghost | 6.51.0 | +| Node.js | 22.x | +| MySQL | 8.0 | +| nginx | Dernière | +| Ubuntu | 24.04 LTS | ## Prérequis @@ -23,104 +24,99 @@ vous-même. | RAM | 2 Go | 4 Go | | Stockage | 20 Go | 40 Go | -## Déployer l'instance de base +:::caution + +Ghost exige un nom de domaine. Il ne fonctionne pas avec une simple adresse IP. Fournissez +`GHOST_URL` au déploiement (voir ci-dessous) et pointez le DNS de ce domaine vers la machine +virtuelle. + +::: -1. Dans le portail ZSoftly Cloud, ouvrez **Apps** et passez à l'onglet **Marketplace**. Il s'ouvre - sur **Featured** par défaut, sélectionnez donc **Marketplace** à côté. Choisissez votre région - (YOW-1 ou YUL-1), recherchez **Ubuntu 24.04 LTS** et cliquez sur **Deploy**. Vous pouvez aussi - créer l'instance depuis **Instances → Create**. Dans les deux cas, vous obtenez une VM Ubuntu - 24.04 propre. +## Variables d'environnement - ![L'onglet Marketplace du portail ZSoftly Cloud, avec le sélecteur de région, la liste des catégories, la barre de recherche et les boutons Deploy](../../../../../assets/marketplace/deploy-marketplace-tab.webp) +Vous pouvez les définir au déploiement de Ghost depuis la Marketplace. Laissez `GHOST_DB_PASSWORD` +vide pour générer automatiquement une valeur aléatoire sécurisée. - ![Recherche d'une application dans le Marketplace, la barre de recherche filtrant le catalogue jusqu'à une carte Deploy correspondante](../../../../../assets/marketplace/deploy-marketplace-search.webp) +| Variable | Description | +| ------------------- | ------------------------------------------------------------ | +| `GHOST_URL` | URL complète du site, par exemple `https://blog.example.com` | +| `GHOST_DB_PASSWORD` | Mot de passe de l'utilisateur MySQL `ghost` | -2. Choisissez un plan qui répond aux prérequis ci-dessus. +Si `GHOST_URL` n'est pas définie, la machine virtuelle sert une page temporaire et laisse Ghost non +configuré jusqu'à ce que vous fournissiez un domaine. -3. Lorsque l'instance est **Running**, connectez-vous en SSH : +## Démarrage + +### 1. Se connecter à la machine virtuelle ```bash ssh ubuntu@ ``` -4. Mettez le système à jour : +### 2. Attendre la configuration au premier démarrage + +Au premier démarrage, un script crée la base MySQL, configure Ghost pour votre `GHOST_URL`, écrit +l'hôte virtuel nginx et démarre le site comme service systemd. Cela prend 1 à 2 minutes. Suivez la +progression: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u ghost-first-boot.service -f ``` -## Installer Ghost +Le message de connexion (MOTD) confirme quand Ghost est prêt. -Le guide officiel de Ghost vise **Ubuntu 24.04 LTS**. Une installation de production nécessite -**nginx**, **MySQL 8**, une version LTS de **Node.js** et un **nom de domaine** enregistré. Ghost -échoue lorsqu'il est installé sur une adresse IP nue. +### 3. Terminer la configuration administrateur -Installez nginx et MySQL 8 : +Ouvrez l'administration dans un navigateur et créez le premier compte administrateur: -```bash -sudo apt install -y nginx mysql-server -sudo ufw allow 'Nginx Full' +```text +https://your-domain.com/ghost ``` -Installez une version LTS prise en charge de Node.js (Ghost prend en charge les lignes LTS actives, -cet exemple utilise la 22) : +Les identifiants de base de données générés sont écrits dans un fichier réservé à root: ```bash -sudo apt-get install -y ca-certificates curl gnupg -sudo mkdir -p /etc/apt/keyrings -curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key \ - | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg -echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_22.x nodistro main" \ - | sudo tee /etc/apt/sources.list.d/nodesource.list -sudo apt-get update && sudo apt-get install -y nodejs +sudo cat /etc/ghost/credentials.txt ``` -Installez la CLI Ghost globalement : +### 4. Activer HTTPS -```bash -sudo npm install ghost-cli@latest -g -``` - -Créez le répertoire d'installation (appartenant à l'utilisateur `ubuntu`) et lancez l'installateur -depuis l'intérieur de celui-ci : +TLS n'est pas configuré automatiquement, car le DNS de votre domaine doit d'abord pointer vers la +machine virtuelle. Une fois la résolution DNS active, provisionnez un certificat Let's Encrypt +gratuit: ```bash -sudo mkdir -p /var/www/ghost -sudo chown ubuntu:ubuntu /var/www/ghost -sudo chmod 775 /var/www/ghost cd /var/www/ghost -ghost install +ghost setup ssl ``` -## Configurer Ghost +## Gérer Ghost -`ghost install` est interactif. Il demande l'URL de votre site (utilisez `https://your-domain.com`), -configure la base de données MySQL, met en place le service systemd et l'hôte virtuel nginx, et -propose de provisionner un certificat TLS Let's Encrypt gratuit. Acceptez-le pour un site de -production. +Ghost s'exécute comme service systemd par site nommé `ghost_` (par exemple +`ghost_blog-example-com`). Gérez-le depuis le répertoire d'installation: -À l'invite de la connexion MySQL, fournissez le mot de passe root que vous avez défini ci-dessus. -Ghost crée sa propre base de données et son propre utilisateur. Après l'installation, terminez la -configuration de l'administration à l'adresse : +```bash +# Afficher l'instance en cours et son nom de service +cd /var/www/ghost && ghost ls -```text -https://your-domain.com/ghost +# Redémarrer, arrêter et démarrer +ghost restart +ghost stop +ghost start ``` -Gérez l'instance avec les commandes `ghost` depuis `/var/www/ghost` (`ghost ls`, `ghost stop`, -`ghost start`, `ghost restart`). +Répertoire d'installation: `/var/www/ghost`. Le contenu (thèmes, images et données) se trouve sous +`/var/www/ghost/content`. -## Ouvrir le pare-feu +## Sécurité -L'instance n'autorise par défaut que le SSH (port 22) en externe. Ouvrez le ou les ports dont Ghost -a besoin et ajoutez-les aux règles réseau/de sécurité de l'instance dans le portail : +Les ports 80 et 443 sont ouverts sur l'interface réseau de la machine virtuelle. UFW est activé et +autorise SSH (port 22), HTTP (80) et HTTPS (443). -```bash -sudo ufw allow 80/tcp -sudo ufw allow 443/tcp -``` +**En production**, terminez l'étape Let's Encrypt ci-dessus afin que le site soit servi en HTTPS, et +limitez l'accès SSH aux plages IP connues. -## Étapes suivantes +## Prochaines étapes -- [Documentation Ghost](https://docs.ghost.org/) -- [Guide d'installation Ghost](https://docs.ghost.org/install/ubuntu) +- [Documentation Ghost](https://ghost.org/docs/) +- [Configurer Ghost](https://ghost.org/docs/config/) diff --git a/src/content/docs/fr/public-cloud/marketplace/gitlab.md b/src/content/docs/fr/public-cloud/marketplace/gitlab.md index 732c72c..8baad66 100644 --- a/src/content/docs/fr/public-cloud/marketplace/gitlab.md +++ b/src/content/docs/fr/public-cloud/marketplace/gitlab.md @@ -1,5 +1,5 @@ --- -title: GitLab CE 18.11 +title: GitLab CE 19.1 --- GitLab Community Edition est une plateforme DevOps complète fournie sous forme d'application unique. @@ -10,7 +10,7 @@ conteneurs et plus encore. L'ensemble s'exécute sur votre propre infrastructure | Composant | Version | | --------- | --------- | -| GitLab CE | 18.11.x | +| GitLab CE | 19.1.x | | Ubuntu | 24.04 LTS | ## Variables d'environnement diff --git a/src/content/docs/fr/public-cloud/marketplace/headplane.md b/src/content/docs/fr/public-cloud/marketplace/headplane.md index 6bbd16f..0e300dc 100644 --- a/src/content/docs/fr/public-cloud/marketplace/headplane.md +++ b/src/content/docs/fr/public-cloud/marketplace/headplane.md @@ -6,15 +6,7 @@ Headplane est une interface web complète pour [Headscale](https://headscale.net open source et auto-hébergée du serveur de contrôle Tailscale. Elle permet de gérer les nœuds, les clés de pré-authentification, les ACL et le DNS depuis un navigateur plutôt que via la CLI Headscale. Headplane ne remplace pas Headscale. Elle gère un serveur Headscale en cours d'exécution, -vous déployez donc les deux ensemble sur cette instance. - -:::note[Bientôt disponible] - -Une image Headplane préconfigurée arrive bientôt. Pour l'instant, déployez une instance **Ubuntu -24.04 LTS** neuve depuis la marketplace et suivez les étapes ci-dessous pour installer Headplane -vous-même. - -::: +c'est pourquoi cette image fournit les deux ensemble. :::tip[Headscale est le serveur, pas le client] @@ -25,6 +17,19 @@ clients Tailscale vers l'URL de ce serveur. ::: +## Logiciels inclus + +| Composant | Version | +| --------- | --------------- | +| Headplane | 0.7.0 | +| Headscale | 0.29.2 | +| Docker | Dernière stable | +| Ubuntu | 24.04 LTS | + +Headplane ne peut pas fonctionner seule, car chacune de ses actions est un appel à l'API Headscale. +Cette image exécute le serveur de contrôle Headscale et l'interface Headplane ensemble, sous forme +de pile Docker Compose. + ## Prérequis | Ressource | Minimum | Recommandé | @@ -33,144 +38,118 @@ clients Tailscale vers l'URL de ce serveur. | RAM | 1 Go | 2 Go | | Stockage | 10 Go | 20 Go | -## Déployer l'instance de base +## Variables d'environnement -1. Dans le portail ZSoftly Cloud, ouvrez **Apps** et passez à l'onglet **Marketplace**. Il s'ouvre - sur **Featured** par défaut, sélectionnez donc **Marketplace** à côté. Choisissez votre région - (YOW-1 ou YUL-1), recherchez **Ubuntu 24.04 LTS** et cliquez sur **Deploy**. Vous pouvez aussi - créer l'instance depuis **Instances → Create**. Dans les deux cas, vous obtenez une VM Ubuntu - 24.04 propre. +Vous pouvez définir ces variables au moment du déploiement depuis la marketplace. Laissez-les vides +pour utiliser l'adresse de la machine virtuelle. - ![L'onglet Marketplace du portail ZSoftly Cloud, avec le sélecteur de région, la liste des catégories, la barre de recherche et les boutons Deploy](../../../../../assets/marketplace/deploy-marketplace-tab.webp) +| Variable | Description | +| ---------------------- | ---------------------------------------------------------------------------- | +| `HEADSCALE_SERVER_URL` | URL publique par laquelle vos appareils joignent Headscale, un domaine HTTPS | +| `HEADPLANE_BASE_URL` | URL publique depuis laquelle l'interface Headplane est servie | - ![Recherche d'une application dans le Marketplace, la barre de recherche filtrant le catalogue jusqu'à une carte Deploy correspondante](../../../../../assets/marketplace/deploy-marketplace-search.webp) +Définissez-les lorsque vous placez la machine virtuelle derrière un nom DNS ou un reverse proxy TLS. +`HEADSCALE_SERVER_URL` doit être une adresse que vos appareils peuvent réellement joindre, sinon +l'enregistrement des nœuds échoue. -2. Choisissez un plan qui répond aux prérequis ci-dessus. +## Démarrage -3. Lorsque l'instance est **Running**, connectez-vous en SSH: +### 1. Connectez-vous à votre VM ```bash ssh ubuntu@ ``` -4. Mettez le système à jour: +### 2. Attendez la configuration au premier démarrage + +Au premier démarrage, un script écrit l'adresse de la VM dans les configurations Headscale et +Headplane, génère un secret de session, démarre les deux services, crée un utilisateur Headscale +nommé `default` et génère une clé d'API. Comptez 1 à 2 minutes. Suivez la progression: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u headplane-first-boot.service -f ``` -## Installer Headplane +Le message de connexion (MOTD) confirme que Headplane est prête et affiche la clé d'API. + +### 3. Récupérez la clé d'API -Headplane et Headscale sont distribués sous forme d'images Docker et s'exécutent ensemble via Docker -Compose. Installez d'abord Docker: +La clé est aussi écrite dans un fichier réservé à root: ```bash -curl -fsSL https://get.docker.com | sudo sh -sudo usermod -aG docker ubuntu +sudo cat /etc/headplane/credentials.txt ``` -Déconnectez-vous puis reconnectez-vous pour que votre utilisateur prenne en compte le groupe -`docker`, puis créez un répertoire de travail: +### 4. Connectez-vous à Headplane -```bash -mkdir -p ~/headplane && cd ~/headplane -mkdir -p config data +Ouvrez un navigateur à l'adresse: + +```text +http://:3000/admin ``` -Créez `~/headplane/compose.yaml`: - -```yaml -services: - headscale: - image: headscale/headscale:0.26.0 - container_name: headscale - restart: unless-stopped - command: serve - ports: - - '8080:8080' - volumes: - - './config/headscale.yaml:/etc/headscale/config.yaml' - - './data/headscale:/var/lib/headscale' - labels: - me.tale.headplane.target: headscale - - headplane: - image: ghcr.io/tale/headplane:latest - container_name: headplane - restart: unless-stopped - ports: - - '3000:3000' - volumes: - - './config/headplane.yaml:/etc/headplane/config.yaml' - - './config/headscale.yaml:/etc/headscale/config.yaml' - - './data/headplane:/var/lib/headplane' - - '/var/run/docker.sock:/var/run/docker.sock:ro' +Headplane s'authentifie auprès de Headscale avec une clé d'API. Collez la clé de l'étape précédente +dans le formulaire de connexion. La clé expire après 90 jours. Vous pouvez en générer une nouvelle à +tout moment: + +```bash +docker exec headscale headscale apikeys create --expiration 90d ``` -Téléchargez une configuration Headscale dans `config/headscale.yaml` et définissez `server_url` sur -votre URL publique (par exemple `https://hs.example.com`). Créez ensuite `config/headplane.yaml` -avec l'intégration Headscale et un secret de cookie: - -```yaml -server: - host: '0.0.0.0' - port: 3000 - cookie_secret: '<32-character-random-string>' - cookie_secure: false - -headscale: - url: 'http://headscale:8080' - config_path: '/etc/headscale/config.yaml' - config_strict: true - -integration: - docker: - enabled: true - container_name: 'headscale' - socket: 'unix:///var/run/docker.sock' +### 5. Rattachez un appareil + +Pointez n'importe quel client Tailscale vers votre serveur Headscale: + +```bash +tailscale up --login-server http://:8080 ``` -Générez un secret de cookie avec `openssl rand -hex 16` et collez-le dans `cookie_secret`. Démarrez -la pile: +Approuvez le nœud depuis l'interface Headplane, ou listez les nœuds en ligne de commande: ```bash -docker compose up -d +docker exec headscale headscale nodes list ``` -## Configurer Headplane +## Gérer Headplane + +Headscale et Headplane s'exécutent sous forme de pile Docker Compose dans `/opt/headplane`. + +```bash +# Vérifier l'état +cd /opt/headplane && docker compose ps + +# Redémarrer +cd /opt/headplane && docker compose restart + +# Consulter les journaux +cd /opt/headplane && docker compose logs -f headscale +``` -1. Ouvrez Headplane dans votre navigateur à l'adresse `http://:3000`. -2. Headplane s'authentifie auprès de Headscale avec une clé API. Générez-en une à l'intérieur du - conteneur Headscale et utilisez-la (ou collez-la dans l'interface lorsqu'elle vous est demandée): +La configuration de Headscale se trouve dans `/opt/headplane/headscale/config/config.yaml` et sa +base de données sous `/opt/headplane/headscale/data`. Les politiques ACL sont stockées en base de +données, vous pouvez donc les modifier directement depuis l'interface Headplane. - ```bash - docker exec headscale headscale apikeys create - ``` +## Sécurité -3. Pour l'authentification unique (SSO), ajoutez un bloc `oidc` à `config/headplane.yaml` avec les - champs `issuer`, `client_id` et `client_secret` de votre fournisseur, puis redémarrez avec - `docker compose restart headplane`. -4. Placez un reverse proxy (Caddy, Nginx ou Traefik) en frontal pour terminer le TLS et servir à la - fois le `server_url` de Headscale et l'interface Headplane en HTTPS. Définissez - `cookie_secure: true` une fois le HTTPS en place. Le TLS est requis pour les tailnets de - production. +Les ports 3000 (interface Headplane) et 8080 (Headscale) sont ouverts sur l'interface réseau de la +VM. UFW est activé et autorise ces ports ainsi que SSH (port 22). -## Ouvrir le pare-feu +Vos appareils doivent joindre Headscale sur le port 8080, mais l'interface Headplane n'a pas besoin +d'être publique. -Par défaut, l'instance n'autorise que le SSH (port 22) depuis l'extérieur. Ouvrez les ports dont -Headplane et Headscale ont besoin et ajoutez-les aux règles réseau/sécurité de l'instance dans le -portail: +**Pour restreindre l'interface à une adresse IP précise:** ```bash -sudo ufw allow 3000/tcp -sudo ufw allow 8080/tcp +sudo ufw delete allow 3000/tcp +sudo ufw allow from to any port 3000 ``` -Le port 3000 sert l'interface Headplane et le port 8080 est le serveur de contrôle Headscale. Si -vous les placez derrière un reverse proxy, exposez plutôt les ports 80/443 et gardez ces ports -internes. +**En production**, pointez un enregistrement DNS vers la VM et terminez le TLS avec un reverse proxy +(Caddy, nginx ou Traefik). Définissez `HEADSCALE_SERVER_URL` et `HEADPLANE_BASE_URL` sur les URL +HTTPS, et passez `cookie_secure: true` dans `/opt/headplane/headplane/config.yaml`. -## Étapes suivantes +## Prochaines étapes - [Documentation Headplane](https://headplane.net) -- [Guide d'installation de Headplane](https://github.com/tale/headplane) +- [Documentation Headscale](https://headscale.net) +- [Politiques ACL Headscale](https://headscale.net/stable/ref/acls/) diff --git a/src/content/docs/fr/public-cloud/marketplace/index.md b/src/content/docs/fr/public-cloud/marketplace/index.md index b26eb89..676fcbb 100644 --- a/src/content/docs/fr/public-cloud/marketplace/index.md +++ b/src/content/docs/fr/public-cloud/marketplace/index.md @@ -3,22 +3,22 @@ title: Marketplace tableOfContents: false --- -Les images du Marketplace ZCP sont des modèles de VM préconfigurés qui se déploient en quelques -minutes depuis la console ZCP. Chaque image est fournie sur **Ubuntu 24.04 LTS** avec un service de -premier démarrage qui termine automatiquement la configuration. Les identifiants sont générés, les -services sont configurés et l'image est prête à utiliser. +Les images de la Marketplace ZCP sont des modèles de machine virtuelle préconfigurés qui se +déploient en quelques minutes depuis la console ZCP. Chaque image est fournie sur **Ubuntu 24.04 +LTS** avec un service de premier démarrage qui termine la configuration automatiquement. Les +identifiants sont générés, les services sont configurés et l'image est prête à utiliser.
- 20 + 35 images actives
- 21 - bientôt + 29 + à venir
- 7 + 11 catégories
@@ -27,123 +27,6 @@ services sont configurés et l'image est prête à utiliser.
-
-
-
- -
-

Bientôt disponible

-
-
- - -
-

Dify Bientôt

Créez des applications LLM et des agents IA avec workflows, RAG, prompts et fournisseurs de modèles.

- - - -
-

Ollama Bientôt

Exécutez des LLM locaux sur votre VM et servez des modèles via l'API Ollama.

- - - -
-

Qdrant Bientôt

Base vectorielle pour recherche sémantique, recommandations et pipelines de récupération IA.

- - - -
-

Directus Bientôt

CMS headless et plateforme de données au-dessus de bases SQL existantes.

- - - -
-

NocoDB Bientôt

Alternative libre à Airtable pour transformer des bases de données en tables collaboratives.

- - - -
-

Coolify Bientôt

PaaS auto-hébergé pour déployer applications, bases de données et services depuis Git.

- - - -
-

Ghost Bientôt

Plateforme de publication pour blogues, infolettres, abonnements et sites de créateurs.

- - - -
-

Bagisto Bientôt

Plateforme e-commerce Laravel avec boutique, administration, inventaire et commandes.

- - - -
-

ERPNext Bientôt

ERP libre pour comptabilité, CRM, inventaire, projets, RH et plus.

- - - -
-

Medusa Bientôt

Backend de commerce composable pour vitrines personnalisées et marketplaces.

- - - -
-

Zammad Bientôt

Plateforme d'assistance client pour tickets, courriel, clavardage et workflows.

- - - -
-

Vaultwarden Bientôt

Serveur léger compatible Bitwarden pour la gestion des mots de passe.

- - - -
-

Uptime Kuma Bientôt

Surveillance de disponibilité auto-hébergée avec pages de statut, alertes et tableaux de bord.

- - - -
-

Gatus Bientôt

Tableau de bord de santé de services avec contrôles d'endpoint et alertes.

- - - -
-

Prometheus Bientôt

Collecte de métriques et alertes pour infrastructure et applications.

- - - -
-

Zabbix Bientôt

Surveillance d'entreprise pour serveurs, réseaux, applications et services.

- - - -
-

Beszel Bientôt

Surveillance légère de serveurs avec agents, métriques, alertes et historique.

- - - -
-

Headplane Bientôt

Interface Web pour administrer un serveur de contrôle Headscale auto-hébergé.

- - - -
-

Pelican Panel Bientôt

Panneau de gestion pour exécuter et administrer des serveurs de jeu.

- - - -
-

Pterodactyl Bientôt

Panneau de contrôle de serveurs de jeu avec conteneurs isolés et administration Web.

- - - -
-

Drupal Bientôt

CMS libre et flexible pour sites et applications riches en contenu.

- - -
-
-
@@ -153,43 +36,43 @@ services sont configurés et l'image est prête à utiliser.
- +
- +
-

WordPress

-

CMS le plus populaire au monde, avec pile LAMP complète préconfigurée

+

OpenClaw

+

Assistant IA personnel auto-hébergé et passerelle multicanal.

 - +
- +
-

Docker

-

Environnement d'exécution de conteneurs avec Docker CE et Docker Compose préinstallés

+

WordPress

+

CMS le plus populaire au monde, avec pile LAMP préconfigurée

 - +
- +
-

Pile LAMP

-

Linux, Apache, MariaDB et PHP. La pile classique pour applications Web

+

Docker

+

Moteur de conteneurs avec Docker CE et Docker Compose préinstallés

 - +
- +
-

PostgreSQL 17

-

Base de données relationnelle libre avancée et hautement extensible

+

cPanel

+

Panneau de contrôle d'hébergement web standard avec WHM

 @@ -198,50 +81,28 @@ services sont configurés et l'image est prête à utiliser.
-

GitLab CE 18.11

+

GitLab CE 19.1

Plateforme DevOps auto-hébergée avec Git, CI/CD et suivi des tickets

-
-
- -
-
-
- -
-

Bases de données

-
-
- - -
- -
-
-

MongoDB 8.0

-

Base NoSQL orientée documents pour stocker des données flexibles semblables à JSON

-
- - - +
- +
-

MariaDB 11.4

-

Base de données relationnelle libre et remplacement direct de MySQL

+

n8n

+

Plateforme d'automatisation de workflows avec éditeur visuel à nœuds

 - +
- +
-

MySQL 8.4

-

Base de données relationnelle libre parmi les plus déployées au monde

+

NetBird

+

Réseau superposé WireGuard open source avec connexions pair à pair

 @@ -250,38 +111,50 @@ services sont configurés et l'image est prête à utiliser.
-

PostgreSQL 17

-

Base de données relationnelle libre avancée et hautement extensible

+

PostgreSQL

+

Base de données relationnelle open source avancée et très extensible

- +
- +
-

Valkey 9.0

-

Magasin de données en mémoire haute performance, compatible avec Redis

+

MariaDB 11.8

+

Base de données relationnelle open source et remplacement direct de MySQL

 - +
- +
-

Elasticsearch 8

-

Moteur distribué de recherche et d'analyse basé sur Apache Lucene

+

Grafana

+

Plateforme open source pour visualiser métriques, journaux et traces

 - +
+ + +
+
+
+ +
+

Panneaux de contrôle

+
+
+ +
- +
-

InfluxDB 2

-

Base de séries temporelles conçue pour les métriques et l'analyse en temps réel

+

cPanel

+

Panneau de contrôle d'hébergement web standard avec WHM. Gérez sites web, courriels, DNS et bases de données depuis une interface unique

 @@ -291,29 +164,19 @@ services sont configurés et l'image est prête à utiliser.
- +
-

Piles Web

+

Serveurs web

- -
- -
-
-

WordPress

-

Système de gestion de contenu le plus populaire au monde, avec pile LAMP complète

-
- -
-

Pile LAMP

-

Linux, Apache, MariaDB et PHP. La pile classique pour applications Web

+

LAMP Stack

+

Linux, Apache, MariaDB et PHP. La pile classique pour applications web

 @@ -322,8 +185,8 @@ services sont configurés et l'image est prête à utiliser.
-

Pile LEMP

-

Linux, Nginx, MariaDB et PHP. Pile haute performance avec Docker Compose

+

LEMP Stack

+

Linux, Nginx, MariaDB et PHP. Pile haute performance via Docker Compose

@@ -332,30 +195,40 @@ services sont configurés et l'image est prête à utiliser.
-
- +
+
-

Surveillance et automatisation

+

CMS

- +
- +
-

Grafana

-

Plateforme libre pour visualiser métriques, journaux et traces

+

WordPress

+

Système de gestion de contenu le plus populaire au monde, avec pile LAMP complète

 - +
- +
-

n8n

-

Plateforme d'automatisation de flux de travail avec éditeur visuel à noeuds

+

Drupal

+

CMS open source flexible pour sites et applications riches en contenu.

+
+ + + +
+ +
+
+

Ghost

+

Plateforme de publication pour infolettres, blogues et abonnements.

 @@ -367,7 +240,7 @@ services sont configurés et l'image est prête à utiliser.
-

Outils de développement

+

Outils développeur

@@ -377,7 +250,7 @@ services sont configurés et l'image est prête à utiliser.

Docker

-

Environnement d'exécution de conteneurs avec Docker CE et Docker Compose préinstallés

+

Moteur de conteneurs avec Docker CE et Docker Compose préinstallés

@@ -387,39 +260,57 @@ services sont configurés et l'image est prête à utiliser.

Node.js 24

-

Environnement d'exécution Node.js LTS avec PM2 pour les processus persistants

+

Environnement Node.js LTS avec PM2 pour la gestion persistante des processus

- +
- +
-

OpenClaw

-

Outil basé sur Node.js pour flux de travail et intégrations automatisés

+

GitLab CE 19.1

+

Plateforme DevOps auto-hébergée avec Git, CI/CD et suivi des tickets in one application

 -
-
+ +
+ +
+
+

Jenkins

+

Serveur d'automatisation pour compiler, tester et déployer.

+
+ -
-
-
- -
-

DevOps et gestion du code source

-
-
+ +
+ +
+
+

Forgejo

+

Forge Git auto-hébergée légère, dérivée de Gitea.

+
+ - +
- + +
+
+

Portainer

+

Interface web pour gérer Docker, Swarm et Kubernetes.

+
+ + + +
+
-

GitLab CE 18.11

-

Plateforme DevOps auto-hébergée avec Git, CI/CD et suivi des tickets dans une seule application

+

Coolify

+

PaaS auto-hébergé pour déployer applications, bases de données et services.

 @@ -428,53 +319,581 @@ services sont configurés et l'image est prête à utiliser.
-
- +
+
-

Réseautique et VPN

+

Bases de données

- +
- - +
-

Tailscale

-

VPN sans configuration basé sur WireGuard pour connecter appareils et serveurs

+

MariaDB 11.8

+

Base de données relationnelle open source et remplacement direct de MySQL

 - +
- +
-

NetBird

-

Réseau superposé libre basé sur WireGuard avec connexions pair à pair

+

PostgreSQL

+

Base de données relationnelle open source avancée et très extensible

 -
-
- -
-
-
- -
-

Panneaux de contrôle

-
-
+ +
+ +
+
+

MySQL

+

Base de données relationnelle open source la plus déployée au monde

+
+ - +
- +
-

cPanel

-

Panneau de contrôle d'hébergement Web de référence avec WHM. Gérez sites Web, courriels, DNS et bases de données depuis une seule interface

+

Valkey 9.1

+

Stockage de données en mémoire haute performance, compatible Redis

+
+ + + +
+ +
+
+

Elasticsearch 9

+

Moteur distribué de recherche et d'analyse basé sur Apache Lucene

+
+ + + +
+ +
+
+

InfluxDB 2

+

Base de données de séries temporelles conçue pour métriques et analyses en temps réel

+
+ + + +
+ +
+
+

MongoDB 8.0

+

Base NoSQL orientée documents pour stockage flexible de données de type JSON

+
+ + + +
+ +
+
+

Supabase

+

Alternative open source à Firebase basée sur PostgreSQL.

+
+ + +
+
+ +
+
+
+ +
+

Applications métier

+
+
+ + +
+ +
+
+

n8n

+

Plateforme d'automatisation de workflows avec éditeur visuel à nœuds

+
+ + +
+
+ +
+
+
+ +
+

Sécurité et VPN

+
+
+ + +
+ +
+
+

NetBird

+

Réseau superposé WireGuard open source avec connexions pair à pair

+
+ + + +
+ + +
+
+

Tailscale

+

VPN WireGuard sans configuration pour connecter appareils et serveurs

+
+ + + +
+ +
+
+

Headplane

+

Interface web pour gérer votre réseau Headscale auto-hébergé.

+
+ + + +
+ +
+
+

Keycloak

+

Gestion open source des identités et des accès avec SSO.

+
+ + + +
+ +
+
+

Authentik

+

Fournisseur d'identité flexible pour SSO, OAuth et SAML.

+
+ + + +
+ +
+
+

Vaultwarden

+

Gestionnaire de mots de passe léger, auto-hébergé et compatible Bitwarden.

+
+ + + +
+ +
+
+

OpenBao

+

Gestion open source des secrets et chiffrement des données.

+
+ + +
+
+ +
+
+
+ +
+

Surveillance

+
+
+ + +
+ +
+
+

Grafana

+

Plateforme open source pour visualiser métriques, journaux et traces

+
+ + + +
+ +
+
+

Prometheus

+

Outil de collecte de métriques et d'alerte pour infrastructure.

+
+ + + +
+ +
+
+

Zabbix

+

Surveillance d'infrastructure et d applications de niveau entreprise.

+
+ + +
+
+ +
+
+
+ +
+

IA et agents

+
+
+ + +
+ +
+
+

OpenClaw

+

Assistant IA personnel auto-hébergé et passerelle multicanal.

+
+ + + +
+ +
+
+

Ollama

+

Exécutez des LLM locaux sur votre machine virtuelle et servez des modèles avec l'API Ollama.

+
+ + + +
+ +
+
+

Dify

+

Créez des applications LLM et agents IA avec workflows, RAG et fournisseurs de modèles.

+
+ + +
+
+ +
+
+
+ +
+

À venir

+
+
+ + +
+ +
+
+

Qdrant À venir

+

Base vectorielle pour recherche sémantique et pipelines de récupération IA.

+
+ + + +
+ +
+
+

Medusa À venir

+

Moteur de commerce headless API-first pour boutiques en ligne personnalisées.

+
+ + + +
+ +
+
+

Bagisto À venir

+

Plateforme e-commerce Laravel open source pour boutiques en ligne.

+
+ + + +
+ +
+
+

Pterodactyl À venir

+

Gérez des serveurs de jeu dans des conteneurs isolés via un panneau web.

+
+ + + +
+ +
+
+

Pelican Panel À venir

+

Panneau de contrôle open source moderne et rapide pour serveurs de jeu.

+
+ + + +
+ +
+
+

ERPNext À venir

+

CRM, comptabilité, RH et inventaire dans une suite open source.

+
+ + + +
+ +
+
+

NocoDB À venir

+

Alternative open source à Airtable qui transforme des bases de données en tables.

+
+ + + +
+ +
+
+

Directus À venir

+

CMS headless et plateforme de données au-dessus de bases SQL.

+
+ + + +
+ +
+
+

Uptime Kuma À venir

+

Surveillez sites et services avec tableaux de bord et alertes.

+
+ + + +
+ +
+
+

Beszel À venir

+

Surveillance serveur légère en temps réel avec un petit agent.

+
+ + + +
+ +
+
+

Gatus À venir

+

Page de statut automatisée et tableau de santé pour services.

+
+ + + +
+ +
+
+

Zammad À venir

+

Centre d'assistance et billetterie auto-hébergés pour support client.

+
+ + + +
+ +
+
+

Rancher À venir

+

Gérez des clusters Kubernetes depuis une console web unique.

+
+ + + +
+ +
+
+

Nginx Proxy Manager À venir

+

Gestion du proxy inverse et SSL avec une interface web simple.

+
+ + + +
+ +
+
+

Nginx À venir

+

Serveur web et proxy inverse haute performance.

+
+ + + +
+ +
+
+

HAProxy À venir

+

Répartiteur de charge TCP et HTTP fiable et haute performance.

+
+ + + +
+ +
+
+

Apache Tomcat À venir

+

Conteneur de servlets Java pour exécuter des applications web.

+
+ + + +
+ +
+
+

RabbitMQ À venir

+

Broker de messages fiable pour files d'attente et applications événementielles.

+
+ + + +
+ +
+
+

Apache Kafka À venir

+

Plateforme de streaming d'événements distribuée pour données en temps réel.

+
+ + + +
+ +
+
+

SeaweedFS À venir

+

Stockage de fichiers et d'objets distribué, compatible S3.

+
+ + + +
+ +
+
+

Nexus À venir

+

Dépôt universel d'artefacts pour builds et dépendances.

+
+ + + +
+ +
+
+

Artifactory À venir

+

Dépôt d'artefacts JFrog pour binaires et paquets.

+
+ + + +
+ +
+
+

Harbor À venir

+

Registre de conteneurs sécurisé avec analyse des vulnérabilités.

+
+ + + +
+ +
+
+

Gitea À venir

+

Service Git auto-hébergé léger.

+
+ + + +
+ +
+
+

Neo4j À venir

+

Base de données graphe pour données connectées et requêtes relationnelles.

+
+ + + +
+ +
+
+

ClickHouse À venir

+

Base de données en colonnes rapide pour analyses en temps réel (OLAP).

+
+ + + +
+ +
+
+

Mattermost À venir

+

Plateforme auto-hébergée de messagerie d'équipe et de collaboration.

+
+ + + +
+ +
+
+

Wiki.js À venir

+

Wiki et plateforme de documentation moderne, auto-hébergé.

+
+ + + +
+ +
+
+

WG-Easy À venir

+

La façon la plus simple d'exécuter un VPN WireGuard avec une interface web.

 diff --git a/src/content/docs/fr/public-cloud/marketplace/jenkins.md b/src/content/docs/fr/public-cloud/marketplace/jenkins.md index 5c8ee0e..1024aac 100644 --- a/src/content/docs/fr/public-cloud/marketplace/jenkins.md +++ b/src/content/docs/fr/public-cloud/marketplace/jenkins.md @@ -2,18 +2,18 @@ title: Jenkins --- -Jenkins est un serveur d'automatisation open source pour la construction, les tests et le -déploiement de logiciels. Son modèle de pipeline-as-code et son vaste écosystème de plugins vous -permettent de mettre en place l'intégration continue et la livraison continue pour presque n'importe -quelle chaîne d'outils. L'interface web s'exécute sur le port 8080. +Jenkins est un serveur d'automatisation open source pour compiler, tester et déployer des logiciels. +Son modèle pipeline-as-code et son grand écosystème de plugins permettent de connecter l'intégration +continue et la livraison continue à presque n'importe quelle chaîne d'outils. L'interface web +s'exécute sur le port 8080. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Jenkins préconfigurée arrive bientôt. Pour l'instant, déployez une nouvelle instance -**Ubuntu 24.04 LTS** depuis la marketplace et suivez les étapes ci-dessous pour installer Jenkins -vous-même. - -::: +| Composant | Version | +| --------- | ------------- | +| Jenkins | 2.555.3 (LTS) | +| OpenJDK | 21 (JRE) | +| Ubuntu | 24.04 LTS | ## Prérequis @@ -23,83 +23,95 @@ vous-même. | RAM | 2 Go | 4 Go | | Stockage | 20 Go | 50 Go | -## Déployer l'instance de base +## Variables d'environnement -1. Dans le portail ZSoftly Cloud, ouvrez **Apps**, sélectionnez **Jenkins** et cliquez sur - **Deploy**, ou créez une instance **Ubuntu 24.04 LTS** depuis **Instances → Create**. Dans les - deux cas, vous obtenez une VM Ubuntu 24.04 propre. -2. Choisissez un plan qui répond aux prérequis ci-dessus et sélectionnez votre région (YOW-1 ou - YUL-1). -3. Lorsque l'instance est **Running**, connectez-vous en SSH : +Cette image n'accepte aucune variable au déploiement. Elle ne crée aucun compte administrateur +partagé. Jenkins génère un mot de passe de déverrouillage unique sur chaque machine virtuelle. +Lisez-le après le premier démarrage, puis créez votre administrateur dans l'assistant de +configuration: ```bash -ssh ubuntu@ +sudo cat /var/lib/jenkins/secrets/initialAdminPassword ``` -4. Mettez le système à jour : +## Démarrage + +### 1. Se connecter à la machine virtuelle ```bash -sudo apt update && sudo apt upgrade -y +ssh ubuntu@ ``` -## Installer Jenkins +### 2. Attendre la configuration au premier démarrage -Jenkins s'exécute sur la JVM. Installez d'abord un OpenJDK pris en charge (17 ou 21) : +Au premier démarrage, un script lance Jenkins. Jenkins génère ensuite un mot de passe administrateur +initial unique pour cette instance. Le premier démarrage peut prendre quelques minutes. Suivez la +progression: ```bash -sudo apt install -y fontconfig openjdk-21-jre -java -version +journalctl -u jenkins-first-boot.service -f ``` -Ajoutez la clé de signature et la liste de sources du dépôt apt Jenkins LTS : +Le message de connexion (MOTD) confirme quand Jenkins est prêt. -```bash -sudo wget -O /etc/apt/keyrings/jenkins-keyring.asc \ - https://pkg.jenkins.io/debian-stable/jenkins.io-2023.key +### 3. Récupérer le mot de passe administrateur initial -echo "deb [signed-by=/etc/apt/keyrings/jenkins-keyring.asc] https://pkg.jenkins.io/debian-stable binary/" \ - | sudo tee /etc/apt/sources.list.d/jenkins.list > /dev/null +```bash +sudo cat /var/lib/jenkins/secrets/initialAdminPassword ``` -Installez Jenkins : +### 4. Terminer l'assistant de configuration -```bash -sudo apt update -sudo apt install -y jenkins +Ouvrez un navigateur et allez à: + +```text +http://:8080 ``` -Le paquet installe un service systemd qui démarre au démarrage du système. Vérifiez qu'il est en -cours d'exécution : +Collez le mot de passe administrateur initial, installez les plugins suggérés, puis créez votre +premier compte administrateur. + +## Gérer Jenkins + +Jenkins s'exécute comme service systemd. ```bash -sudo systemctl enable --now jenkins -sudo systemctl status jenkins +# Vérifier l'état +systemctl status jenkins + +# Redémarrer +sudo systemctl restart jenkins + +# Voir les journaux +sudo journalctl -u jenkins -f ``` -## Configurer Jenkins +Répertoire Jenkins home (tâches, plugins et configuration): `/var/lib/jenkins`. -Jenkins écoute sur le port 8080. Ouvrez `http://:8080` dans un navigateur pour démarrer -l'assistant de configuration. L'assistant demande d'abord le mot de passe de déverrouillage généré -automatiquement. Affichez-le depuis le serveur : +## Sécurité -```bash -sudo cat /var/lib/jenkins/secrets/initialAdminPassword -``` +Le port 8080 est ouvert sur l'interface réseau de la machine virtuelle. UFW est activé et autorise +SSH (port 22) et Jenkins (port 8080). Aucun port d'agent de build (50000) n'est ouvert par défaut. -Collez la valeur, installez les plugins suggérés et créez votre premier compte administrateur. Pour -une configuration de production, placez Jenkins derrière un reverse proxy tel que nginx avec un -certificat TLS, puis servez l'interface en HTTPS au lieu d'exposer directement le port 8080. +**Pour limiter l'interface à une adresse IP précise:** -## Ouvrir le pare-feu +```bash +sudo ufw delete allow 8080/tcp +sudo ufw allow from to any port 8080 +``` -L'instance n'autorise par défaut que le SSH (port 22) en externe. Ouvrez le ou les ports dont -Jenkins a besoin et ajoutez-les aux règles réseau/de sécurité de l'instance dans le portail : +**Pour accéder à l'interface sans ouvrir le pare-feu, utilisez un tunnel SSH:** ```bash -sudo ufw allow 8080/tcp +# Exécuter cette commande sur votre machine locale +ssh -L 8080:localhost:8080 ubuntu@ ``` -## Étapes suivantes +**En production**, placez Jenkins derrière un proxy inverse comme nginx avec un certificat TLS, et +servez l'interface en HTTPS au lieu d'exposer directement le port 8080. + +## Prochaines étapes - [Documentation Jenkins](https://www.jenkins.io/doc/) -- [Guide d'installation Jenkins](https://www.jenkins.io/doc/book/installing/linux/) +- [Gérer les plugins](https://www.jenkins.io/doc/book/managing/plugins/) +- [Référence Pipeline](https://www.jenkins.io/doc/book/pipeline/) diff --git a/src/content/docs/fr/public-cloud/marketplace/keycloak.md b/src/content/docs/fr/public-cloud/marketplace/keycloak.md index 25355cb..bf94859 100644 --- a/src/content/docs/fr/public-cloud/marketplace/keycloak.md +++ b/src/content/docs/fr/public-cloud/marketplace/keycloak.md @@ -2,19 +2,21 @@ title: Keycloak --- -Keycloak est une plateforme libre de gestion des identités et des accès. Elle fournit -l'authentification unique (SSO), la fédération d'utilisateurs, la connexion via les réseaux sociaux -et le courtage d'identité, ainsi qu'une autorisation fine grâce à des protocoles standards comme -OpenID Connect, OAuth 2.0 et SAML. Ce guide exécute le conteneur Keycloak officiel, avec des notes -pour un démarrage rapide en développement et pour une mise en production. +Keycloak est une plateforme open source de gestion des identités et des accès. Elle fournit le SSO, +la fédération d'utilisateurs, la connexion sociale ou par courtier d'identité, et des autorisations +fines avec des protocoles standard comme OpenID Connect, OAuth 2.0 et SAML. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Keycloak préconfigurée arrive bientôt. Pour l'instant, déployez une instance **Ubuntu -24.04 LTS** neuve depuis la marketplace et suivez les étapes ci-dessous pour installer Keycloak -vous-même. +| Composant | Version | +| ---------- | --------------- | +| Keycloak | 26.6.4 | +| PostgreSQL | 18 | +| Docker | Dernière stable | +| Ubuntu | 24.04 LTS | -::: +Keycloak s'exécute en mode production (`start`) avec une base PostgreSQL, sous forme de pile Docker +Compose. ## Prérequis @@ -24,134 +26,105 @@ vous-même. | RAM | 2 Go | 4 Go | | Stockage | 20 Go | 40 Go | -## Déployer l'instance de base +## Variables d'environnement + +Vous pouvez les définir au déploiement de Keycloak depuis la Marketplace. Laissez un champ de mot de +passe vide pour générer automatiquement une valeur aléatoire sécurisée. + +| Variable | Description | +| ------------------------- | --------------------------------------------------------------------------------------------------------- | +| `KEYCLOAK_ADMIN` | Nom d'utilisateur du compte administrateur initial. Par défaut: `admin` | +| `KEYCLOAK_ADMIN_PASSWORD` | Mot de passe du compte administrateur initial | +| `KC_HOSTNAME` | Nom d'hôte public ou IP depuis lequel Keycloak est servi. Par défaut: l'IP privée de la machine virtuelle | -1. Dans le portail ZSoftly Cloud, ouvrez **Apps**, sélectionnez **Keycloak** et cliquez sur - **Deploy**, ou créez une instance **Ubuntu 24.04 LTS** depuis **Instances → Create**. Les deux - vous donnent une VM Ubuntu 24.04 propre. -2. Choisissez un forfait conforme aux prérequis ci-dessus et sélectionnez votre région (YOW-1 ou - YUL-1). -3. Lorsque l'instance est **Running**, connectez-vous en SSH: +## Démarrage + +### 1. Se connecter à la machine virtuelle ```bash ssh ubuntu@ ``` -4. Mettez le système à jour: +### 2. Attendre la configuration au premier démarrage + +Au premier démarrage, un script génère les mots de passe administrateur et base de données, écrit le +fichier d'environnement, puis démarre la pile avec Docker Compose. Cela prend 1 à 2 minutes. Suivez +la progression: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u keycloak-first-boot.service -f ``` -## Installer Keycloak +Le message de connexion (MOTD) confirme quand Keycloak est prêt et affiche les identifiants +administrateur. -Keycloak est distribué sous forme d'image Docker officielle depuis `quay.io`. Installez donc d'abord -Docker Engine. +### 3. Récupérer les identifiants administrateur -Configurez le dépôt APT officiel de Docker pour Ubuntu 24.04 LTS (`noble`): +Les identifiants sont aussi écrits dans un fichier réservé à root: ```bash -sudo apt install -y ca-certificates curl -sudo install -m 0755 -d /etc/apt/keyrings -sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc -sudo chmod a+r /etc/apt/keyrings/docker.asc -sudo tee /etc/apt/sources.list.d/docker.sources >/dev/null <:8080 ``` -Pour essayer Keycloak rapidement, démarrez-le en mode développement. Cela amorce un utilisateur -administrateur initial et sert la console sur le port 8080: +Connectez-vous avec l'utilisateur `admin` et le mot de passe généré. -```bash -sudo docker run -d --name keycloak --restart unless-stopped \ - -p 8080:8080 \ - -e KEYCLOAK_ADMIN=admin \ - -e KEYCLOAK_ADMIN_PASSWORD='' \ - quay.io/keycloak/keycloak:latest start-dev -``` +| Champ | Valeur | +| ----------------- | -------------------------------------- | +| Nom d'utilisateur | `admin` | +| Mot de passe | Depuis `/etc/keycloak/credentials.txt` | -Ouvrez `http://:8080` et connectez-vous à la console d'administration avec les -identifiants ci-dessus. - -## Configurer Keycloak - -Le mode développement utilise une base de données en mémoire et des valeurs par défaut non -sécurisées. Il ne convient donc pas à la production. Pour un déploiement de production, exécutez -Keycloak avec la commande `start`, une base de données externe, HTTPS sur le port 8443 et un nom -d'hôte explicite. - -L'exemple ci-dessous utilise Docker Compose avec PostgreSQL. Créez `docker-compose.yml`: - -```yaml -services: - postgres: - image: postgres:16 - restart: unless-stopped - environment: - POSTGRES_DB: keycloak - POSTGRES_USER: keycloak - POSTGRES_PASSWORD: - volumes: - - postgres_data:/var/lib/postgresql/data - - keycloak: - image: quay.io/keycloak/keycloak:latest - restart: unless-stopped - command: start - environment: - KEYCLOAK_ADMIN: admin - KEYCLOAK_ADMIN_PASSWORD: - KC_DB: postgres - KC_DB_URL: jdbc:postgresql://postgres:5432/keycloak - KC_DB_USERNAME: keycloak - KC_DB_PASSWORD: - KC_HOSTNAME: auth.example.com - KC_PROXY_HEADERS: xforwarded - KC_HTTP_ENABLED: 'true' - ports: - - '8080:8080' - depends_on: - - postgres - -volumes: - postgres_data: -``` +## Gérer Keycloak -Démarrez la pile: +Keycloak s'exécute comme pile Docker Compose dans `/opt/keycloak`. ```bash -sudo docker compose up -d +# Vérifier l'état +cd /opt/keycloak && docker compose ps + +# Redémarrer +cd /opt/keycloak && docker compose restart + +# Voir les journaux +cd /opt/keycloak && docker compose logs -f ``` -Faites pointer `auth.example.com` vers la VM et placez Keycloak derrière un reverse proxy (Caddy, -nginx ou Traefik) qui termine TLS sur 443 et redirige vers le port 8080 de l'hôte. +Configuration d'environnement: `/opt/keycloak/.env`. Les données PostgreSQL sont stockées sous +`/opt/keycloak/data/postgres` et ne sont pas exposées hors du réseau Docker. + +## Sécurité + +Le port 8080 est ouvert sur l'interface réseau de la machine virtuelle. UFW est activé et autorise +SSH (port 22) et Keycloak (port 8080). Keycloak sert HTTP en clair sur 8080. -## Ouvrir le pare-feu +:::caution -L'instance n'autorise que SSH (port 22) en externe par défaut. Ouvrez le port que Keycloak sert et -ajoutez-le aux règles réseau/sécurité de l'instance dans le portail: +`KC_HOSTNAME` prend par défaut l'IP privée de la machine virtuelle. Si vous associez ensuite une IP +publique, un nom DNS ou un proxy inverse, définissez `KC_HOSTNAME` au déploiement (ou modifiez +`/opt/keycloak/.env` et exécutez `cd /opt/keycloak && docker compose up -d`), sinon les +vérifications de nom d'hôte en mode production peuvent rejeter les requêtes provenant de la nouvelle +adresse. + +::: + +**En production**, placez Keycloak derrière un proxy inverse (Caddy, nginx ou Traefik) qui termine +TLS sur le port 443 et relaie vers le port 8080, puis définissez `KC_PROXY_HEADERS=xforwarded` dans +`/opt/keycloak/.env`. Limitez l'accès direct au port 8080: ```bash -sudo ufw allow 8080/tcp +sudo ufw delete allow 8080/tcp +sudo ufw allow from to any port 8080 ``` -Si vous placez Keycloak derrière un reverse proxy, ouvrez plutôt le port 443 et gardez le 8080 en -interne. - -## Étapes suivantes +## Prochaines étapes - [Documentation Keycloak](https://www.keycloak.org/documentation) -- [Guide d'installation de Keycloak](https://www.keycloak.org/getting-started/getting-started-docker) +- [Configurer le nom d'hôte](https://www.keycloak.org/server/hostname) +- [Configuration avec proxy inverse](https://www.keycloak.org/server/reverseproxy) diff --git a/src/content/docs/fr/public-cloud/marketplace/lamp.md b/src/content/docs/fr/public-cloud/marketplace/lamp.md index 3427cda..8f1214f 100644 --- a/src/content/docs/fr/public-cloud/marketplace/lamp.md +++ b/src/content/docs/fr/public-cloud/marketplace/lamp.md @@ -12,21 +12,21 @@ configurés pour fonctionner ensemble, prêts pour le déploiement de votre appl | -------------- | ------------------------------------------------------ | | Apache | 2.4.x | | MariaDB | Dernière stable | -| PHP | 8.3 | +| PHP | 8.4 | | Extensions PHP | cli, mysql, curl, gd, mbstring, xml, zip, bcmath, intl | | Ubuntu | 24.04 LTS | ## Variables d'environnement -Vous pouvez définir ces valeurs lors du déploiement de LAMP depuis la marketplace. Laissez un champ -vide pour générer automatiquement une valeur aléatoire sécurisée. +Cette image n'accepte aucune variable au déploiement. MariaDB est installé avec authentification par +socket pour `root`, et aucune base de données applicative n'est créée. Créez-en une après le premier +démarrage: -| Variable | Description | -| --------------------- | --------------------------------------------------- | -| `MYSQL_ROOT_PASSWORD` | Mot de passe root de la base de données | -| `MYSQL_DATABASE` | Nom de la base de données applicative à créer | -| `MYSQL_USER` | Nom d'utilisateur de la base de données applicative | -| `MYSQL_PASSWORD` | Mot de passe de l'utilisateur applicatif | +```bash +sudo mariadb -e "CREATE DATABASE app;" +sudo mariadb -e "CREATE USER 'app'@'localhost' IDENTIFIED BY '';" +sudo mariadb -e "GRANT ALL PRIVILEGES ON app.* TO 'app'@'localhost';" +``` ## Bien démarrer @@ -104,7 +104,7 @@ Répertoires et fichiers importants: | ------------------------------- | ----------------------------- | | `/var/www/html/` | Racine Web par défaut | | `/etc/apache2/sites-available/` | Hôtes virtuels Apache | -| `/etc/php/8.3/apache2/php.ini` | Configuration PHP pour Apache | +| `/etc/php/8.4/apache2/php.ini` | Configuration PHP pour Apache | | `/etc/mysql/mariadb.conf.d/` | Configuration MariaDB | **Pour créer un hôte virtuel** pour un domaine, ajoutez un fichier de configuration dans diff --git a/src/content/docs/fr/public-cloud/marketplace/lemp.md b/src/content/docs/fr/public-cloud/marketplace/lemp.md index 2722706..c29c746 100644 --- a/src/content/docs/fr/public-cloud/marketplace/lemp.md +++ b/src/content/docs/fr/public-cloud/marketplace/lemp.md @@ -13,7 +13,7 @@ Compose pour simplifier la gestion. | -------------- | --------------- | | Nginx | Dernière stable | | MariaDB | Dernière stable | -| PHP-FPM | 8.3 | +| PHP-FPM | 8.4 | | Docker | Dernière stable | | Docker Compose | Dernière stable | | Ubuntu | 24.04 LTS | diff --git a/src/content/docs/fr/public-cloud/marketplace/mariadb.md b/src/content/docs/fr/public-cloud/marketplace/mariadb.md index aa9d1dd..7e6cc2a 100644 --- a/src/content/docs/fr/public-cloud/marketplace/mariadb.md +++ b/src/content/docs/fr/public-cloud/marketplace/mariadb.md @@ -1,5 +1,5 @@ --- -title: MariaDB 11.4 +title: MariaDB 11.8 --- MariaDB est un système libre de gestion de bases de données relationnelles et un remplacement direct @@ -10,7 +10,7 @@ le stockage de données généraliste. | Composant | Version | | -------------- | ------------ | -| MariaDB Server | 11.4.x (LTS) | +| MariaDB Server | 11.8.x (LTS) | | Ubuntu | 24.04 LTS | ## Variables d'environnement diff --git a/src/content/docs/fr/public-cloud/marketplace/mysql.md b/src/content/docs/fr/public-cloud/marketplace/mysql.md index 8835077..ec1104f 100644 --- a/src/content/docs/fr/public-cloud/marketplace/mysql.md +++ b/src/content/docs/fr/public-cloud/marketplace/mysql.md @@ -1,17 +1,20 @@ --- -title: MySQL 8.4 +title: MySQL --- MySQL est l'une des bases de données relationnelles libres les plus déployées au monde. Cette image -fournit MySQL 8.4 LTS, une version à support à long terme destinée aux charges de travail de -production. +fournit une version à support à long terme destinée aux charges de travail de production. + +MySQL est publié sous forme d'une image par ligne LTS maintenue. Choisissez la version voulue au +moment du déploiement. Les lignes 8.4 et 9.7 sont toutes deux des LTS actuelles, et 9.7 est la suite +logique de 8.4. ## Logiciels inclus -| Composant | Version | -| ------------ | ----------- | -| MySQL Server | 8.4.x (LTS) | -| Ubuntu | 24.04 LTS | +| Composant | Version | +| ------------ | ------------------------------------- | +| MySQL Server | 8.4.x ou 9.7.x (LTS, selon le modèle) | +| Ubuntu | 24.04 LTS | ## Variables d'environnement @@ -109,5 +112,6 @@ tunnel SSH. ## Prochaines étapes +- [Documentation MySQL 9.7](https://dev.mysql.com/doc/refman/9.7/en/) - [Documentation MySQL 8.4](https://dev.mysql.com/doc/refman/8.4/en/) -- [Guide de sécurité MySQL](https://dev.mysql.com/doc/refman/8.4/en/security.html) +- [Guide de sécurité MySQL](https://dev.mysql.com/doc/refman/9.7/en/security.html) diff --git a/src/content/docs/fr/public-cloud/marketplace/n8n.md b/src/content/docs/fr/public-cloud/marketplace/n8n.md index 5128a65..58ed8e5 100644 --- a/src/content/docs/fr/public-cloud/marketplace/n8n.md +++ b/src/content/docs/fr/public-cloud/marketplace/n8n.md @@ -11,7 +11,7 @@ flux de travail. | Composant | Version | | -------------- | --------------- | -| n8n | 1.121.0 | +| n8n | 2.29.8 | | Docker | Dernière stable | | Docker Compose | Dernière stable | | Ubuntu | 24.04 LTS | diff --git a/src/content/docs/fr/public-cloud/marketplace/netbird.md b/src/content/docs/fr/public-cloud/marketplace/netbird.md index da8a14c..967fa58 100644 --- a/src/content/docs/fr/public-cloud/marketplace/netbird.md +++ b/src/content/docs/fr/public-cloud/marketplace/netbird.md @@ -11,7 +11,7 @@ client NetBird préinstallé, prêt à joindre votre réseau. | Composant | Version | | --------- | --------- | -| NetBird | 0.71.4 | +| NetBird | 0.74.3 | | Ubuntu | 24.04 LTS | ## Variables d'environnement @@ -20,9 +20,10 @@ Vous pouvez éventuellement fournir une clé de configuration NetBird lors du d marketplace. Si elle est définie, la VM rejoint automatiquement votre réseau NetBird au premier démarrage ; sinon, connectez-vous manuellement avec `netbird up` après le déploiement. -| Variable | Description | -| -------------- | ---------------------------------------------------------------------- | -| `NB_SETUP_KEY` | Clé de configuration NetBird pour rejoindre votre réseau au démarrage. | +| Variable | Description | +| ------------------- | ----------------------------------------------------------------------- | +| `NB_SETUP_KEY` | Clé de configuration NetBird pour rejoindre votre réseau au démarrage. | +| `NB_MANAGEMENT_URL` | Serveur de gestion NetBird auto-hébergé. Omettez-le pour NetBird cloud. | ## Bien démarrer diff --git a/src/content/docs/fr/public-cloud/marketplace/ollama.md b/src/content/docs/fr/public-cloud/marketplace/ollama.md index 91adb68..d2381b4 100644 --- a/src/content/docs/fr/public-cloud/marketplace/ollama.md +++ b/src/content/docs/fr/public-cloud/marketplace/ollama.md @@ -2,47 +2,49 @@ title: Ollama --- -Ollama est un environnement d'exécution local pour grands modèles de langage (LLM) qui télécharge, -exécute et sert des modèles ouverts tels que Llama, Qwen, Gemma et DeepSeek sur votre propre -matériel. Il expose une API REST simple et une interface en ligne de commande, ce qui vous permet -d'effectuer de l'inférence en privé sans envoyer vos données à un fournisseur tiers. +Ollama est un environnement d'exécution local pour grands modèles de langage (LLM). Il télécharge, +exécute et sert des modèles ouverts comme Llama, Qwen, Gemma et DeepSeek sur votre propre matériel. +Il expose une API REST simple et une interface en ligne de commande, afin d'exécuter l'inférence en +privé sans envoyer de données à un fournisseur tiers. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Ollama préconstruite arrive bientôt. Pour l'instant, déployez une instance **Ubuntu 24.04 -LTS** neuve depuis la place de marché et suivez les étapes ci-dessous pour installer Ollama -vous-même. +| Composant | Version | +| --------- | --------- | +| Ollama | 0.31.2 | +| Ubuntu | 24.04 LTS | -::: +Aucun modèle n'est préchargé. Téléchargez les modèles nécessaires au premier démarrage (voir +[Démarrage](#démarrage)). ## Prérequis -Ollama fonctionne sur **CPU et RAM**. Un GPU est optionnel et accélère l'inférence. Deux éléments -déterminent le forfait dont vous avez besoin : +Ollama fonctionne avec **CPU et RAM**. Un GPU est facultatif et accélère l'inférence. Deux éléments +déterminent le forfait nécessaire: -- **RAM** : elle doit contenir le modèle que vous exécutez (environ la taille du fichier du modèle - plus une marge pour le contexte). Un modèle qui ne tient pas en RAM ne s'exécutera pas. -- **Stockage** : il doit contenir les fichiers de modèles que vous téléchargez, plus le système - d'exploitation et l'espace de travail. Ajoutez la taille de chaque modèle supplémentaire que vous - conservez, car ils s'accumulent vite. +- La **RAM** doit contenir le modèle exécuté (environ la taille du fichier modèle plus une marge + pour le contexte). Un modèle qui ne tient pas en RAM ne s'exécute pas. +- Le **stockage** doit contenir les fichiers de modèles téléchargés, ainsi que le système + d'exploitation et l'espace de travail. Ajoutez la taille de chaque modèle supplémentaire conservé, + car ils s'accumulent vite. -Dimensionnez l'instance pour le plus grand modèle que vous prévoyez d'exécuter. Les valeurs -ci-dessous utilisent la quantification Q4, celle par défaut d'Ollama. +Dimensionnez l'instance pour le plus grand modèle prévu. Les valeurs ci-dessous utilisent la +quantification Q4, le réglage par défaut d'Ollama. -| Taille du modèle | Exemple | Fichier du modèle (approx.) | RAM minimale | Disque suggéré | -| ---------------- | ------------- | --------------------------- | ------------ | -------------- | -| 1-3B | Llama 3.2 3B | 2-3 Go | 8 Go | 20 Go | -| 7-8B | Llama 3.1 8B | 5 Go | 8 Go | 30 Go | -| 13-14B | Llama 2 13B | 9 Go | 16 Go | 40 Go | -| 32-34B | Qwen 2.5 32B | 20 Go | 32 Go | 60 Go | -| 70B | Llama 3.3 70B | 40 Go | 64 Go | 100 Go | +| Taille du modèle | Exemple | Fichier modèle (approx.) | RAM minimale | Disque suggéré | +| ---------------- | ------------- | ------------------------ | ------------ | -------------- | +| 1-3B | Llama 3.2 3B | 2-3 Go | 8 Go | 20 Go | +| 7-8B | Llama 3.1 8B | 5 Go | 8 Go | 30 Go | +| 13-14B | Llama 2 13B | 9 Go | 16 Go | 40 Go | +| 32-34B | Qwen 2.5 32B | 20 Go | 32 Go | 60 Go | +| 70B | Llama 3.3 70B | 40 Go | 64 Go | 100 Go | ## Forfaits recommandés par région -Les noms de forfaits et les tiers de stockage diffèrent selon la région. Les forfaits à usage -général ci-dessous couvrent la RAM dont chaque modèle a besoin, et leur disque système contient les -fichiers de modèles. Consultez [Types d'instances](/fr/public-cloud/compute/instance-types/) et la -[page des tarifs](https://zcp.zsoftly.ca/pricing) pour les spécifications et prix à jour. +Les noms de forfaits et les niveaux de stockage varient selon la région. Les forfaits généraux +ci-dessous fournissent assez de RAM pour chaque modèle, et leur disque racine contient les fichiers +de modèles. Consultez [Types d'instances](/fr/public-cloud/compute/instance-types/) et la +[page de tarification](https://zcp.zsoftly.ca/pricing) pour les spécifications et prix actuels. | Taille du modèle | YOW-1 (Ottawa) | YUL-1 (Montréal) | | ---------------- | ---------------------------------- | ---------------------------------- | @@ -51,67 +53,46 @@ fichiers de modèles. Consultez [Types d'instances](/fr/public-cloud/compute/ins | 32-34B | `ci1.2xl` (8 vCPU, 32 Go, 200 Go) | `ca2.2xl` (8 vCPU, 32 Go, 200 Go) | | 70B | `ci1.4xl` (16 vCPU, 64 Go, 320 Go) | `ca2.4xl` (16 vCPU, 64 Go, 320 Go) | -Ajustez ensuite : +Ajustez ensuite: -- **Même RAM, coût réduit** : la famille à mémoire optimisée offre la même RAM avec moins de vCPU, - pratique pour un usage occasionnel. Utilisez `cim1.*` dans YOW-1 ou `cam2.*` dans YUL-1 (par +- **Même RAM, coût inférieur**: la famille axée mémoire fournit la même RAM avec moins de vCPU, ce + qui convient aux usages occasionnels. Utilisez `cim1.*` dans YOW-1 ou `cam2.*` dans YUL-1 (par exemple `cim1.xl` ou `cam2.xl` pour 64 Go). -- **Réponses plus rapides** : ajoutez des vCPU avec la famille à processeur optimisé (`cac1.*` dans - YOW-1, `cac2.*` dans YUL-1), ou choisissez un forfait avec GPU pour les modèles de 13B et plus. -- **Plusieurs grands modèles sur une instance** : attachez un - [volume de stockage en mode bloc](/fr/public-cloud/compute/settings/block-storage/) au lieu de - passer à un forfait plus grand. +- **Réponses plus rapides**: ajoutez des vCPU avec la famille axée CPU (`cac1.*` dans YOW-1, + `cac2.*` dans YUL-1), ou choisissez un forfait GPU pour les modèles 13B et plus. +- **Plusieurs grands modèles sur une instance**: attachez un + [volume de stockage bloc](/fr/public-cloud/compute/settings/block-storage/) au lieu de passer à un + forfait plus grand. -## Déployer l'instance de base +## Démarrage -1. Dans le portail ZSoftly Cloud, ouvrez **Apps** et passez à l'onglet **Marketplace**. Il s'ouvre - sur **Featured** par défaut, sélectionnez donc **Marketplace** à côté. Choisissez votre région - (YOW-1 ou YUL-1), recherchez **Ubuntu 24.04 LTS** et cliquez sur **Deploy**. Vous pouvez aussi - créer l'instance depuis **Instances → Create**. Dans les deux cas, vous obtenez une VM Ubuntu - 24.04 propre. - - ![L'onglet Marketplace du portail ZSoftly Cloud, avec le sélecteur de région, la liste des catégories, la barre de recherche et les boutons Deploy](../../../../../assets/marketplace/deploy-marketplace-tab.webp) - - ![Recherche d'une application dans le Marketplace, la barre de recherche filtrant le catalogue jusqu'à une carte Deploy correspondante](../../../../../assets/marketplace/deploy-marketplace-search.webp) - -2. Choisissez un plan qui répond aux prérequis ci-dessus. - -3. Lorsque l'instance est **Running**, connectez-vous en SSH: +### 1. Se connecter à la machine virtuelle ```bash ssh ubuntu@ ``` -4. Mettez le système à jour: - -```bash -sudo apt update && sudo apt upgrade -y -``` - -## Installer Ollama +### 2. Attendre la configuration au premier démarrage -Exécutez le script d'installation officiel. Il installe le binaire `ollama`, crée un utilisateur -système `ollama` dédié et configure un service systemd qui démarre automatiquement: +Au premier démarrage, un script lance le service. Cela prend moins d'une minute. Suivez la +progression: ```bash -curl -fsSL https://ollama.com/install.sh | sh +journalctl -u ollama-first-boot.service -f ``` -Confirmez que le service est en cours d'exécution et vérifiez la version: - -```bash -systemctl status ollama --no-pager -ollama --version -``` +Le message de connexion (MOTD) confirme quand Ollama est prêt. -Téléchargez un modèle et exécutez une invite rapide: +### 3. Télécharger un modèle et exécuter un prompt ```bash ollama pull llama3.2 ollama run llama3.2 "Hello, what can you do?" ``` -L'API écoute sur `127.0.0.1:11434` par défaut. Testez-la localement: +### 4. Utiliser l'API + +L'API écoute sur le port `11434`. Testez-la depuis la machine virtuelle: ```bash curl http://localhost:11434/api/generate -d '{ @@ -121,43 +102,55 @@ curl http://localhost:11434/api/generate -d '{ }' ``` -## Configurer Ollama +Depuis un autre hôte, remplacez `localhost` par l'IP de la machine virtuelle. -Par défaut, Ollama ne se lie qu'à localhost. Pour accepter les connexions d'autres hôtes, définissez -`OLLAMA_HOST` dans le service systemd: +## Gérer Ollama + +Ollama s'exécute comme service systemd. ```bash -sudo systemctl edit ollama -``` +# Vérifier l'état +systemctl status ollama + +# Redémarrer +sudo systemctl restart ollama -Ajoutez la surcharge suivante, puis enregistrez: +# Voir les journaux +sudo journalctl -u ollama -f -```ini -[Service] -Environment="OLLAMA_HOST=0.0.0.0:11434" +# Lister, télécharger et supprimer des modèles +ollama list +ollama pull qwen2.5 +ollama rm qwen2.5 ``` -Rechargez et redémarrez: +Les modèles sont stockés dans `/usr/share/ollama/.ollama/models`. Un résumé des URL et commandes est +écrit dans `/etc/ollama/info.txt`. -```bash -sudo systemctl daemon-reload -sudo systemctl restart ollama -``` +## Sécurité -Ollama n'a aucune authentification intégrée. Si vous exposez le port 11434, placez-le derrière un -proxy inverse qui applique TLS et l'authentification, ou restreignez l'accès aux adresses IP de -confiance uniquement. +Le port 11434 est ouvert sur l'interface réseau de la machine virtuelle, et Ollama n'a **pas +d'authentification intégrée**. UFW est activé et autorise SSH (port 22) et l'API Ollama (port +11434). -## Ouvrir le pare-feu +**Pour limiter l'API à une adresse IP précise:** -L'instance n'autorise par défaut que SSH (port 22) en externe. Ouvrez le port dont Ollama a besoin -et ajoutez-le aux règles réseau/sécurité de l'instance dans le portail: +```bash +sudo ufw delete allow 11434/tcp +sudo ufw allow from to any port 11434 +``` + +**Pour accéder à l'API sans ouvrir le pare-feu, utilisez un tunnel SSH:** ```bash -sudo ufw allow 11434/tcp +# Exécuter cette commande sur votre machine locale +ssh -L 11434:localhost:11434 ubuntu@ ``` -## Étapes suivantes +**En production**, placez Ollama derrière un proxy inverse qui impose TLS et l'authentification, ou +limitez l'accès aux seules adresses IP de confiance. + +## Prochaines étapes - [Documentation Ollama](https://docs.ollama.com/) -- [Guide d'installation Ollama](https://docs.ollama.com/linux) +- [Référence de l'API Ollama](https://docs.ollama.com/api) diff --git a/src/content/docs/fr/public-cloud/marketplace/openbao.md b/src/content/docs/fr/public-cloud/marketplace/openbao.md index 1b26f8c..12e4c83 100644 --- a/src/content/docs/fr/public-cloud/marketplace/openbao.md +++ b/src/content/docs/fr/public-cloud/marketplace/openbao.md @@ -8,10 +8,21 @@ communautaire de HashiCorp Vault maintenu par la Linux Foundation, et il reste c API. La plupart des outils Vault fonctionnent donc sans modification. Vous l'exécutez comme un serveur, l'initialisez une seule fois, puis le descellez pour commencer à servir des secrets. -:::note[Bientôt disponible] +## Logiciels inclus -Une image OpenBao préconfigurée arrive bientôt. Pour l'instant, déployez une instance **Ubuntu 24.04 -LTS** neuve depuis la marketplace et suivez les étapes ci-dessous pour installer OpenBao vous-même. +| Composant | Version | +| --------- | --------- | +| OpenBao | 2.5.5 | +| Ubuntu | 24.04 LTS | + +OpenBao s'exécute comme service systemd avec le stockage Raft intégré. Chaque machine virtuelle +génère son propre certificat TLS au premier démarrage, aucune clé privée n'est donc partagée entre +les déploiements. + +:::caution + +Cette image déploie un seul nœud. Un cluster Raft à un nœud n'offre aucun basculement. Pour la haute +disponibilité, provisionnez d'autres instances depuis ce modèle et joignez-les comme pairs Raft. ::: @@ -23,121 +34,112 @@ LTS** neuve depuis la marketplace et suivez les étapes ci-dessous pour installe | RAM | 1 Go | 2 Go | | Stockage | 10 Go | 20 Go | -## Déployer l'instance de base +## Variables d'environnement -1. Dans le portail ZSoftly Cloud, ouvrez **Apps**, sélectionnez **OpenBao** et cliquez sur - **Deploy**, ou créez une instance **Ubuntu 24.04 LTS** depuis **Instances → Create**. Les deux - vous donnent une VM Ubuntu 24.04 propre. -2. Choisissez un forfait conforme aux prérequis ci-dessus et sélectionnez votre région (YOW-1 ou - YUL-1). -3. Lorsque l'instance est **Running**, connectez-vous en SSH: +Vous pouvez définir ces variables au déploiement d'OpenBao depuis la Marketplace. Laissez-les vides +pour utiliser l'adresse de la machine virtuelle et recevoir les secrets générés en clair. -```bash -ssh ubuntu@ -``` +| Variable | Description | +| ---------------------------- | -------------------------------------------------------------------------------------- | +| `OPENBAO_ADDR` | Adresse inscrite dans le certificat TLS et dans l'adresse du cluster Raft | +| `OPENBAO_UNSEAL_PGP_KEYS` | Clés publiques PGP séparées par des virgules. Chaque part de descellement est chiffrée | +| `OPENBAO_ROOT_TOKEN_PGP_KEY` | Une clé publique PGP. Le jeton racine est renvoyé chiffré avec cette clé | -4. Mettez le système à jour: +Chaque entrée PGP est soit `keybase:`, soit une clé publique ASCII-armored encodée en +base64. Ces variables ne permettent pas de choisir la valeur des secrets. OpenBao génère toujours +lui-même le jeton racine et les clés de descellement. Elles déterminent uniquement à qui ces valeurs +sont chiffrées. -```bash -sudo apt update && sudo apt upgrade -y -``` +:::note -## Installer OpenBao +Lorsque vous fournissez `OPENBAO_UNSEAL_PGP_KEYS`, le nombre de clés devient le nombre de parts et +le seuil de descellement, et la machine virtuelle ne peut pas se desceller elle-même, car elle ne +détient aucune clé privée. Déchiffrez votre part localement et exécutez `bao operator unseal` +vous-même. -OpenBao publie un dépôt APT officiel. Ajoutez sa clé de signature et sa source, puis installez le -paquet `openbao`. +::: -```bash -sudo apt install -y gpg wget -sudo mkdir -p /usr/share/keyrings -wget -qO- https://pkg.openbao.org/gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/openbao-keyring.gpg -echo "deb [signed-by=/usr/share/keyrings/openbao-keyring.gpg] https://pkg.openbao.org/deb stable main" | sudo tee /etc/apt/sources.list.d/openbao.list -``` +## Démarrage -Installez OpenBao: +### 1. Connectez-vous à votre VM ```bash -sudo apt update -sudo apt install -y openbao +ssh ubuntu@ ``` -Le paquet installe la CLI `bao`, un utilisateur `openbao` dédié, un service systemd et un fichier de -configuration par défaut dans `/etc/openbao/openbao.hcl`. - -## Configurer OpenBao +### 2. Attendez la configuration au premier démarrage -Modifiez `/etc/openbao/openbao.hcl` pour utiliser le stockage intégré (Raft) et écouter sur toutes -les interfaces. Ce listener de démarrage rapide désactive TLS afin que vous puissiez vérifier -l'installation. Consultez la note TLS ci-dessous avant de l'exposer. +Au premier démarrage, un script génère un certificat TLS pour cette VM, démarre OpenBao, +l'initialise avec 5 parts de clé et un seuil de 3, puis le descelle. Suivez la progression: ```bash -sudo tee /etc/openbao/openbao.hcl >/dev/null <<'EOF' -ui = true - -storage "raft" { - path = "/opt/openbao/data" - node_id = "openbao-1" -} +journalctl -u openbao-first-boot.service -f +``` -listener "tcp" { - address = "0.0.0.0:8200" - tls_disable = true -} +### 3. Récupérez les clés de descellement et le jeton racine -api_addr = "http://127.0.0.1:8200" -cluster_addr = "https://127.0.0.1:8201" -EOF +Ils sont écrits dans un fichier réservé à root: -sudo mkdir -p /opt/openbao/data -sudo chown -R openbao:openbao /opt/openbao +```bash +sudo cat /etc/openbao/credentials.txt ``` -Activez et démarrez le service, puis pointez la CLI vers l'API locale: +:::danger -```bash -sudo systemctl enable --now openbao -export BAO_ADDR='http://127.0.0.1:8200' -``` +Copiez les clés de descellement et le jeton racine en lieu sûr, puis retirez-les de la VM. Quiconque +détient le jeton racine contrôle entièrement vos secrets, et la perte des clés de descellement rend +les données irrécupérables. + +::: -Initialisez OpenBao une seule fois. Cette commande affiche les clés de descellement et le jeton root -initial. Conservez-les en lieu sûr. Ils ne peuvent pas être récupérés: +### 4. Utilisez l'API ```bash -bao operator init +export BAO_ADDR=https://:8200 +export BAO_SKIP_VERIFY=true +bao status ``` -OpenBao démarre **scellé**. Descellez-le en fournissant le seuil de clés de descellement (trois par -défaut), en exécutant la commande une fois par clé: +Le certificat est auto-signé. Faites-lui confiance ou définissez `BAO_SKIP_VERIFY` pendant vos +tests. Remplacez-le par votre propre certificat en production. + +## Gérer OpenBao ```bash -bao operator unseal -``` +# Vérifier l'état +sudo systemctl status openbao -Une fois descellé, connectez-vous avec le jeton root pour commencer à gérer les secrets: +# Redémarrer +sudo systemctl restart openbao -```bash -bao login +# Consulter les journaux +sudo journalctl -u openbao -f ``` -:::caution +La configuration se trouve dans `/etc/openbao`, les données Raft dans `/opt/openbao/data`, et le +certificat propre à la VM dans `/etc/openbao/tls`. -Le listener de démarrage rapide ci-dessus fonctionne sans TLS. Avant d'exposer OpenBao au-delà de -cet hôte, activez TLS dans le bloc `listener "tcp"` (définissez `tls_cert_file` et `tls_key_file`, -supprimez `tls_disable`) ou placez-le derrière un reverse proxy qui termine HTTPS. Ne servez jamais -de secrets de production en HTTP non chiffré. +## Sécurité -::: +Le port 8200 n'est ouvert qu'après que le service a répondu à un contrôle de santé en TLS. UFW est +activé et autorise ce port ainsi que SSH (port 22). + +OpenBao se rescelle à chaque redémarrage du service. Descellez-le de nouveau avec trois de vos +parts: -## Ouvrir le pare-feu +```bash +bao operator unseal +``` -L'instance n'autorise que SSH (port 22) en externe par défaut. Ouvrez le port de l'API qu'OpenBao -sert et ajoutez-le aux règles réseau/sécurité de l'instance dans le portail: +**Pour restreindre l'accès à une adresse IP précise:** ```bash -sudo ufw allow 8200/tcp +sudo ufw delete allow 8200/tcp +sudo ufw allow from to any port 8200 ``` -## Étapes suivantes +## Prochaines étapes - [Documentation OpenBao](https://openbao.org/docs/) -- [Guide d'installation d'OpenBao](https://openbao.org/docs/install/) +- [Concepts de scellement et descellement](https://openbao.org/docs/concepts/seal/) +- [Stockage Raft intégré](https://openbao.org/docs/internals/integrated-storage/) diff --git a/src/content/docs/fr/public-cloud/marketplace/portainer.md b/src/content/docs/fr/public-cloud/marketplace/portainer.md index 6c10cf8..1b7b5a7 100644 --- a/src/content/docs/fr/public-cloud/marketplace/portainer.md +++ b/src/content/docs/fr/public-cloud/marketplace/portainer.md @@ -3,17 +3,16 @@ title: Portainer --- Portainer est une interface de gestion légère pour les environnements Docker et Kubernetes. Elle -vous permet de déployer des conteneurs, de gérer les images, les volumes et les réseaux, et de -surveiller vos piles depuis une seule console web. L'interface s'exécute sur le port 9443 en HTTPS -(port 9000 pour le HTTP simple). +permet de déployer des conteneurs, gérer les images, volumes et réseaux, et surveiller vos piles +depuis une console web unique. L'interface s'exécute sur le port 9443 en HTTPS. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Portainer préinstallée arrive bientôt. Pour l'instant, déployez une nouvelle instance -**Ubuntu 24.04 LTS** depuis la marketplace et suivez les étapes ci-dessous pour installer Portainer -vous-même. - -::: +| Composant | Version | +| ------------ | --------------- | +| Portainer CE | 2.39.4 | +| Docker | Dernière stable | +| Ubuntu | 24.04 LTS | ## Prérequis @@ -23,88 +22,101 @@ vous-même. | RAM | 1 Go | 2 Go | | Stockage | 20 Go | 40 Go | -## Déployer l'instance de base +## Variables d'environnement + +Cette image n'accepte aucune variable au déploiement. Elle ne crée aucun compte administrateur +partagé. Ouvrez l'interface Portainer après le premier démarrage et créez-y le premier +administrateur. -1. Dans le portail ZSoftly Cloud, ouvrez **Apps**, sélectionnez **Portainer** et cliquez sur - **Deploy**, ou créez une instance **Ubuntu 24.04 LTS** depuis **Instances → Create**. Les deux - vous donnent une VM Ubuntu 24.04 propre. -2. Choisissez un plan répondant aux prérequis ci-dessus et sélectionnez votre région (YOW-1 ou - YUL-1). -3. Lorsque l'instance est **Running**, connectez-vous en SSH: +Si la session de configuration du premier utilisateur expire avant la fin, redémarrez Portainer et +rechargez l'interface: ```bash -ssh ubuntu@ +cd /opt/portainer && docker compose restart portainer ``` -4. Mettez le système à jour: +## Démarrage + +### 1. Se connecter à la machine virtuelle ```bash -sudo apt update && sudo apt upgrade -y +ssh ubuntu@ ``` -## Installer Portainer +### 2. Attendre la configuration au premier démarrage -Portainer s'exécute en tant que conteneur Docker. Installez donc d'abord Docker Engine à l'aide du -script d'installation officiel: +Au premier démarrage, un script lance le conteneur Portainer avec Docker Compose. Cela prend moins +d'une minute. Suivez la progression: ```bash -curl -fsSL https://get.docker.com | sudo sh +journalctl -u portainer-first-boot.service -f ``` -Vérifiez que Docker fonctionne: +Le message de connexion (MOTD) confirme quand Portainer est prêt. -```bash -docker version -``` +### 3. Créer le compte administrateur -Créez un volume pour les données persistantes de Portainer: +Ouvrez un navigateur et allez à: -```bash -docker volume create portainer_data +```text +https://:9443 ``` -Exécutez le conteneur du serveur Portainer CE: +Au premier chargement, créez votre compte administrateur en définissant un nom d'utilisateur et un +mot de passe fort. Portainer se connecte à l'environnement Docker local via le socket monté. Vos +conteneurs, images et volumes apparaissent donc immédiatement. + +:::caution + +Portainer verrouille la configuration initiale si aucun compte administrateur n'est créé peu après +le démarrage du conteneur. Si la fenêtre de configuration expire, redémarrez Portainer et rechargez +la page: ```bash -sudo docker run -d \ - -p 8000:8000 \ - -p 9443:9443 \ - --name portainer \ - --restart=always \ - -v /var/run/docker.sock:/var/run/docker.sock \ - -v portainer_data:/data \ - portainer/portainer-ce:lts +cd /opt/portainer && docker compose restart ``` -Vérifiez que le conteneur est en cours d'exécution: +L'interface utilise un certificat autosigné. Votre navigateur affiche donc un avertissement de +sécurité. Acceptez l'exception pour continuer. + +::: + +## Gérer Portainer + +Portainer s'exécute comme pile Docker Compose dans `/opt/portainer`. ```bash -docker ps -``` +# Vérifier l'état +cd /opt/portainer && docker compose ps -## Configurer Portainer +# Redémarrer +cd /opt/portainer && docker compose restart -Portainer sert l'interface sur le port 9443 en HTTPS avec un certificat auto-signé. Ouvrez -`https://:9443` dans un navigateur dans les quelques minutes suivant le démarrage du -conteneur. Pour des raisons de sécurité, Portainer verrouille la configuration initiale si aucun -compte administrateur n'est créé peu après le premier démarrage. +# Voir les journaux +cd /opt/portainer && docker compose logs -f +``` -Au premier chargement, créez votre compte administrateur en définissant un nom d'utilisateur et un -mot de passe fort. Portainer se connecte ensuite à l'environnement Docker local via le socket monté, -de sorte que vos conteneurs, images et volumes apparaissent immédiatement. Le certificat auto-signé -déclenche un avertissement du navigateur. Pour un déploiement de production, placez Portainer -derrière un reverse proxy tel que nginx avec un certificat TLS de confiance. +Les données persistantes de Portainer sont stockées dans `/var/lib/portainer`. Un résumé des URL et +chemins est écrit dans `/etc/portainer/info.txt`. -## Ouvrir le pare-feu +## Sécurité -L'instance n'autorise que le SSH (port 22) en externe par défaut. Ouvrez le ou les ports dont -Portainer a besoin et ajoutez-les aux règles réseau/sécurité de l'instance dans le portail: +Le port 9443 est ouvert sur l'interface réseau de la machine virtuelle. UFW est activé et autorise +SSH (port 22) et Portainer (port 9443). Les ports 8000, 9000 et l'API Docker ne sont pas ouverts par +défaut. + +Portainer monte le socket Docker de l'hôte, ce qui lui donne le contrôle complet du démon Docker de +la machine virtuelle. Limitez l'accès au port 9443: ```bash -sudo ufw allow 9443/tcp +sudo ufw delete allow 9443/tcp +sudo ufw allow from to any port 9443 ``` -## Étapes suivantes +**En production**, placez Portainer derrière un proxy inverse comme nginx avec un certificat TLS de +confiance. + +## Prochaines étapes - [Documentation Portainer](https://docs.portainer.io/) -- [Guide d'installation Portainer](https://docs.portainer.io/start/install-ce/server/docker/linux) +- [Gérer les environnements Docker](https://docs.portainer.io/user/docker) diff --git a/src/content/docs/fr/public-cloud/marketplace/postgresql.md b/src/content/docs/fr/public-cloud/marketplace/postgresql.md index dcec559..1fd40a6 100644 --- a/src/content/docs/fr/public-cloud/marketplace/postgresql.md +++ b/src/content/docs/fr/public-cloud/marketplace/postgresql.md @@ -1,17 +1,20 @@ --- -title: PostgreSQL 17 +title: PostgreSQL --- PostgreSQL est une puissante base de données relationnelle-objet libre, reconnue pour sa fiabilité, sa conformité aux standards et son extensibilité. Elle prend en charge les types de données avancés, la recherche plein texte, JSON et un vaste éventail d'extensions. +PostgreSQL est publié sous forme d'une image par version majeure prise en charge. Choisissez 16, 17 +ou 18 au moment du déploiement. + ## Logiciels inclus -| Composant | Version | -| ---------- | --------- | -| PostgreSQL | 17.x | -| Ubuntu | 24.04 LTS | +| Composant | Version | +| ---------- | ------------------------------------ | +| PostgreSQL | 16.x, 17.x ou 18.x (selon le modèle) | +| Ubuntu | 24.04 LTS | ## Variables d'environnement @@ -81,7 +84,7 @@ sudo systemctl restart postgresql sudo journalctl -u postgresql -f ``` -Répertoire de configuration: `/etc/postgresql/17/main/` +Répertoire de configuration: `/etc/postgresql//main/` Fichiers importants: @@ -122,5 +125,5 @@ tunnel SSH. ## Prochaines étapes -- [Documentation PostgreSQL 17](https://www.postgresql.org/docs/17/) +- [Documentation PostgreSQL](https://www.postgresql.org/docs/current/) - [Guide de sécurité PostgreSQL](https://www.postgresql.org/docs/current/security.html) diff --git a/src/content/docs/fr/public-cloud/marketplace/prometheus.md b/src/content/docs/fr/public-cloud/marketplace/prometheus.md index 39f9ed5..76df7f4 100644 --- a/src/content/docs/fr/public-cloud/marketplace/prometheus.md +++ b/src/content/docs/fr/public-cloud/marketplace/prometheus.md @@ -2,19 +2,22 @@ title: Prometheus --- -Prometheus est une boîte à outils libre de surveillance des systèmes et d'alerte. Il collecte des -métriques auprès de cibles configurées à intervalles réguliers, les stocke dans une base de données -de séries temporelles et évalue des règles pour déclencher des alertes. Il expose une interface de -requête et un navigateur d'expressions intégré sur le port 9090, et s'associe bien à Grafana pour -les tableaux de bord. +Prometheus est une boîte à outils open source de surveillance et d'alerte système. Il collecte les +métriques de cibles configurées à intervalles réguliers, les stocke dans une base de données de +séries temporelles et évalue des règles pour déclencher des alertes. Il expose une interface de +requêtes et un navigateur d'expressions intégré sur le port 9090, et fonctionne bien avec Grafana +pour les tableaux de bord. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Prometheus préconfigurée arrive bientôt. Pour l'instant, déployez une instance **Ubuntu -24.04 LTS** vierge depuis la marketplace et suivez les étapes ci-dessous pour installer Prometheus -vous-même. +| Composant | Version | +| ---------- | --------- | +| Prometheus | 3.13.0 | +| Ubuntu | 24.04 LTS | -::: +L'image inclut seulement le serveur Prometheus. Ajoutez les exporters (comme `node_exporter`) comme +cibles de collecte, et exécutez Alertmanager séparément, en tant que composant distinct, pour gérer +le routage des alertes. ## Prérequis @@ -24,144 +27,91 @@ vous-même. | RAM | 2 Go | 4 Go | | Stockage | 20 Go | 50 Go | -## Déployer l'instance de base +Les besoins de stockage augmentent avec le nombre de séries et la période de rétention. -1. Dans le portail ZSoftly Cloud, ouvrez **Apps** et passez à l'onglet **Marketplace**. Il s'ouvre - sur **Featured** par défaut, sélectionnez donc **Marketplace** à côté. Choisissez votre région - (YOW-1 ou YUL-1), recherchez **Ubuntu 24.04 LTS** et cliquez sur **Deploy**. Vous pouvez aussi - créer l'instance depuis **Instances → Create**. Dans les deux cas, vous obtenez une VM Ubuntu - 24.04 propre. +## Démarrage - ![L'onglet Marketplace du portail ZSoftly Cloud, avec le sélecteur de région, la liste des catégories, la barre de recherche et les boutons Deploy](../../../../../assets/marketplace/deploy-marketplace-tab.webp) - - ![Recherche d'une application dans le Marketplace, la barre de recherche filtrant le catalogue jusqu'à une carte Deploy correspondante](../../../../../assets/marketplace/deploy-marketplace-search.webp) - -2. Choisissez un plan qui répond aux prérequis ci-dessus. - -3. Lorsque l'instance est **Running**, connectez-vous en SSH : +### 1. Se connecter à la machine virtuelle ```bash ssh ubuntu@ ``` -4. Mettez le système à jour : +### 2. Attendre la configuration au premier démarrage + +Au premier démarrage, un script lance le service. Cela prend moins d'une minute. Suivez la +progression: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u prometheus-first-boot.service -f ``` -## Installer Prometheus +Le message de connexion (MOTD) confirme quand Prometheus est prêt. -Installez Prometheus depuis la version binaire officielle et exécutez-le comme service systemd. -C'est la méthode de production courante, qui vous donne un contrôle total sur la version. +### 3. Accéder à l'interface Prometheus -Créez un utilisateur système dédié et non privilégié, ainsi que les répertoires de configuration et -de données : +Ouvrez un navigateur et allez au navigateur d'expressions et à l'interface intégrée: -```bash -sudo useradd --no-create-home --shell /bin/false prometheus -sudo mkdir -p /etc/prometheus /var/lib/prometheus +```text +http://:9090 ``` -Téléchargez la dernière version depuis prometheus.io et extrayez-la. Consultez la -[page des versions](https://prometheus.io/download/) pour connaître la version actuelle et mettez-la -à jour ci-dessous : +### 4. Ajouter des cibles de collecte -```bash -PROM_VERSION=3.4.1 -cd /tmp -curl -fsSLO https://github.com/prometheus/prometheus/releases/download/v${PROM_VERSION}/prometheus-${PROM_VERSION}.linux-amd64.tar.gz -tar -xzf prometheus-${PROM_VERSION}.linux-amd64.tar.gz -cd prometheus-${PROM_VERSION}.linux-amd64 -``` - -Installez les binaires et les fichiers de support, puis attribuez la propriété à l'utilisateur -`prometheus` : +Modifiez la configuration de collecte, validez-la, puis rechargez sans redémarrage: ```bash -sudo cp prometheus promtool /usr/local/bin/ -sudo cp -r consoles console_libraries /etc/prometheus/ -sudo cp prometheus.yml /etc/prometheus/prometheus.yml -sudo chown -R prometheus:prometheus /usr/local/bin/prometheus /usr/local/bin/promtool /etc/prometheus /var/lib/prometheus +sudo nano /etc/prometheus/prometheus.yml +promtool check config /etc/prometheus/prometheus.yml +sudo systemctl reload prometheus ``` -Écrivez une configuration de collecte minimale. Par défaut, elle collecte les métriques de -Prometheus lui-même sur le port 9090. Ajoutez vos propres cibles sous `scrape_configs` : +## Gérer Prometheus + +Prometheus s'exécute comme service systemd avec un utilisateur dédié `prometheus`. ```bash -sudo tee /etc/prometheus/prometheus.yml > /dev/null <<'EOF' -global: - scrape_interval: 15s - evaluation_interval: 15s - -scrape_configs: - - job_name: prometheus - static_configs: - - targets: ["localhost:9090"] -EOF -sudo chown prometheus:prometheus /etc/prometheus/prometheus.yml -``` +# Vérifier l'état +systemctl status prometheus -Créez l'unité de service systemd : +# Redémarrer +sudo systemctl restart prometheus -```bash -sudo tee /etc/systemd/system/prometheus.service > /dev/null <<'EOF' -[Unit] -Description=Prometheus -Wants=network-online.target -After=network-online.target - -[Service] -User=prometheus -Group=prometheus -Type=simple -ExecStart=/usr/local/bin/prometheus \ - --config.file=/etc/prometheus/prometheus.yml \ - --storage.tsdb.path=/var/lib/prometheus/ \ - --web.console.templates=/etc/prometheus/consoles \ - --web.console.libraries=/etc/prometheus/console_libraries \ - --web.listen-address=0.0.0.0:9090 -Restart=on-failure - -[Install] -WantedBy=multi-user.target -EOF +# Recharger la configuration sans redémarrer +sudo systemctl reload prometheus + +# Voir les journaux +sudo journalctl -u prometheus -f ``` -Rechargez systemd, puis activez et démarrez le service : +| Chemin | Rôle | +| -------------------------------- | ------------------------------------- | +| `/etc/prometheus/prometheus.yml` | Configuration principale | +| `/var/lib/prometheus/` | Base de données de séries temporelles | -```bash -sudo systemctl daemon-reload -sudo systemctl enable --now prometheus -sudo systemctl status prometheus -``` +## Sécurité -## Configurer Prometheus +Le port 9090 est ouvert sur l'interface réseau de la machine virtuelle, et Prometheus n'a **pas +d'authentification intégrée**. UFW est activé et autorise SSH (port 22) et Prometheus (port 9090). -1. Ouvrez `http://:9090` dans un navigateur pour accéder au navigateur d'expressions - Prometheus et à l'interface intégrée. -2. Ajoutez des cibles de collecte en modifiant `/etc/prometheus/prometheus.yml` (par exemple, un - `node_exporter` exécuté sur un hôte), puis validez et rechargez : +**Pour limiter l'interface à une adresse IP précise:** ```bash -promtool check config /etc/prometheus/prometheus.yml -sudo systemctl reload prometheus +sudo ufw delete allow 9090/tcp +sudo ufw allow from to any port 9090 ``` -3. Prometheus ne dispose d'aucune authentification propre. En production, placez-le derrière un - reverse proxy tel que Nginx ou Caddy pour ajouter le TLS et le contrôle d'accès sur le port 443, - et restreignez l'accès direct au port 9090. - -## Ouvrir le pare-feu - -L'instance n'autorise par défaut que le SSH (port 22) en externe. Ouvrez le port dont Prometheus a -besoin et ajoutez-le aux règles réseau/sécurité de l'instance dans le portail : +**Pour accéder à l'interface sans ouvrir le pare-feu, utilisez un tunnel SSH:** ```bash -sudo ufw allow 9090/tcp +# Exécuter cette commande sur votre machine locale +ssh -L 9090:localhost:9090 ubuntu@ ``` -## Étapes suivantes +**En production**, placez Prometheus derrière un proxy inverse comme Nginx ou Caddy pour ajouter TLS +et un contrôle d'accès sur le port 443, puis limitez l'accès direct au port 9090. + +## Prochaines étapes - [Documentation Prometheus](https://prometheus.io/docs/introduction/overview/) -- [Guide d'installation Prometheus](https://prometheus.io/docs/prometheus/latest/installation/) +- [Référence de configuration](https://prometheus.io/docs/prometheus/latest/configuration/configuration/) diff --git a/src/content/docs/fr/public-cloud/marketplace/supabase.md b/src/content/docs/fr/public-cloud/marketplace/supabase.md index bbd93e3..18e45a5 100644 --- a/src/content/docs/fr/public-cloud/marketplace/supabase.md +++ b/src/content/docs/fr/public-cloud/marketplace/supabase.md @@ -2,18 +2,23 @@ title: Supabase --- -Supabase est une alternative open source à Firebase, construite sur PostgreSQL. Elle regroupe une -base de données Postgres, l'authentification, des API REST et GraphQL instantanées, les abonnements -en temps réel, le stockage et un tableau de bord d'administration Studio dans une seule pile -auto-hébergeable. Le Studio et les API sont servis via la passerelle Kong sur le port 8000. +Supabase est une alternative open source à Firebase basée sur PostgreSQL. Elle regroupe une base +Postgres, l'authentification, des API REST et GraphQL instantanées, les abonnements en temps réel, +le stockage et un tableau de bord Studio dans une pile auto-hébergeable. Studio et les API sont +servis par la passerelle Kong sur le port 8000. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Supabase préconfigurée arrive bientôt. Pour l'instant, déployez une nouvelle instance -**Ubuntu 24.04 LTS** depuis la marketplace et suivez les étapes ci-dessous pour installer Supabase -vous-même. +| Composant | Version | +| -------------- | ------------------ | +| Supabase | Pile auto-hébergée | +| PostgreSQL | 17 | +| Docker | Dernière stable | +| Docker Compose | Dernière stable | +| Ubuntu | 24.04 LTS | -::: +La pile inclut Studio, la passerelle API Kong, Auth (GoTrue), PostgREST, Realtime, Storage et +postgres-meta, le tout sur PostgreSQL 17. ## Prérequis @@ -23,112 +28,92 @@ vous-même. | RAM | 4 Go | 8 Go | | Stockage | 30 Go | 80 Go | -## Déployer l'instance de base +## Variables d'environnement -1. Dans le portail ZSoftly Cloud, ouvrez **Apps**, sélectionnez **Supabase** et cliquez sur - **Deploy**, ou créez une instance **Ubuntu 24.04 LTS** depuis **Instances → Create**. Dans les - deux cas, vous obtenez une VM Ubuntu 24.04 propre. -2. Choisissez un plan qui répond aux prérequis ci-dessus et sélectionnez votre région (YOW-1 ou - YUL-1). -3. Lorsque l'instance est **Running**, connectez-vous en SSH : +Vous pouvez les définir au déploiement de Supabase depuis la Marketplace. Laissez un champ de mot de +passe vide pour générer automatiquement une valeur aléatoire sécurisée. -```bash -ssh ubuntu@ -``` +| Variable | Description | +| -------------------- | ---------------------------------------------------------------- | +| `SITE_URL` | URL publique de l'instance Supabase et du tableau de bord Studio | +| `POSTGRES_PASSWORD` | Mot de passe de la base PostgreSQL | +| `DASHBOARD_PASSWORD` | Mot de passe de connexion au tableau de bord Studio | + +Ce sont les seules variables à définir au déploiement. `SUPABASE_PUBLIC_URL` et `API_EXTERNAL_URL`, +mentionnées dans [Sécurité](#sécurité), se modifient dans `/data/supabase/.env` sur la VM en marche. + +## Démarrage -4. Mettez le système à jour : +### 1. Se connecter à la machine virtuelle ```bash -sudo apt update && sudo apt upgrade -y +ssh ubuntu@ ``` -## Installer Supabase - -Supabase s'auto-héberge sous forme de pile Docker Compose. Installez donc d'abord Docker Engine et -le plugin Compose. +### 2. Attendre la configuration au premier démarrage -Configurez le dépôt APT officiel de Docker pour Ubuntu 24.04 LTS (`noble`) : +Au premier démarrage, un script génère le mot de passe de base de données, le secret JWT, les clés +API et les identifiants Studio, puis télécharge les images de conteneurs et démarre la pile. Le +téléchargement est volumineux. Cela prend environ 15 à 20 minutes. Suivez la progression: ```bash -sudo apt install -y ca-certificates curl git -sudo install -m 0755 -d /etc/apt/keyrings -sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc -sudo chmod a+r /etc/apt/keyrings/docker.asc -sudo tee /etc/apt/sources.list.d/docker.sources >/dev/null <:8000 +``` -Le dépôt fournit des scripts d'aide pour générer des secrets et des clés d'API cohérents : +Connectez-vous avec le nom d'utilisateur `supabase` et le mot de passe généré. Les API REST et Auth +sont servies par la même passerelle à `http://:8000/rest/v1/` et +`http://:8000/auth/v1/`. -```bash -sh utils/generate-keys.sh -sh utils/add-new-auth-keys.sh -``` +## Gérer Supabase -Téléchargez les images et démarrez la pile : +Supabase s'exécute comme pile Docker Compose dans `/data/supabase`. ```bash -sudo docker compose pull -sudo docker compose up -d --wait -``` +# Vérifier l'état +cd /data/supabase && docker compose ps -Une fois les conteneurs sains, le tableau de bord Studio et les API sont servis via Kong sur le port -8000 : +# Redémarrer +cd /data/supabase && docker compose restart -- Tableau de bord Studio : `http://:8000` (connectez-vous avec `DASHBOARD_USERNAME` / - `DASHBOARD_PASSWORD`) -- API REST : `http://:8000/rest/v1/` -- API Auth : `http://:8000/auth/v1/` +# Voir les journaux +cd /data/supabase && docker compose logs -f +``` -Pour une configuration de production, placez Supabase derrière un reverse proxy tel que nginx avec -un certificat TLS, puis servez le Studio et les API en HTTPS au lieu d'exposer directement le -port 8000. +Configuration d'environnement: `/data/supabase/.env`. Les données de base de données et de stockage +sont stockées sous `/data/supabase/volumes`. -## Ouvrir le pare-feu +## Sécurité -L'instance n'autorise par défaut que le SSH (port 22) en externe. Ouvrez le ou les ports dont -Supabase a besoin et ajoutez-les aux règles réseau/de sécurité de l'instance dans le portail : +Les ports 8000, 80 et 443 sont ouverts sur l'interface réseau de la machine virtuelle. UFW est +activé et autorise ces ports ainsi que SSH (port 22). L'accès PostgreSQL direct (5432) n'est pas +exposé. -```bash -sudo ufw allow 8000/tcp -``` +Changez le mot de passe du tableau de bord Studio après la première connexion. **En production**, +définissez `SUPABASE_PUBLIC_URL`, `API_EXTERNAL_URL` et `SITE_URL` dans `/data/supabase/.env` avec +votre domaine, redémarrez la pile, puis placez Supabase derrière un proxy inverse comme nginx avec +un certificat TLS afin que Studio et les API soient servis en HTTPS au lieu d'exposer directement le +port 8000. -## Étapes suivantes +## Prochaines étapes - [Documentation Supabase](https://supabase.com/docs) -- [Guide d'auto-hébergement Supabase](https://supabase.com/docs/guides/self-hosting/docker) +- [Guide d'auto-hébergement](https://supabase.com/docs/guides/self-hosting/docker) diff --git a/src/content/docs/fr/public-cloud/marketplace/valkey.md b/src/content/docs/fr/public-cloud/marketplace/valkey.md index aa2503e..287e4ff 100644 --- a/src/content/docs/fr/public-cloud/marketplace/valkey.md +++ b/src/content/docs/fr/public-cloud/marketplace/valkey.md @@ -1,5 +1,5 @@ --- -title: Valkey 9.0 +title: Valkey 9.1 --- Valkey est un magasin de données en mémoire libre et haute performance, compatible avec Redis. Il @@ -10,7 +10,7 @@ réel, la messagerie pub/sub et les files de tâches. | Composant | Version | | --------- | --------- | -| Valkey | 9.0.x | +| Valkey | 9.1.x | | Ubuntu | 24.04 LTS | ## Variables d'environnement diff --git a/src/content/docs/fr/public-cloud/marketplace/vaultwarden.md b/src/content/docs/fr/public-cloud/marketplace/vaultwarden.md index de0c4cb..ed2f147 100644 --- a/src/content/docs/fr/public-cloud/marketplace/vaultwarden.md +++ b/src/content/docs/fr/public-cloud/marketplace/vaultwarden.md @@ -4,16 +4,20 @@ title: Vaultwarden Vaultwarden est un gestionnaire de mots de passe léger et auto-hébergé qui implémente l'API Bitwarden. Il est entièrement compatible avec les applications clientes et extensions de navigateur -officielles de Bitwarden, ce qui vous permet de stocker et de synchroniser mots de passe, notes -sécurisées et autres secrets sur une infrastructure que vous contrôlez. +Bitwarden officielles, ce qui permet de stocker et synchroniser mots de passe, notes sécurisées et +autres secrets sur une infrastructure que vous contrôlez. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Vaultwarden préconstruite arrive bientôt. Pour l'instant, déployez une instance **Ubuntu -24.04 LTS** neuve depuis la place de marché et suivez les étapes ci-dessous pour installer -Vaultwarden vous-même. +| Composant | Version | +| -------------- | --------------- | +| Vaultwarden | 1.36.0 | +| Docker | Dernière stable | +| Docker Compose | Dernière stable | +| Ubuntu | 24.04 LTS | -::: +Vaultwarden stocke ses données dans une base SQLite intégrée et sert le coffre web en HTTPS sur le +port 8000 avec un certificat autosigné généré au premier démarrage. ## Prérequis @@ -23,121 +27,102 @@ Vaultwarden vous-même. | RAM | 1 Go | 2 Go | | Stockage | 10 Go | 20 Go | -Vaultwarden est léger en ressources. Un nom de domaine et un certificat TLS sont fortement -recommandés, car les clients Bitwarden exigent HTTPS pour se connecter. - -## Déployer l'instance de base +Vaultwarden consomme peu de ressources. -1. Dans le portail ZSoftly Cloud, ouvrez **Apps** et passez à l'onglet **Marketplace**. Il s'ouvre - sur **Featured** par défaut, sélectionnez donc **Marketplace** à côté. Choisissez votre région - (YOW-1 ou YUL-1), recherchez **Ubuntu 24.04 LTS** et cliquez sur **Deploy**. Vous pouvez aussi - créer l'instance depuis **Instances → Create**. Dans les deux cas, vous obtenez une VM Ubuntu - 24.04 propre. +## Variables d'environnement - ![L'onglet Marketplace du portail ZSoftly Cloud, avec le sélecteur de région, la liste des catégories, la barre de recherche et les boutons Deploy](../../../../../assets/marketplace/deploy-marketplace-tab.webp) +Vous pouvez les définir au déploiement de Vaultwarden depuis la Marketplace. Laissez `ADMIN_TOKEN` +vide pour générer automatiquement une valeur aléatoire sécurisée. - ![Recherche d'une application dans le Marketplace, la barre de recherche filtrant le catalogue jusqu'à une carte Deploy correspondante](../../../../../assets/marketplace/deploy-marketplace-search.webp) +| Variable | Description | +| -------------------- | --------------------------------------------------------------------------------------- | +| `VAULTWARDEN_DOMAIN` | URL publique complète utilisée par les clients, par exemple `https://vault.example.com` | +| `ADMIN_TOKEN` | Jeton du panneau `/admin` | -2. Choisissez un plan qui répond aux prérequis ci-dessus. +## Démarrage -3. Lorsque l'instance est **Running**, connectez-vous en SSH: +### 1. Se connecter à la machine virtuelle ```bash ssh ubuntu@ ``` -4. Mettez le système à jour: - -```bash -sudo apt update && sudo apt upgrade -y -``` - -## Installer Vaultwarden +### 2. Attendre la configuration au premier démarrage -Vaultwarden est distribué sous forme d'image Docker officielle, installez donc d'abord Docker Engine -et le plugin Compose. - -Configurez le dépôt APT officiel de Docker pour Ubuntu 24.04 LTS (`noble`): +Au premier démarrage, un script génère un certificat TLS autosigné et le jeton administrateur, puis +démarre le conteneur avec Docker Compose. Cela prend moins d'une minute. Suivez la progression: ```bash -sudo apt install -y ca-certificates curl -sudo install -m 0755 -d /etc/apt/keyrings -sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc -sudo chmod a+r /etc/apt/keyrings/docker.asc -sudo tee /etc/apt/sources.list.d/docker.sources >/dev/null <:8000 ``` -## Configurer Vaultwarden +Le certificat autosigné déclenche un avertissement du navigateur. Acceptez l'exception pour +continuer. Le panneau d'administration se trouve à `https://:8000/admin`. -:::caution +:::note -Les applications clientes Bitwarden refusent de se connecter en HTTP simple. N'exposez pas -Vaultwarden directement. Placez-le toujours derrière un proxy inverse (Caddy, nginx ou Traefik) qui -termine TLS et transfère vers le port hôte 8080. +L'inscription libre des utilisateurs est désactivée par défaut (`SIGNUPS_ALLOWED=false`). Pour +ajouter des utilisateurs, ouvrez le panneau d'administration et invitez-les sous **Users**, ou +activez l'inscription ouverte sous **General Settings**. ::: -Un proxy inverse Caddy minimal vous offre HTTPS automatique. Faites pointer le DNS de votre domaine -vers la VM, puis: +## Gérer Vaultwarden + +Vaultwarden s'exécute comme pile Docker Compose dans `/data/vaultwarden`. ```bash -sudo apt install -y caddy -echo 'vault.example.com { - reverse_proxy 127.0.0.1:8080 -}' | sudo tee /etc/caddy/Caddyfile -sudo systemctl restart caddy +# Vérifier l'état +cd /data/vaultwarden && docker compose ps + +# Redémarrer +cd /data/vaultwarden && docker compose restart + +# Voir les journaux +cd /data/vaultwarden && docker compose logs -f ``` -Définissez `DOMAIN` dans la commande `docker run` ci-dessus avec votre véritable URL `https://` afin -que les icônes des éléments du coffre, les pièces jointes et WebAuthn fonctionnent correctement. Une -fois TLS actif, accédez à la page d'administration à `https://vault.example.com/admin` et -connectez-vous avec le mot de passe que vous avez haché dans `ADMIN_TOKEN`. Traitez ce jeton comme -un mot de passe root. +Configuration d'environnement: `/data/vaultwarden/vaultwarden.env`. La base du coffre et le +certificat sont stockés sous `/data/vaultwarden/data`. + +## Sécurité + +Le port 8000 est ouvert sur l'interface réseau de la machine virtuelle. UFW est activé et autorise +SSH (port 22) et le coffre web Vaultwarden (port 8000). Les clients Bitwarden exigent HTTPS, que +l'image sert avec un certificat autosigné par défaut. -## Ouvrir le pare-feu +Traitez le jeton administrateur comme un mot de passe root. -L'instance n'autorise par défaut que SSH (port 22) en externe. Ouvrez le port HTTPS que votre proxy -inverse sert et ajoutez-le aux règles réseau/sécurité de l'instance dans le portail: +**En production**, définissez `DOMAIN` avec l'URL publique complète utilisée par les clients, y +compris le schéma et le port ou chemin éventuel (par exemple `https://vault.example.com` ou +`https://:8000`), dans `/data/vaultwarden/vaultwarden.env`, remplacez le certificat +autosigné par un certificat de confiance (ou placez Vaultwarden derrière un proxy inverse comme +Caddy qui termine TLS), puis redémarrez la pile: ```bash -sudo ufw allow 80/tcp -sudo ufw allow 443/tcp +cd /data/vaultwarden && docker compose restart ``` -## Étapes suivantes +## Prochaines étapes - [Documentation Vaultwarden](https://github.com/dani-garcia/vaultwarden/wiki) -- [Guide d'installation Vaultwarden](https://github.com/dani-garcia/vaultwarden/wiki/Starting-with-Docker) +- [Activer HTTPS](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-HTTPS) diff --git a/src/content/docs/fr/public-cloud/marketplace/zabbix.md b/src/content/docs/fr/public-cloud/marketplace/zabbix.md index acff933..9697505 100644 --- a/src/content/docs/fr/public-cloud/marketplace/zabbix.md +++ b/src/content/docs/fr/public-cloud/marketplace/zabbix.md @@ -2,18 +2,19 @@ title: Zabbix --- -Zabbix est une plateforme de supervision open source de niveau entreprise pour les réseaux, -serveurs, services cloud et applications. Elle collecte des métriques via des agents, SNMP, IPMI et -des contrôles sans agent, puis fournit alertes, visualisation et tableaux de bord depuis un frontend -web unique. Ce guide installe le serveur Zabbix, le frontend web et l'agent avec une base MySQL sur -Apache. +Zabbix est une plateforme de supervision open source pour les réseaux, serveurs, services cloud et +applications. Elle collecte des métriques via des agents, SNMP, IPMI et des contrôles sans agent, +puis fournit alertes, visualisation et tableaux de bord depuis un frontend web unique. Cette image +fournit le serveur Zabbix, le frontend web et l'agent avec une base MySQL sur Apache. -:::note[Bientôt disponible] +## Logiciels inclus -Une image Zabbix préconfigurée arrive bientôt. Pour l'instant, déployez une instance **Ubuntu 24.04 -LTS** neuve depuis la marketplace et suivez les étapes ci-dessous pour installer Zabbix vous-même. - -::: +| Composant | Version | +| --------- | --------- | +| Zabbix | 7.0 (LTS) | +| MySQL | 8.0 | +| Apache | 2.4.x | +| Ubuntu | 24.04 LTS | ## Prérequis @@ -23,111 +24,91 @@ LTS** neuve depuis la marketplace et suivez les étapes ci-dessous pour installe | RAM | 2 Go | 4 Go | | Stockage | 30 Go | 60 Go | -## Déployer l'instance de base - -1. Dans le portail ZSoftly Cloud, ouvrez **Apps** et passez à l'onglet **Marketplace**. Il s'ouvre - sur **Featured** par défaut, sélectionnez donc **Marketplace** à côté. Choisissez votre région - (YOW-1 ou YUL-1), recherchez **Ubuntu 24.04 LTS** et cliquez sur **Deploy**. Vous pouvez aussi - créer l'instance depuis **Instances → Create**. Dans les deux cas, vous obtenez une VM Ubuntu - 24.04 propre. - - ![L'onglet Marketplace du portail ZSoftly Cloud, avec le sélecteur de région, la liste des catégories, la barre de recherche et les boutons Deploy](../../../../../assets/marketplace/deploy-marketplace-tab.webp) +## Variables d'environnement - ![Recherche d'une application dans le Marketplace, la barre de recherche filtrant le catalogue jusqu'à une carte Deploy correspondante](../../../../../assets/marketplace/deploy-marketplace-search.webp) +Cette image n'accepte aucune variable au déploiement. Elle ne crée aucun mot de passe administrateur +partagé. Zabbix est livré avec un mot de passe `Admin` par défaut, et le premier démarrage le +remplace par une valeur propre à votre machine virtuelle. -2. Choisissez un plan qui répond aux prérequis ci-dessus. +## Démarrage -3. Lorsque l'instance est **Running**, connectez-vous en SSH: +### 1. Connectez-vous à votre VM ```bash ssh ubuntu@ ``` -4. Mettez le système à jour: +### 2. Attendez la configuration au premier démarrage + +Au premier démarrage, un script initialise MySQL, importe le schéma Zabbix, écrit la configuration +du frontend, démarre les services et remplace le mot de passe `Admin` par défaut. Suivez la +progression: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u zabbix-first-boot.service -f ``` -## Installer Zabbix +Le message de connexion (MOTD) confirme que Zabbix est prêt. -Installez d'abord le serveur de base de données MySQL et Apache: +### 3. Récupérez le mot de passe administrateur -```bash -sudo apt install -y mysql-server apache2 -``` - -Ajoutez le dépôt officiel Zabbix. Zabbix 7.4 est la version stable actuelle. Installez le deb -`zabbix-release` pour Ubuntu 24.04 (`noble`): +Les identifiants sont écrits dans un fichier réservé à root: ```bash -wget https://repo.zabbix.com/zabbix/7.4/release/ubuntu/pool/main/z/zabbix-release/zabbix-release_latest_7.4+ubuntu24.04_all.deb -sudo dpkg -i zabbix-release_latest_7.4+ubuntu24.04_all.deb -sudo apt update +sudo cat /root/.credentials/zabbix.txt ``` -Installez les paquets du serveur, du frontend et de l'agent Zabbix: +### 4. Ouvrez le frontend web -```bash -sudo apt install -y zabbix-server-mysql zabbix-frontend-php \ - zabbix-apache-conf zabbix-sql-scripts zabbix-agent2 +Ouvrez un navigateur à l'adresse: + +```text +http:///zabbix/ ``` -## Configurer Zabbix +Connectez-vous en tant que `Admin` avec le mot de passe de l'étape précédente. -1. Créez la base de données et l'utilisateur Zabbix dans MySQL: +:::caution - ```bash - sudo mysql -uroot -e "CREATE DATABASE zabbix CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;" - sudo mysql -uroot -e "CREATE USER 'zabbix'@'localhost' IDENTIFIED BY 'ChangeThisPassword';" - sudo mysql -uroot -e "GRANT ALL PRIVILEGES ON zabbix.* TO 'zabbix'@'localhost';" - sudo mysql -uroot -e "SET GLOBAL log_bin_trust_function_creators = 1;" - ``` +Zabbix est livré avec un mot de passe `Admin` par défaut bien connu. Cette image le remplace au +premier démarrage, ne réutilisez donc pas la valeur par défaut documentée par le projet en amont. -2. Importez le schéma et les données initiales (le mot de passe `zabbix` vous sera demandé): +::: - ```bash - sudo zcat /usr/share/zabbix-sql-scripts/mysql/server.sql.gz \ - | mysql --default-character-set=utf8mb4 -uzabbix -p zabbix - ``` +## Gérer Zabbix -3. Désactivez de nouveau l'option de création de fonctions: +```bash +# Vérifier l'état +sudo systemctl status zabbix-server apache2 mysql - ```bash - sudo mysql -uroot -e "SET GLOBAL log_bin_trust_function_creators = 0;" - ``` +# Redémarrer le serveur +sudo systemctl restart zabbix-server -4. Définissez le mot de passe de la base dans `/etc/zabbix/zabbix_server.conf` en décommentant et en - modifiant la ligne `DBPassword=` pour qu'elle corresponde au mot de passe ci-dessus. -5. Démarrez et activez tous les services: +# Consulter les journaux +sudo tail -f /var/log/zabbix/zabbix_server.log +``` - ```bash - sudo systemctl restart zabbix-server zabbix-agent2 apache2 - sudo systemctl enable zabbix-server zabbix-agent2 apache2 - ``` +La configuration du serveur se trouve dans `/etc/zabbix/zabbix_server.conf` et celle du frontend +dans `/etc/zabbix/web/`. -6. Ouvrez `http:///zabbix` dans votre navigateur et complétez l'assistant de - configuration web (connexion à la base, détails du serveur, fuseau horaire). -7. Connectez-vous avec les identifiants par défaut **Admin** / **zabbix**, puis changez - immédiatement le mot de passe Admin sous **Users → Users**. -8. Pour la production, configurez Apache avec votre domaine et un certificat TLS afin que le - frontend soit servi en HTTPS sur le port 443. +## Sécurité -## Ouvrir le pare-feu +Le port 80 (frontend web) et le port 10051 (serveur Zabbix, utilisé par les agents pour remonter +leurs données) sont ouverts sur l'interface réseau de la VM. UFW est activé et autorise ces ports +ainsi que SSH (port 22). -Par défaut, l'instance n'autorise que le SSH (port 22) depuis l'extérieur. Ouvrez les ports dont -Zabbix a besoin et ajoutez-les aux règles réseau/sécurité de l'instance dans le portail: +**Pour restreindre le frontend web à une adresse IP précise:** ```bash -sudo ufw allow 80/tcp -sudo ufw allow 443/tcp -sudo ufw allow 10051/tcp +sudo ufw delete allow 80/tcp +sudo ufw allow from to any port 80 ``` -Les ports 80/443 servent le frontend web. Le port 10051 est le port du serveur Zabbix utilisé par -les agents actifs et les proxies qui remontent leurs données. +**En production**, pointez un enregistrement DNS vers la VM et placez Apache derrière TLS, avec +votre propre certificat ou un reverse proxy qui termine le TLS. -## Étapes suivantes +## Prochaines étapes -- [Documentation Zabbix](https://www.zabbix.com/documentation/current/) -- [Guide d'installation de Zabbix](https://www.zabbix.com/download) +- [Documentation Zabbix](https://www.zabbix.com/documentation/7.0/en/) +- [Configuration de l'agent Zabbix](https://www.zabbix.com/documentation/7.0/en/manual/appendix/config/zabbix_agentd) +- [Référence de l'API Zabbix](https://www.zabbix.com/documentation/7.0/en/manual/api) diff --git a/src/content/docs/fr/tutorials/index.md b/src/content/docs/fr/tutorials/index.md index a6bf6fd..63010b7 100644 --- a/src/content/docs/fr/tutorials/index.md +++ b/src/content/docs/fr/tutorials/index.md @@ -38,3 +38,17 @@ Vous apprenez à : - [Démarrage rapide Public Cloud](/fr/public-cloud/getting-started/quickstart) : le même premier déploiement depuis le portail web - [Journal des modifications](/fr/changelog) : les nouveautés de la plateforme + +### [Gérer ZCP avec Terraform ou OpenTofu](/tutorials/manage-infrastructure-terraform) + +Provisionnez un réseau et une machine virtuelle de manière déclarative avec le fournisseur officiel +`zsoftly/zcp`, publié dans les registres Terraform et OpenTofu. Vous écrivez un fichier de +configuration, l'appliquez, le modifiez et le détruisez, et chaque ressource reste suivie. Environ +15 minutes. (Tutoriel en anglais.) + +Vous apprenez à : + +- Installer le fournisseur et vous authentifier avec un jeton API +- Décrire un réseau et une VM en HCL puis appliquer le plan +- Redimensionner une VM sans la recréer et importer des ressources créées ailleurs +- Détruire la pile entière sans laisser de ressources orphelines diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index 77f222f..ee3e865 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -193,7 +193,7 @@ hero:

Terraform / OpenTofu

-

Manage ZCP infrastructure as code. Provider in development at github.com/zsoftly/terraform-provider-zcp.

+

Manage ZCP infrastructure as code. Ships as zsoftly/zcp on the Terraform and OpenTofu registries.

diff --git a/src/content/docs/public-cloud/api/quickstart.mdx b/src/content/docs/public-cloud/api/quickstart.mdx index e82b7a6..f608399 100644 --- a/src/content/docs/public-cloud/api/quickstart.mdx +++ b/src/content/docs/public-cloud/api/quickstart.mdx @@ -756,12 +756,11 @@ echo $body["message"] . "\n"; ### Infrastructure as Code (IaC) -:::note - -A ZSoftly **Terraform** provider is coming soon. It will manage virtual machines, networks, and -storage declaratively. Example configurations will be published here. - -::: +The official **Terraform / OpenTofu** provider manages virtual machines, networks, Kubernetes, DNS, +storage, and more, declaratively. Find it as `zsoftly/zcp` on the +[Terraform Registry](https://registry.terraform.io/providers/zsoftly/zcp) and the +[OpenTofu registry](https://search.opentofu.org/provider/zsoftly/zcp). Start with the +[Terraform / OpenTofu tutorial](/tutorials/manage-infrastructure-terraform). ### Configuration Management diff --git a/src/content/docs/public-cloud/marketplace/authentik.md b/src/content/docs/public-cloud/marketplace/authentik.md index 92a725a..5383d65 100644 --- a/src/content/docs/public-cloud/marketplace/authentik.md +++ b/src/content/docs/public-cloud/marketplace/authentik.md @@ -4,15 +4,20 @@ title: Authentik Authentik is an open-source identity provider that centralises authentication for your applications. It supports SSO over OAuth 2.0, OpenID Connect, SAML, LDAP, and proxy/forward-auth, with flexible -flows, policies, and a self-service user portal. This guide deploys Authentik with its official -Docker Compose stack. +flows, policies, and a self-service user portal. -:::note[Coming soon] +## Software included -A pre-built Authentik image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance -from the marketplace and follow the steps below to install Authentik yourself. +| Component | Version | +| ---------- | ------------- | +| Authentik | 2026.5.4 | +| PostgreSQL | 18 | +| Docker | Latest stable | +| Ubuntu | 24.04 LTS | -::: +Authentik runs its server and worker containers with PostgreSQL, as a Docker Compose stack. Redis is +no longer required. Authentik moved caching, background tasks, and WebSocket communication to +PostgreSQL, so the stack is PostgreSQL, the server, and the worker. ## Requirements @@ -22,99 +27,92 @@ from the marketplace and follow the steps below to install Authentik yourself. | RAM | 2 GB | 4 GB | | Storage | 20 GB | 40 GB | -## Deploy the base instance +## Environment variables -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab, search for - **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from **Instances → - Create**. Either way you get a clean Ubuntu 24.04 VM. -2. Choose a plan that meets the requirements above and pick your region (YOW-1 or YUL-1). -3. When the instance is **Running**, connect over SSH: +You can optionally set these when deploying Authentik from the marketplace. Leave a password field +blank to have a secure random value generated automatically. -```bash -ssh ubuntu@ -``` +| Variable | Description | +| ------------------------------ | ---------------------------------------------- | +| `AUTHENTIK_HOSTNAME` | Public hostname or IP Authentik is served from | +| `AUTHENTIK_BOOTSTRAP_EMAIL` | Email for the initial `akadmin` account | +| `AUTHENTIK_BOOTSTRAP_PASSWORD` | Password for the initial `akadmin` account | -4. Update the system: +## Getting started + +### 1. Connect to your VM ```bash -sudo apt update && sudo apt upgrade -y +ssh ubuntu@ ``` -## Install Authentik +### 2. Wait for first-boot configuration -Authentik ships an official Docker Compose stack, so install Docker Engine and the Compose plugin -first. - -Set up Docker's official APT repository for Ubuntu 24.04 LTS (`noble`): +On the first boot, a setup script generates the admin, database, and secret-key values, writes the +environment file, and starts the stack with Docker Compose. This takes 1-2 minutes. Track progress: ```bash -sudo apt install -y ca-certificates curl -sudo install -m 0755 -d /etc/apt/keyrings -sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc -sudo chmod a+r /etc/apt/keyrings/docker.asc -sudo tee /etc/apt/sources.list.d/docker.sources >/dev/null <:9000 ``` -## Configure Authentik +Sign in with the `akadmin` email and the generated password. HTTPS is also available on port 9443 +with a self-signed certificate. + +## Managing Authentik -Pull the images and start the stack: +Authentik runs as a Docker Compose stack in `/opt/authentik`. ```bash -sudo docker compose pull -sudo docker compose up -d -``` +# Check status +cd /opt/authentik && docker compose ps -Authentik serves HTTP on port 9000 and HTTPS on port 9443 by default. Complete the first-run setup -by browsing to the initial-setup flow, which creates the default `akadmin` account and sets its -password: +# Restart +cd /opt/authentik && docker compose restart -```text -http://:9000/if/flow/initial-setup/ +# View logs +cd /opt/authentik && docker compose logs -f ``` -For a production deployment, point a DNS record at the VM and front Authentik with TLS. You can use -the built-in HTTPS on port 9443, or place it behind a reverse proxy (Caddy, nginx, or Traefik) that -terminates TLS and forwards to port 9000. +Environment configuration: `/opt/authentik/.env`. Database, media, and certificate data are stored +under `/opt/authentik`. + +## Security -## Open the firewall +Ports 9000 (HTTP) and 9443 (HTTPS) are open on the VM's network interface. UFW is enabled and allows +those ports plus SSH (port 22). Authentik serves a default self-signed certificate on 9443. -The instance allows only SSH (port 22) externally by default. Open the ports Authentik serves and -add them to the instance's network/security rules in the portal: +**To restrict access to a specific IP:** ```bash -sudo ufw allow 9000/tcp -sudo ufw allow 9443/tcp +sudo ufw delete allow 9000/tcp +sudo ufw delete allow 9443/tcp +sudo ufw allow from to any port 9000 +sudo ufw allow from to any port 9443 ``` +**For production use**, point a DNS record at the VM and front Authentik with TLS, either using the +built-in HTTPS on 9443 with your own certificate, or a reverse proxy (Caddy, nginx, or Traefik) that +terminates TLS and forwards to port 9000. + ## Next steps - [Authentik documentation](https://docs.goauthentik.io/) -- [Authentik installation guide](https://docs.goauthentik.io/install-config/install/docker-compose/) +- [Configuration reference](https://docs.goauthentik.io/docs/install-config/configuration/) diff --git a/src/content/docs/public-cloud/marketplace/coolify.md b/src/content/docs/public-cloud/marketplace/coolify.md index 83a9e29..979ce60 100644 --- a/src/content/docs/public-cloud/marketplace/coolify.md +++ b/src/content/docs/public-cloud/marketplace/coolify.md @@ -6,12 +6,14 @@ Coolify is an open-source, self-hosted PaaS and a drop-in alternative to Heroku, Vercel. It deploys applications, databases, and services to your own server with Git-based workflows and a web dashboard, while keeping all your data under your control. -:::note[Coming soon] +## Software included -A pre-built Coolify image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance from -the marketplace and follow the steps below to install Coolify yourself. - -::: +| Component | Version | +| -------------- | ------------- | +| Coolify | 4.1.2 | +| Docker | Latest stable | +| Docker Compose | Latest stable | +| Ubuntu | 24.04 LTS | ## Requirements @@ -21,72 +23,82 @@ the marketplace and follow the steps below to install Coolify yourself. | RAM | 2 GB | 4 GB | | Storage | 30 GB | 60 GB | -## Deploy the base instance +Coolify also runs the applications you deploy, so size the instance for those workloads too. -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab. It opens on - **Featured** by default, so select **Marketplace** next to it. Pick your region (YOW-1 or YUL-1), - search for **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from - **Instances → Create**. Either way you get a clean Ubuntu 24.04 VM. +## Getting started - ![The Marketplace tab in the ZSoftly Cloud portal, showing the region selector, category list, search box, and Deploy buttons](../../../../assets/marketplace/deploy-marketplace-tab.webp) +### 1. Connect to your VM - ![Searching the Marketplace for an app, with the search box filtering the catalog down to a matching Deploy card](../../../../assets/marketplace/deploy-marketplace-search.webp) +```bash +ssh ubuntu@ +``` -2. Choose a plan that meets the requirements above. +### 2. Wait for first-boot configuration -3. When the instance is **Running**, connect over SSH: +On the first boot, a setup script generates the application secrets and starts the full Coolify +stack with Docker Compose. This takes 1-2 minutes. Track progress: ```bash -ssh ubuntu@ +journalctl -u coolify-first-boot.service -f ``` -4. Update the system: +The login message (MOTD) confirms when Coolify is ready. -```bash -sudo apt update && sudo apt upgrade -y +### 3. Create the administrator account + +Open the dashboard in your browser: + +```text +http://:8000 ``` -## Install Coolify +The first account you create becomes the root administrator. Set a strong email and password +immediately, since registration closes after the first user. + +### 4. Configure your instance + +1. Under **Settings**, set your instance's domain so Coolify can issue Let's Encrypt TLS + certificates and serve the dashboard over HTTPS. Coolify includes a built-in reverse proxy that + handles routing and certificates for both the dashboard and your deployed apps. DNS must point at + the VM before certificates can be issued. +2. Connect a Git source (GitHub, GitLab, or a generic repository) to start deploying applications. + +## Managing Coolify -Coolify ships an official one-line installer that sets up Docker, Docker Compose, and the full -Coolify stack for you. Run it as root: +Coolify runs as a Docker Compose stack in `/data/coolify/source`. ```bash -curl -fsSL https://cdn.coollabs.io/coolify/install.sh | sudo bash -``` +# Check status +cd /data/coolify/source && docker compose ps + +# Restart +cd /data/coolify/source && docker compose restart -The installer pulls the required images and starts every service. When it finishes, it prints the -dashboard URL. Nothing else needs to be installed by hand. +# View logs +cd /data/coolify/source && docker compose logs -f +``` -## Configure Coolify +A summary of URLs and paths is written to `/data/coolify/info.txt`. -1. Open the dashboard in your browser at `http://:8000`. -2. The first account you create becomes the root administrator. Set a strong email and password - immediately, as registration closes after the first user. -3. Under **Settings**, set your instance's domain so Coolify can issue Let's Encrypt TLS - certificates and serve the dashboard over HTTPS. Coolify includes a built-in Traefik reverse - proxy that handles routing and certificates for both the dashboard and your deployed apps, so no - separate proxy is required. -4. Add your server's public SSH key and connect a Git source (GitHub, GitLab, or a generic - repository) to start deploying applications. +## Security -## Open the firewall +Ports 8000 (dashboard), 6001 (realtime), 6002 (terminal), 80, and 443 are open on the VM's network +interface. UFW is enabled and allows those ports plus SSH (port 22). Ports 80 and 443 serve your +deployed apps and TLS. -The instance allows only SSH (port 22) externally by default. Open the ports Coolify needs and add -them to the instance's network/security rules in the portal: +Once you configure a custom domain with Let's Encrypt, reach the dashboard over HTTPS on port 443. +You can then close ports 8000, 6001, and 6002 if you no longer need direct access: ```bash -sudo ufw allow 8000/tcp -sudo ufw allow 80/tcp -sudo ufw allow 443/tcp -sudo ufw allow 6001/tcp -sudo ufw allow 6002/tcp +sudo ufw delete allow 8000/tcp +sudo ufw delete allow 6001/tcp +sudo ufw delete allow 6002/tcp ``` -Ports 80 and 443 serve your deployed apps and TLS. Ports 6001 and 6002 are used by Coolify's -realtime and terminal features. +Complete the administrator setup promptly after first boot so no one else can claim the root +account. ## Next steps - [Coolify documentation](https://coolify.io/docs) -- [Coolify installation guide](https://coolify.io/docs/get-started/installation) +- [Getting started with Coolify](https://coolify.io/docs/get-started/introduction) diff --git a/src/content/docs/public-cloud/marketplace/dify.md b/src/content/docs/public-cloud/marketplace/dify.md index 7832d80..88ad3fb 100644 --- a/src/content/docs/public-cloud/marketplace/dify.md +++ b/src/content/docs/public-cloud/marketplace/dify.md @@ -6,12 +6,17 @@ Dify is an open-source platform for building LLM applications and AI agents. It workflow builder, retrieval-augmented generation (RAG) pipelines, prompt management, and an agent framework so teams can design, test, and deploy generative-AI apps from one interface. -:::note[Coming soon] +## Software included -A pre-built Dify image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance from the -marketplace and follow the steps below to install Dify yourself. +| Component | Version | +| -------------- | ------------- | +| Dify | 1.15.0 | +| Docker | Latest stable | +| Docker Compose | Latest stable | +| Ubuntu | 24.04 LTS | -::: +Dify runs as a multi-container Docker Compose stack (API, worker, web, PostgreSQL, Redis, Weaviate +vector store, and nginx). ## Requirements @@ -21,117 +26,83 @@ marketplace and follow the steps below to install Dify yourself. | RAM | 4 GB | 8 GB | | Storage | 40 GB | 80 GB | -Dify runs as a multi-container Docker Compose stack (API, worker, web, database, vector store, and -nginx), so RAM and storage requirements grow with usage. +RAM and storage requirements grow with usage. -## Deploy the base instance +## Getting started -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab. It opens on - **Featured** by default, so select **Marketplace** next to it. Pick your region (YOW-1 or YUL-1), - search for **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from - **Instances → Create**. Either way you get a clean Ubuntu 24.04 VM. - - ![The Marketplace tab in the ZSoftly Cloud portal, showing the region selector, category list, search box, and Deploy buttons](../../../../assets/marketplace/deploy-marketplace-tab.webp) - - ![Searching the Marketplace for an app, with the search box filtering the catalog down to a matching Deploy card](../../../../assets/marketplace/deploy-marketplace-search.webp) - -2. Choose a plan that meets the requirements above. - -3. When the instance is **Running**, connect over SSH: +### 1. Connect to your VM ```bash ssh ubuntu@ ``` -4. Update the system: +### 2. Wait for first-boot configuration + +On the first boot, a setup script generates the internal database and Redis secrets, writes the +environment file, and starts the stack with Docker Compose. This takes a few minutes while the +containers become healthy. Track progress: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u dify-first-boot.service -f ``` -## Install Dify +The login message (MOTD) confirms when Dify is ready and prints the internal credentials. -Dify ships as a Docker Compose stack, so install Docker Engine and the Compose plugin first. +### 3. Complete the admin setup -Set up Docker's official APT repository for Ubuntu 24.04 LTS (`noble`): +Open a browser and complete the one-time admin setup: -```bash -sudo apt install -y ca-certificates curl -sudo install -m 0755 -d /etc/apt/keyrings -sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc -sudo chmod a+r /etc/apt/keyrings/docker.asc -sudo tee /etc/apt/sources.list.d/docker.sources >/dev/null </install ``` -Install Docker Engine and the Compose plugin: +Create the admin account (email and password of your choice), then sign in at +`http:///`. -```bash -sudo apt update -sudo apt install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -``` +### 4. Add a model provider -Allow the `ubuntu` user to run Docker without sudo, then re-open your SSH session: +From **Settings → Model Provider**, add an LLM provider (such as OpenAI, Anthropic, or a self-hosted +Ollama endpoint) before building apps. -```bash -sudo usermod -aG docker ubuntu -``` +### 5. Review the generated credentials -Clone the latest Dify release, copy the environment file, and start the stack: +The internal database and Redis passwords are written to a root-only file: ```bash -sudo apt install -y git jq -git clone --branch "$(curl -s https://api.github.com/repos/langgenius/dify/releases/latest | jq -r .tag_name)" https://github.com/langgenius/dify.git -cd dify/docker -cp .env.example .env -docker compose up -d +sudo cat /etc/dify/credentials.txt ``` -Confirm all containers are up: +## Managing Dify -```bash -docker compose ps -``` +Dify runs as a Docker Compose stack in `/opt/dify/docker`. -## Configure Dify +```bash +# Check status +cd /opt/dify/docker && docker compose ps -The stack's nginx container publishes ports 80 and 443. Open a browser and complete the one-time -admin setup: +# Restart +cd /opt/dify/docker && docker compose restart -```text -http:///install +# View logs +cd /opt/dify/docker && docker compose logs -f ``` -Create the admin account, then sign in at `http:///`. From **Settings → Model -Provider**, add an LLM provider (such as OpenAI, Anthropic, or a self-hosted Ollama endpoint) before -building apps. - -For production, edit `dify/docker/.env` to set a public-facing URL and enable HTTPS. Dify can -terminate TLS through its bundled nginx (set `NGINX_HTTPS_ENABLED=true` and mount certificates), or -you can run it behind your own reverse proxy. Apply changes with: +Environment configuration: `/opt/dify/docker/.env`. Persistent data is stored under +`/opt/dify/docker/volumes`. -```bash -cd ~/dify/docker -docker compose down && docker compose up -d -``` +## Security -## Open the firewall +Ports 80 and 443 are open on the VM's network interface. UFW is enabled and allows SSH (port 22), +HTTP (80), and HTTPS (443). -The instance allows only SSH (port 22) externally by default. Open the ports Dify needs and add them -to the instance's network/security rules in the portal: +Dify serves plain HTTP by default. **For production use**, put it behind your own reverse proxy with +TLS, or configure HTTPS and the public URL in `/opt/dify/docker/.env`. Apply `.env` changes with: ```bash -sudo ufw allow 80/tcp -sudo ufw allow 443/tcp +cd /opt/dify/docker && docker compose down && docker compose up -d ``` ## Next steps - [Dify documentation](https://docs.dify.ai/) -- [Dify installation guide](https://docs.dify.ai/en/getting-started/install-self-hosted/docker-compose) +- [Dify self-hosting guide](https://docs.dify.ai/en/getting-started/install-self-hosted/docker-compose) diff --git a/src/content/docs/public-cloud/marketplace/docker.md b/src/content/docs/public-cloud/marketplace/docker.md index 432a2d8..5cb24bc 100644 --- a/src/content/docs/public-cloud/marketplace/docker.md +++ b/src/content/docs/public-cloud/marketplace/docker.md @@ -14,6 +14,14 @@ pre-installed, ready for you to deploy any containerised workload. | Docker Compose plugin | Latest stable | | Ubuntu | 24.04 LTS | +:::note + +Docker Engine 29 stores images in the containerd image store on a fresh install. Images you pull or +build are held there rather than in the classic graph driver, which changes the output of some +`docker image` commands and enables multi-platform images by default. + +::: + ## Getting started ### 1. Connect to your VM diff --git a/src/content/docs/public-cloud/marketplace/drupal.md b/src/content/docs/public-cloud/marketplace/drupal.md index 310dbca..0dd3249 100644 --- a/src/content/docs/public-cloud/marketplace/drupal.md +++ b/src/content/docs/public-cloud/marketplace/drupal.md @@ -6,12 +6,19 @@ Drupal is an open-source content management system for content-heavy websites an entity model, taxonomy, and module ecosystem let teams build custom content types, editorial workflows, and multilingual sites without writing the underlying code themselves. -:::note[Coming soon] +## Software included -A pre-built Drupal image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance from -the marketplace and follow the steps below to install Drupal yourself. +| Component | Version | +| --------- | --------- | +| Drupal | 11.4.1 | +| PHP | 8.3 | +| Apache | Latest | +| MariaDB | Latest | +| Drush | 13 | +| Ubuntu | 24.04 LTS | -::: +Drupal runs on a native LAMP stack (Apache, MariaDB, PHP). The site is pre-installed with the +**Standard** profile, so it is ready to use as soon as the VM boots. ## Requirements @@ -21,116 +28,95 @@ the marketplace and follow the steps below to install Drupal yourself. | RAM | 2 GB | 4 GB | | Storage | 20 GB | 40 GB | -Drupal 11 runs on a LAMP stack (Linux, Apache, MySQL/MariaDB, PHP 8.3+). Storage needs grow with -media uploads and the number of installed modules. - -## Deploy the base instance - -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab. It opens on - **Featured** by default, so select **Marketplace** next to it. Pick your region (YOW-1 or YUL-1), - search for **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from - **Instances → Create**. Either way you get a clean Ubuntu 24.04 VM. +Storage needs grow with media uploads and the number of installed modules. - ![The Marketplace tab in the ZSoftly Cloud portal, showing the region selector, category list, search box, and Deploy buttons](../../../../assets/marketplace/deploy-marketplace-tab.webp) +## Getting started - ![Searching the Marketplace for an app, with the search box filtering the catalog down to a matching Deploy card](../../../../assets/marketplace/deploy-marketplace-search.webp) - -2. Choose a plan that meets the requirements above. - -3. When the instance is **Running**, connect over SSH: +### 1. Connect to your VM ```bash ssh ubuntu@ ``` -4. Update the system: +### 2. Wait for first-boot configuration + +On the first boot, a setup script creates the database, installs the Drupal site with Drush, and +generates the admin and database passwords. This takes 1-2 minutes. Track progress: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u drupal-first-boot.service -f ``` -## Install the LAMP stack +The login message (MOTD) confirms when Drupal is ready. -Install Apache, MariaDB, PHP 8.3, and the PHP extensions Drupal needs: +### 3. Retrieve the admin credentials + +The admin password, along with the database credentials, is written to a root-only file: ```bash -sudo apt install -y apache2 mariadb-server \ - php php-cli php-mysql php-gd php-xml php-mbstring php-curl php-zip php-intl php-apcu \ - libapache2-mod-php composer git unzip +sudo cat /root/.credentials/drupal.txt ``` -Lock down the database and answer the prompts (set a root password, remove anonymous users, and -disallow remote root login): +### 4. Sign in to the admin area -```bash -sudo mysql_secure_installation +Open the site in a browser: + +```text +http:/// ``` -Create a database and a dedicated user for Drupal: +Sign in at the admin login page: -```bash -sudo mysql <<'SQL' -CREATE DATABASE drupal CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci; -CREATE USER 'drupal'@'localhost' IDENTIFIED BY 'change-this-password'; -GRANT ALL PRIVILEGES ON drupal.* TO 'drupal'@'localhost'; -FLUSH PRIVILEGES; -SQL +```text +http:///user/login ``` -## Install Drupal +| Field | Value | +| -------- | ------------------------------------ | +| Username | `admin` | +| Password | From `/root/.credentials/drupal.txt` | + +## Managing Drupal -Create the project with Composer and hand ownership of the docroot to Apache: +Drupal is served by Apache with MariaDB, both managed by systemd. ```bash -cd /var/www -sudo composer create-project drupal/recommended-project drupal -sudo chown -R www-data:www-data /var/www/drupal -``` +# Service status +systemctl status apache2 +systemctl status mariadb -Point Apache at the `web/` docroot and enable URL rewriting: +# Restart the web server +sudo systemctl restart apache2 -```bash -sudo tee /etc/apache2/sites-available/drupal.conf >/dev/null <<'EOF' - - DocumentRoot /var/www/drupal/web - - AllowOverride All - Require all granted - - ErrorLog ${APACHE_LOG_DIR}/drupal-error.log - CustomLog ${APACHE_LOG_DIR}/drupal-access.log combined - -EOF -sudo a2ensite drupal -sudo a2dissite 000-default -sudo a2enmod rewrite -sudo systemctl reload apache2 +# Run Drush commands from the project root +cd /var/www/drupal && vendor/bin/drush status +cd /var/www/drupal && vendor/bin/drush cache:rebuild ``` -## Complete the web installer +| Path | Purpose | +| ------------------------------------------------ | ------------------------ | +| `/var/www/drupal` | Project root | +| `/var/www/drupal/web` | Web docroot | +| `/var/www/drupal/web/sites/default/settings.php` | Site configuration | +| `/var/www/drupal/web/sites/default/files` | Uploaded files and media | -Open the site in a browser and follow the setup wizard: +## Security -```text -http:/// -``` +Port 80 is open on the VM's network interface. UFW is enabled and allows SSH (port 22) and HTTP +(port 80). The image serves plain HTTP only. -Choose the **Standard** profile, then enter the database name, user, and password you created above. -The installer writes `web/sites/default/settings.php` and creates the admin account. For production, -put the instance behind your own domain and enable HTTPS (for example with Certbot and the Apache -plugin). +:::caution -## Open the firewall +The site ships with `$settings['trusted_host_patterns']` set to allow any host (`^.+$`). Before +putting the site on a public domain, tighten this in +`/var/www/drupal/web/sites/default/settings.php` to match your hostname. -The instance allows only SSH (port 22) externally by default. Open HTTP and HTTPS, and add the same -ports to the instance's network/security rules in the portal: +::: -```bash -sudo ufw allow 80/tcp -sudo ufw allow 443/tcp -``` +**For production use**, put the instance behind a reverse proxy with TLS (for example Nginx or +Caddy) so the site is served over HTTPS, and update `trusted_host_patterns` accordingly. ## Next steps - [Drupal documentation](https://www.drupal.org/docs) -- [Installing Drupal](https://www.drupal.org/docs/getting-started/installing-drupal) +- [Drush documentation](https://www.drush.org/) diff --git a/src/content/docs/public-cloud/marketplace/elasticsearch.md b/src/content/docs/public-cloud/marketplace/elasticsearch.md index 7fab1f8..477d95c 100644 --- a/src/content/docs/public-cloud/marketplace/elasticsearch.md +++ b/src/content/docs/public-cloud/marketplace/elasticsearch.md @@ -1,5 +1,5 @@ --- -title: Elasticsearch 8 +title: Elasticsearch 9 --- Elasticsearch is a distributed, RESTful search and analytics engine built on Apache Lucene. It is @@ -9,7 +9,7 @@ used for full-text search, log aggregation, application monitoring, and real-tim | Component | Version | | ------------- | --------- | -| Elasticsearch | 8.x | +| Elasticsearch | 9.x | | Ubuntu | 24.04 LTS | ## Environment variables @@ -39,7 +39,7 @@ On the first boot, a setup script runs automatically. It: - Resets the `elastic` superuser password to a randomly generated value - Saves the password to `/etc/elasticsearch/elastic-password.txt` -Elasticsearch 8 takes 60–90 seconds to start before the password reset can run. Total first-boot +Elasticsearch 9 takes 60–90 seconds to start before the password reset can run. Total first-boot time is approximately 2–3 minutes. Track progress: @@ -58,7 +58,7 @@ This file contains the `elastic` superuser password. It is only readable by root ### 4. Connect to Elasticsearch -Elasticsearch 8 uses HTTPS with a self-signed certificate by default. Use `-k` to skip certificate +Elasticsearch 9 uses HTTPS with a self-signed certificate by default. Use `-k` to skip certificate verification for local connections, or use the CA certificate at `/etc/elasticsearch/certs/http_ca.crt`. @@ -130,7 +130,7 @@ curl -k -u elastic:"" https://localhost:9200 :::caution -Elasticsearch 8 enables security by default. The `elastic` user has full cluster access. Create +Elasticsearch 9 enables security by default. The `elastic` user has full cluster access. Create role-scoped users for individual applications. ::: diff --git a/src/content/docs/public-cloud/marketplace/forgejo.md b/src/content/docs/public-cloud/marketplace/forgejo.md index cd32bbd..1d6f46e 100644 --- a/src/content/docs/public-cloud/marketplace/forgejo.md +++ b/src/content/docs/public-cloud/marketplace/forgejo.md @@ -4,14 +4,20 @@ title: Forgejo Forgejo is a self-hosted Git forge, maintained as a community-driven fork of Gitea. It bundles repository hosting, pull requests, issue tracking, packages, and CI actions into a single Go binary -that runs well on modest hardware. The web UI runs on port 3000 and Git over SSH on port 22. +that runs well on modest hardware. This image ships the Forgejo LTS line, which is released every +April and supported for about 15 months. -:::note[Coming soon] +## Software included -A pre-built Forgejo image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance from -the marketplace and follow the steps below to install Forgejo yourself. +| Component | Version | +| ---------- | ------------- | +| Forgejo | 15.0.3 (LTS) | +| PostgreSQL | 18 | +| Docker | Latest stable | +| Ubuntu | 24.04 LTS | -::: +Forgejo runs with PostgreSQL as a Docker Compose stack. The web UI is served on port 3000 and Git +over SSH on port 2222, which leaves the VM's own SSH daemon on port 22. ## Requirements @@ -21,100 +27,116 @@ the marketplace and follow the steps below to install Forgejo yourself. | RAM | 1 GB | 2 GB | | Storage | 20 GB | 40 GB | -## Deploy the base instance +## Environment variables + +These values are optional during marketplace deployment. Leave a password field blank to have a +secure random value generated automatically. + +| Variable | Description | +| ------------------------ | ----------------------------------------------------------- | +| `FORGEJO_ADMIN_PASSWORD` | Password for the initial `zadmin` account | +| `FORGEJO_DB_PASSWORD` | Password for the `forgejo` PostgreSQL user | +| `FORGEJO_DOMAIN` | Public hostname used in clone URLs, defaults to the VM's IP | -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab, search for - **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from **Instances → - Create**. Either way you get a clean Ubuntu 24.04 VM. -2. Choose a plan that meets the requirements above and pick your region (YOW-1 or YUL-1). -3. When the instance is **Running**, connect over SSH: +## Getting started + +### 1. Connect to your VM ```bash ssh ubuntu@ ``` -4. Update the system: +### 2. Wait for first-boot configuration + +On the first boot, a setup script generates the database password, starts Forgejo and PostgreSQL +with Docker Compose, and creates the administrator account. This takes 1-2 minutes. Track progress: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u forgejo-first-boot.service -f ``` -## Install Forgejo +The login message (MOTD) confirms when Forgejo is ready and prints the admin credentials. + +### 3. Retrieve the admin credentials -Install Git and a couple of dependencies first: +The credentials are also written to a root-only file: ```bash -sudo apt install -y git git-lfs +sudo cat /etc/forgejo/credentials.txt ``` -Download the latest Forgejo binary and install it to `/usr/local/bin`. Check the -[Forgejo download page](https://forgejo.org/download/) for the current version and replace `15.0.3` -below if a newer release is available: +### 4. Access the web interface -```bash -wget -O forgejo \ - https://codeberg.org/forgejo/forgejo/releases/download/v15.0.3/forgejo-15.0.3-linux-amd64 -sudo cp forgejo /usr/local/bin/forgejo -sudo chmod 755 /usr/local/bin/forgejo +Open a browser and navigate to: + +```text +http://:3000 ``` -Create a dedicated `git` system user that Forgejo runs as: +Sign in as `zadmin` with the generated password. The web installer is locked, so the instance is +configured from the moment it boots. -```bash -sudo adduser --system --shell /bin/bash --gecos 'Git Version Control' \ - --group --disabled-password --home /home/git git -``` +:::note -Create the data and configuration directories: +`admin` is a reserved username in Forgejo, so the administrator account is named `zadmin`. + +::: + +### 5. Clone over SSH + +Add your public key under **Settings → SSH / GPG Keys**, then clone using port 2222: ```bash -sudo mkdir -p /var/lib/forgejo -sudo chown git:git /var/lib/forgejo && sudo chmod 750 /var/lib/forgejo -sudo mkdir /etc/forgejo -sudo chown root:git /etc/forgejo && sudo chmod 770 /etc/forgejo +git clone ssh://git@:2222//.git ``` -Install the systemd service shipped with Forgejo, then enable and start it: +## Managing Forgejo + +Forgejo and PostgreSQL run as a Docker Compose stack in `/opt/forgejo`. ```bash -sudo wget -O /etc/systemd/system/forgejo.service \ - https://codeberg.org/forgejo/forgejo/raw/branch/forgejo/contrib/systemd/forgejo.service -sudo systemctl daemon-reload -sudo systemctl enable --now forgejo -sudo systemctl status forgejo +# Check status +cd /opt/forgejo && docker compose ps + +# Restart +cd /opt/forgejo && docker compose restart + +# View logs +cd /opt/forgejo && docker compose logs -f server ``` -## Configure Forgejo +Repository data lives in `/opt/forgejo/data/forgejo` and the database in +`/opt/forgejo/data/postgres`. Configuration is generated at +`/opt/forgejo/data/forgejo/gitea/conf/app.ini`, and most settings accept overrides through +`FORGEJO__section__KEY` environment variables in the compose file. -Forgejo listens on port 3000. Open `http://:3000` in a browser to run the initial -installation wizard. Accept the default SQLite database for a small instance, or point Forgejo at -PostgreSQL/MySQL for larger deployments. +## Security -Before finishing, set the **Application URL** to your server's address and create the first -administrator account at the bottom of the form. The first registered user becomes the admin. The -wizard writes its settings to `/etc/forgejo/app.ini`, so tighten file permissions afterward: +Ports 3000 (HTTP) and 2222 (Git over SSH) are open on the VM's network interface. UFW is enabled and +allows those ports plus SSH (port 22). -```bash -sudo chmod 750 /etc/forgejo -sudo chmod 640 /etc/forgejo/app.ini -``` +Each VM generates its own `SECRET_KEY` and `INTERNAL_TOKEN` the first time Forgejo starts, so no two +deployments share encryption secrets. -For a production setup, put Forgejo behind a reverse proxy such as nginx with a TLS certificate, -then serve the UI over HTTPS instead of exposing port 3000 directly. +:::caution -## Open the firewall +Do not copy `app.ini` between VMs, and do not rotate `SECRET_KEY` after use. Doing so makes existing +two-factor secrets and stored credentials impossible to decrypt. + +::: -The instance allows only SSH (port 22) externally by default. Open the port(s) Forgejo needs and add -them to the instance's network/security rules in the portal: +**To restrict access to a specific IP:** ```bash -sudo ufw allow 3000/tcp +sudo ufw delete allow 3000/tcp +sudo ufw allow from to any port 3000 ``` -Git over SSH uses the existing port 22. To run Forgejo's built-in SSH server on a separate port -instead, open that port as well (for example `sudo ufw allow 2222/tcp`). +**For production use**, point a DNS record at the VM and front Forgejo with TLS via a reverse proxy +(Caddy, nginx, or Traefik), then set `FORGEJO_DOMAIN` so clone URLs match. ## Next steps - [Forgejo documentation](https://forgejo.org/docs/latest/) -- [Forgejo installation guide](https://forgejo.org/docs/latest/admin/installation/binary/) +- [Forgejo administration guide](https://forgejo.org/docs/latest/admin/) +- [Forgejo Actions](https://forgejo.org/docs/latest/user/actions/) diff --git a/src/content/docs/public-cloud/marketplace/ghost.md b/src/content/docs/public-cloud/marketplace/ghost.md index f79f1bb..cf1b91f 100644 --- a/src/content/docs/public-cloud/marketplace/ghost.md +++ b/src/content/docs/public-cloud/marketplace/ghost.md @@ -3,15 +3,17 @@ title: Ghost --- Ghost is an open-source publishing platform for blogs, newsletters, and membership sites. It pairs a -fast editor and built-in email delivery with a clean, theme-driven front end. The official -`ghost-cli` tool installs and manages a production deployment on Ubuntu. +fast editor and built-in email delivery with a clean, theme-driven front end. -:::note[Coming soon] +## Software included -A pre-built Ghost image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance from -the marketplace and follow the steps below to install Ghost yourself. - -::: +| Component | Version | +| --------- | --------- | +| Ghost | 6.51.0 | +| Node.js | 22.x | +| MySQL | 8.0 | +| nginx | Latest | +| Ubuntu | 24.04 LTS | ## Requirements @@ -21,106 +23,97 @@ the marketplace and follow the steps below to install Ghost yourself. | RAM | 2 GB | 4 GB | | Storage | 20 GB | 40 GB | -## Deploy the base instance +:::caution -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab. It opens on - **Featured** by default, so select **Marketplace** next to it. Pick your region (YOW-1 or YUL-1), - search for **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from - **Instances → Create**. Either way you get a clean Ubuntu 24.04 VM. +Ghost requires a domain name. It does not run against a bare IP address. Provide `GHOST_URL` at +deploy time (see below) and point that domain's DNS at the VM. - ![The Marketplace tab in the ZSoftly Cloud portal, showing the region selector, category list, search box, and Deploy buttons](../../../../assets/marketplace/deploy-marketplace-tab.webp) +::: - ![Searching the Marketplace for an app, with the search box filtering the catalog down to a matching Deploy card](../../../../assets/marketplace/deploy-marketplace-search.webp) +## Environment variables -2. Choose a plan that meets the requirements above. +You can optionally set these when deploying Ghost from the marketplace. Leave `GHOST_DB_PASSWORD` +blank to have a secure random value generated automatically. -3. When the instance is **Running**, connect over SSH: +| Variable | Description | +| ------------------- | ----------------------------------------------------- | +| `GHOST_URL` | Full site URL, for example `https://blog.example.com` | +| `GHOST_DB_PASSWORD` | Password for the MySQL `ghost` database user | -```bash -ssh ubuntu@ -``` +If `GHOST_URL` is not set, the VM serves a placeholder page and leaves Ghost unconfigured until you +provide a domain. + +## Getting started -4. Update the system: +### 1. Connect to your VM ```bash -sudo apt update && sudo apt upgrade -y +ssh ubuntu@ ``` -## Install Ghost +### 2. Wait for first-boot configuration -Ghost's official guide targets **Ubuntu 24.04 LTS**. A production install requires **nginx**, -**MySQL 8**, an LTS version of **Node.js**, and a registered **domain name**. Ghost errors out when -installed against a bare IP address. - -Install nginx and MySQL 8: +On the first boot, a setup script creates the MySQL database, configures Ghost for your `GHOST_URL`, +writes the nginx virtual host, and starts the site as a systemd service. This takes 1-2 minutes. +Track progress: ```bash -sudo apt install -y nginx mysql-server -sudo ufw allow 'Nginx Full' +journalctl -u ghost-first-boot.service -f ``` -Secure MySQL and set a **root password** (you'll supply it when `ghost install` prompts for the -database connection): +The login message (MOTD) confirms when Ghost is ready. -```bash -sudo mysql_secure_installation -``` +### 3. Finish admin setup -Install a supported Node.js LTS (Ghost supports the active LTS lines; this example uses 22): +Open the admin area in a browser and create the first administrator account: -```bash -sudo apt-get install -y ca-certificates curl gnupg -sudo mkdir -p /etc/apt/keyrings -curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key \ - | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg -echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_22.x nodistro main" \ - | sudo tee /etc/apt/sources.list.d/nodesource.list -sudo apt-get update && sudo apt-get install -y nodejs +```text +https://your-domain.com/ghost ``` -Install the Ghost CLI globally: +The generated database credentials are written to a root-only file: ```bash -sudo npm install ghost-cli@latest -g +sudo cat /etc/ghost/credentials.txt ``` -Create the install directory (owned by the `ubuntu` user) and run the installer from inside it: +### 4. Enable HTTPS + +TLS is not configured automatically, because it requires your domain's DNS to point at the VM first. +Once that resolves, provision a free Let's Encrypt certificate: ```bash -sudo mkdir -p /var/www/ghost -sudo chown ubuntu:ubuntu /var/www/ghost -sudo chmod 775 /var/www/ghost cd /var/www/ghost -ghost install +ghost setup ssl ``` -## Configure Ghost +## Managing Ghost -`ghost install` is interactive. It prompts for your site URL (use `https://your-domain.com`), -configures the MySQL database, sets up the systemd service and the nginx virtual host, and offers to -provision a free Let's Encrypt TLS certificate. Accept it for a production site. +Ghost runs as a per-site systemd service named `ghost_` (for example +`ghost_blog-example-com`). Manage it from the install directory: -When prompted for the MySQL connection, supply the root password you set above. Ghost creates its -own database and user. After install, complete admin setup at: +```bash +# Show the running instance and its service name +cd /var/www/ghost && ghost ls -```text -https://your-domain.com/ghost +# Restart, stop, and start +ghost restart +ghost stop +ghost start ``` -Manage the instance with `ghost` commands from `/var/www/ghost` (`ghost ls`, `ghost stop`, -`ghost start`, `ghost restart`). +Install directory: `/var/www/ghost`. Content (themes, images, and data) lives under +`/var/www/ghost/content`. -## Open the firewall +## Security -The instance allows only SSH (port 22) externally by default. Open the port(s) Ghost needs and add -them to the instance's network/security rules in the portal: +Ports 80 and 443 are open on the VM's network interface. UFW is enabled and allows SSH (port 22), +HTTP (80), and HTTPS (443). -```bash -sudo ufw allow 80/tcp -sudo ufw allow 443/tcp -``` +**For production use**, complete the Let's Encrypt step above so the site is served over HTTPS, and +restrict SSH access to known IP ranges. ## Next steps -- [Ghost documentation](https://docs.ghost.org/) -- [Ghost installation guide](https://docs.ghost.org/install/ubuntu) +- [Ghost documentation](https://ghost.org/docs/) +- [Configuring Ghost](https://ghost.org/docs/config/) diff --git a/src/content/docs/public-cloud/marketplace/gitlab.md b/src/content/docs/public-cloud/marketplace/gitlab.md index 2a51d03..f51383e 100644 --- a/src/content/docs/public-cloud/marketplace/gitlab.md +++ b/src/content/docs/public-cloud/marketplace/gitlab.md @@ -1,5 +1,5 @@ --- -title: GitLab CE 18.11 +title: GitLab CE 19.1 --- GitLab Community Edition is a complete DevOps platform delivered as a single application. It @@ -10,7 +10,7 @@ Everything runs on your own infrastructure. | Component | Version | | --------- | --------- | -| GitLab CE | 18.11.x | +| GitLab CE | 19.1.x | | Ubuntu | 24.04 LTS | ## Environment variables diff --git a/src/content/docs/public-cloud/marketplace/headplane.md b/src/content/docs/public-cloud/marketplace/headplane.md index 433dce6..e10dd86 100644 --- a/src/content/docs/public-cloud/marketplace/headplane.md +++ b/src/content/docs/public-cloud/marketplace/headplane.md @@ -5,14 +5,7 @@ title: Headplane Headplane is a feature-complete web UI for [Headscale](https://headscale.net), the open-source, self-hosted implementation of the Tailscale control server. It lets you manage nodes, pre-auth keys, ACLs, and DNS from a browser instead of the Headscale CLI. Headplane does not replace Headscale. It -manages a running Headscale server, so you deploy both together on this instance. - -:::note[Coming soon] - -A pre-built Headplane image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance -from the marketplace and follow the steps below to install Headplane yourself. - -::: +manages a running Headscale server, so this image ships both together. :::tip[Headscale is the server, not the client] @@ -22,6 +15,18 @@ admin UI. Run Headscale + Headplane here, then point your Tailscale clients at t ::: +## Software included + +| Component | Version | +| --------- | ------------- | +| Headplane | 0.7.0 | +| Headscale | 0.29.2 | +| Docker | Latest stable | +| Ubuntu | 24.04 LTS | + +Headplane cannot run on its own, because every action it performs is an API call to Headscale. This +image runs the Headscale control server and the Headplane UI together as a Docker Compose stack. + ## Requirements | Resource | Minimum | Recommended | @@ -30,138 +35,115 @@ admin UI. Run Headscale + Headplane here, then point your Tailscale clients at t | RAM | 1 GB | 2 GB | | Storage | 10 GB | 20 GB | -## Deploy the base instance +## Environment variables -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab. It opens on - **Featured** by default, so select **Marketplace** next to it. Pick your region (YOW-1 or YUL-1), - search for **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from - **Instances → Create**. Either way you get a clean Ubuntu 24.04 VM. +These values are optional during marketplace deployment. Leave them blank to use the VM's own +address. - ![The Marketplace tab in the ZSoftly Cloud portal, showing the region selector, category list, search box, and Deploy buttons](../../../../assets/marketplace/deploy-marketplace-tab.webp) +| Variable | Description | +| ---------------------- | ----------------------------------------------------------------------- | +| `HEADSCALE_SERVER_URL` | Public URL your devices use to reach Headscale, such as an HTTPS domain | +| `HEADPLANE_BASE_URL` | Public URL the Headplane UI is served from | - ![Searching the Marketplace for an app, with the search box filtering the catalog down to a matching Deploy card](../../../../assets/marketplace/deploy-marketplace-search.webp) +Set these when you front the VM with a DNS name or a TLS reverse proxy. `HEADSCALE_SERVER_URL` must +be an address reachable by your devices, otherwise nodes fail to register. -2. Choose a plan that meets the requirements above. +## Getting started -3. When the instance is **Running**, connect over SSH: +### 1. Connect to your VM ```bash ssh ubuntu@ ``` -4. Update the system: +### 2. Wait for first-boot configuration + +On the first boot, a setup script writes the VM address into the Headscale and Headplane configs, +generates a session secret, starts both services, creates a Headscale user named `default`, and +mints an API key. This takes 1-2 minutes. Track progress: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u headplane-first-boot.service -f ``` -## Install Headplane +The login message (MOTD) confirms when Headplane is ready and prints the API key. + +### 3. Retrieve the API key -Headplane and Headscale are distributed as Docker images and run together via Docker Compose. -Install Docker first: +The key is also written to a root-only file: ```bash -curl -fsSL https://get.docker.com | sudo sh -sudo usermod -aG docker ubuntu +sudo cat /etc/headplane/credentials.txt ``` -Log out and back in so your user picks up the `docker` group, then create a working directory: +### 4. Sign in to Headplane -```bash -mkdir -p ~/headplane && cd ~/headplane -mkdir -p config data +Open a browser and navigate to: + +```text +http://:3000/admin ``` -Create `~/headplane/compose.yaml`: - -```yaml -services: - headscale: - image: headscale/headscale:0.26.0 - container_name: headscale - restart: unless-stopped - command: serve - ports: - - '8080:8080' - volumes: - - './config/headscale.yaml:/etc/headscale/config.yaml' - - './data/headscale:/var/lib/headscale' - labels: - me.tale.headplane.target: headscale - - headplane: - image: ghcr.io/tale/headplane:latest - container_name: headplane - restart: unless-stopped - ports: - - '3000:3000' - volumes: - - './config/headplane.yaml:/etc/headplane/config.yaml' - - './config/headscale.yaml:/etc/headscale/config.yaml' - - './data/headplane:/var/lib/headplane' - - '/var/run/docker.sock:/var/run/docker.sock:ro' +Headplane authenticates against Headscale with an API key. Paste the key from the previous step into +the login form. The key expires after 90 days. Mint a new one at any time: + +```bash +docker exec headscale headscale apikeys create --expiration 90d ``` -Download a Headscale config to `config/headscale.yaml` and set `server_url` to your public URL (for -example `https://hs.example.com`). Then create `config/headplane.yaml` with the Headscale -integration and a cookie secret: - -```yaml -server: - host: '0.0.0.0' - port: 3000 - cookie_secret: '<32-character-random-string>' - cookie_secure: false - -headscale: - url: 'http://headscale:8080' - config_path: '/etc/headscale/config.yaml' - config_strict: true - -integration: - docker: - enabled: true - container_name: 'headscale' - socket: 'unix:///var/run/docker.sock' +### 5. Join a device + +Point any Tailscale client at your Headscale server: + +```bash +tailscale up --login-server http://:8080 ``` -Generate a cookie secret with `openssl rand -hex 16` and paste it into `cookie_secret`. Start the -stack: +Approve the node from the Headplane UI, or list nodes from the CLI: ```bash -docker compose up -d +docker exec headscale headscale nodes list ``` -## Configure Headplane +## Managing Headplane + +Headscale and Headplane run as a Docker Compose stack in `/opt/headplane`. + +```bash +# Check status +cd /opt/headplane && docker compose ps + +# Restart +cd /opt/headplane && docker compose restart + +# View logs +cd /opt/headplane && docker compose logs -f headscale +``` -1. Open Headplane in your browser at `http://:3000`. -2. Headplane authenticates to Headscale with an API key. Generate one inside the Headscale container - and use it (or paste it into the UI when prompted): +Headscale's configuration is at `/opt/headplane/headscale/config/config.yaml` and its database under +`/opt/headplane/headscale/data`. ACL policies are stored in the database and remain editable from +the Headplane UI. - ```bash - docker exec headscale headscale apikeys create - ``` +## Security -3. For single sign-on, add an `oidc` block to `config/headplane.yaml` with your provider's `issuer`, - `client_id`, and `client_secret`, then restart with `docker compose restart headplane`. -4. Put a reverse proxy (Caddy, Nginx, or Traefik) in front to terminate TLS and serve both the - Headscale `server_url` and the Headplane UI over HTTPS. Set `cookie_secure: true` once HTTPS is - in place. TLS is required for production tailnets. +Ports 3000 (Headplane UI) and 8080 (Headscale) are open on the VM's network interface. UFW is +enabled and allows those ports plus SSH (port 22). -## Open the firewall +Your devices must reach Headscale on port 8080, but the Headplane UI does not need to be public. -The instance allows only SSH (port 22) externally by default. Open the ports Headplane and Headscale -need and add them to the instance's network/security rules in the portal: +**To restrict the UI to a specific IP:** ```bash -sudo ufw allow 3000/tcp -sudo ufw allow 8080/tcp +sudo ufw delete allow 3000/tcp +sudo ufw allow from to any port 3000 ``` -Port 3000 serves the Headplane UI and 8080 is the Headscale control server. If you front them with a -reverse proxy, expose 80/443 instead and keep these internal. +**For production use**, point a DNS record at the VM and terminate TLS with a reverse proxy (Caddy, +nginx, or Traefik). Set `HEADSCALE_SERVER_URL` and `HEADPLANE_BASE_URL` to the HTTPS URLs, and set +`cookie_secure: true` in `/opt/headplane/headplane/config.yaml`. ## Next steps - [Headplane documentation](https://headplane.net) -- [Headplane installation guide](https://github.com/tale/headplane) +- [Headscale documentation](https://headscale.net) +- [Headscale ACL policies](https://headscale.net/stable/ref/acls/) diff --git a/src/content/docs/public-cloud/marketplace/index.md b/src/content/docs/public-cloud/marketplace/index.md index 85957e4..e2dc1b1 100644 --- a/src/content/docs/public-cloud/marketplace/index.md +++ b/src/content/docs/public-cloud/marketplace/index.md @@ -9,11 +9,11 @@ automatically. Credentials are generated, services are configured, and the image
- 20 + 35 live images
- 45 + 29 coming soon
@@ -80,7 +80,7 @@ automatically. Credentials are generated, services are configured, and the image
-

GitLab CE 18.11

+

GitLab CE 19.1

Self-hosted DevOps platform with Git, CI/CD, and issue tracking

 @@ -110,7 +110,7 @@ automatically. Credentials are generated, services are configured, and the image
-

PostgreSQL 17

+

PostgreSQL

Advanced open-source relational database with rich extensibility

@@ -120,7 +120,7 @@ automatically. Credentials are generated, services are configured, and the image
-

MariaDB 11.4

+

MariaDB 11.8

Open-source relational database and drop-in MySQL replacement

@@ -199,7 +199,7 @@ automatically. Credentials are generated, services are configured, and the image

CMS

-
+
@@ -211,6 +211,26 @@ automatically. Credentials are generated, services are configured, and the image
+ +
+ +
+
+

Drupal

+

Flexible open-source CMS for content-heavy sites and applications.

+
+ + + +
+ +
+
+

Ghost

+

Publishing platform for newsletters, blogs, and memberships.

+
+ +
@@ -248,11 +268,51 @@ automatically. Credentials are generated, services are configured, and the image
-

GitLab CE 18.11

+

GitLab CE 19.1

Self-hosted DevOps platform with Git, CI/CD, and issue tracking in one application

+ +
+ +
+
+

Jenkins

+

Automation server for building, testing, and deploying.

+
+ + + +
+ +
+
+

Forgejo

+

Lightweight self-hosted Git forge (Gitea fork).

+
+ + + +
+ +
+
+

Portainer

+

Web UI to manage Docker, Swarm, and Kubernetes.

+
+ + + +
+ +
+
+

Coolify

+

Self-hosted PaaS for deploying apps, databases, and services.

+
+ +
@@ -270,7 +330,7 @@ automatically. Credentials are generated, services are configured, and the image
-

MariaDB 11.4

+

MariaDB 11.8

Open-source relational database and drop-in MySQL replacement

@@ -280,7 +340,7 @@ automatically. Credentials are generated, services are configured, and the image
-

PostgreSQL 17

+

PostgreSQL

Advanced open-source relational database with rich extensibility

@@ -290,7 +350,7 @@ automatically. Credentials are generated, services are configured, and the image
-

MySQL 8.4

+

MySQL

World's most widely deployed open-source relational database

@@ -300,7 +360,7 @@ automatically. Credentials are generated, services are configured, and the image
-

Valkey 9.0

+

Valkey 9.1

High-performance in-memory data store, Redis-compatible

@@ -310,7 +370,7 @@ automatically. Credentials are generated, services are configured, and the image
-

Elasticsearch 8

+

Elasticsearch 9

Distributed search and analytics engine built on Apache Lucene

@@ -335,6 +395,16 @@ automatically. Credentials are generated, services are configured, and the image + +
+ +
+
+

Supabase

+

Open-source Firebase alternative built on PostgreSQL.

+
+ + @@ -390,6 +460,56 @@ automatically. Credentials are generated, services are configured, and the image + +
+ +
+
+

Headplane

+

Web UI to manage your self-hosted Headscale network.

+
+ + + +
+ +
+
+

Keycloak

+

Open-source identity and access management with SSO.

+
+ + + +
+ +
+
+

Authentik

+

Flexible identity provider for SSO, OAuth, and SAML.

+
+ + + +
+ +
+
+

Vaultwarden

+

Lightweight self-hosted Bitwarden-compatible password manager.

+
+ + + +
+ +
+
+

OpenBao

+

Open-source secrets management and data encryption.

+
+ + @@ -400,7 +520,7 @@ automatically. Credentials are generated, services are configured, and the image

Monitoring

-
+
@@ -412,6 +532,26 @@ automatically. Credentials are generated, services are configured, and the image
+ +
+ +
+
+

Prometheus

+

Metrics collection and alerting toolkit for infrastructure.

+
+ + + +
+ +
+
+

Zabbix

+

Enterprise-grade infrastructure and application monitoring.

+
+ +
@@ -422,7 +562,7 @@ automatically. Credentials are generated, services are configured, and the image

AI & Agents

-
+
@@ -434,24 +574,12 @@ automatically. Credentials are generated, services are configured, and the image
-
-
- -
-
-
- -
-

Coming soon

-
-
-
-

Ollama Coming soon

+

Ollama

Run local LLMs on your VM and serve models through the Ollama API.

 @@ -461,11 +589,23 @@ automatically. Credentials are generated, services are configured, and the image
-

Dify Coming soon

+

Dify

Build LLM apps and AI agents with workflows, RAG, and model providers.

+
+ + +
+
+
+ +
+

Coming soon

+
+
+
@@ -546,16 +686,6 @@ automatically. Credentials are generated, services are configured, and the image
- -
- -
-
-

Ghost Coming soon

-

Publishing platform for newsletters, blogs, and memberships.

-
- -
@@ -586,46 +716,6 @@ automatically. Credentials are generated, services are configured, and the image
- -
- -
-
-

Prometheus Coming soon

-

Metrics collection and alerting toolkit for infrastructure.

-
- - - -
- -
-
-

Coolify Coming soon

-

Self-hosted PaaS for deploying apps, databases, and services.

-
- - - -
- -
-
-

Vaultwarden Coming soon

-

Lightweight self-hosted Bitwarden-compatible password manager.

-
- - - -
- -
-
-

Headplane Coming soon

-

Web UI to manage your self-hosted Headscale network.

-
- -
@@ -636,26 +726,6 @@ automatically. Credentials are generated, services are configured, and the image
- -
- -
-
-

Zabbix Coming soon

-

Enterprise-grade infrastructure and application monitoring.

-
- - - -
- -
-
-

OpenBao Coming soon

-

Open-source secrets management and data encryption.

-
- -
@@ -732,37 +802,7 @@ automatically. Credentials are generated, services are configured, and the image

SeaweedFS Coming soon

-

Fast distributed file and object storage system.

-
- - - -
- -
-
-

Jenkins Coming soon

-

Automation server for building, testing, and deploying.

-
- - - -
- -
-
-

Keycloak Coming soon

-

Open-source identity and access management with SSO.

-
- - - -
- -
-
-

Authentik Coming soon

-

Flexible identity provider for SSO, OAuth, and SAML.

+

Fast distributed file store with S3-compatible object storage.

 @@ -776,16 +816,6 @@ automatically. Credentials are generated, services are configured, and the image
- -
- -
-
-

Portainer Coming soon

-

Web UI to manage Docker, Swarm, and Kubernetes.

-
- -
@@ -806,16 +836,6 @@ automatically. Credentials are generated, services are configured, and the image
- -
- -
-
-

Forgejo Coming soon

-

Lightweight self-hosted Git forge (Gitea fork).

-
- -
@@ -826,16 +846,6 @@ automatically. Credentials are generated, services are configured, and the image
- -
- -
-
-

Supabase Coming soon

-

Open-source Firebase alternative built on PostgreSQL.

-
- -
@@ -886,15 +896,5 @@ automatically. Credentials are generated, services are configured, and the image
- -
- -
-
-

Drupal Coming soon

-

Flexible open-source CMS for content-heavy sites and applications.

-
- -
diff --git a/src/content/docs/public-cloud/marketplace/jenkins.md b/src/content/docs/public-cloud/marketplace/jenkins.md index 7a45f94..42b0a93 100644 --- a/src/content/docs/public-cloud/marketplace/jenkins.md +++ b/src/content/docs/public-cloud/marketplace/jenkins.md @@ -6,12 +6,13 @@ Jenkins is an open-source automation server for building, testing, and deploying pipeline-as-code model and large plugin ecosystem let you wire up continuous integration and continuous delivery for almost any toolchain. The web UI runs on port 8080. -:::note[Coming soon] +## Software included -A pre-built Jenkins image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance from -the marketplace and follow the steps below to install Jenkins yourself. - -::: +| Component | Version | +| --------- | ------------- | +| Jenkins | 2.555.3 (LTS) | +| OpenJDK | 21 (JRE) | +| Ubuntu | 24.04 LTS | ## Requirements @@ -21,80 +22,93 @@ the marketplace and follow the steps below to install Jenkins yourself. | RAM | 2 GB | 4 GB | | Storage | 20 GB | 50 GB | -## Deploy the base instance +## Environment variables -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab, search for - **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from **Instances → - Create**. Either way you get a clean Ubuntu 24.04 VM. -2. Choose a plan that meets the requirements above and pick your region (YOW-1 or YUL-1). -3. When the instance is **Running**, connect over SSH: +This image takes no deploy-time variables. It creates no shared administrator account. Jenkins +generates a unique unlock password on every VM. Read it after first boot, then create your own +administrator in the setup wizard: ```bash -ssh ubuntu@ +sudo cat /var/lib/jenkins/secrets/initialAdminPassword ``` -4. Update the system: +## Getting started + +### 1. Connect to your VM ```bash -sudo apt update && sudo apt upgrade -y +ssh ubuntu@ ``` -## Install Jenkins +### 2. Wait for first-boot configuration -Jenkins runs on the JVM. Install a supported OpenJDK (17 or 21) first: +On the first boot, a setup script starts Jenkins, which generates a unique initial admin password +for this instance. This can take a few minutes on the first start. Track progress: ```bash -sudo apt install -y fontconfig openjdk-21-jre -java -version +journalctl -u jenkins-first-boot.service -f ``` -Add the Jenkins LTS apt repository signing key and source list: +The login message (MOTD) confirms when Jenkins is ready. -```bash -sudo wget -O /etc/apt/keyrings/jenkins-keyring.asc \ - https://pkg.jenkins.io/debian-stable/jenkins.io-2023.key +### 3. Retrieve the initial admin password -echo "deb [signed-by=/etc/apt/keyrings/jenkins-keyring.asc] https://pkg.jenkins.io/debian-stable binary/" \ - | sudo tee /etc/apt/sources.list.d/jenkins.list > /dev/null +```bash +sudo cat /var/lib/jenkins/secrets/initialAdminPassword ``` -Install Jenkins: +### 4. Complete the setup wizard -```bash -sudo apt update -sudo apt install -y jenkins +Open a browser and navigate to: + +```text +http://:8080 ``` -The package installs a systemd service that starts on boot. Confirm it is running: +Paste the initial admin password, install the suggested plugins, and create your first administrator +account. + +## Managing Jenkins + +Jenkins runs as a systemd service. ```bash -sudo systemctl enable --now jenkins -sudo systemctl status jenkins +# Check status +systemctl status jenkins + +# Restart +sudo systemctl restart jenkins + +# View logs +sudo journalctl -u jenkins -f ``` -## Configure Jenkins +Jenkins home (jobs, plugins, and configuration): `/var/lib/jenkins`. -Jenkins listens on port 8080. Open `http://:8080` in a browser to start the setup -wizard. The wizard first asks for the auto-generated setup password. Print it from the server: +## Security -```bash -sudo cat /var/lib/jenkins/secrets/initialAdminPassword -``` +Port 8080 is open on the VM's network interface. UFW is enabled and allows SSH (port 22) and Jenkins +(port 8080). No build-agent port (50000) is opened by default. -Paste the value, install the suggested plugins, and create your first administrator account. For a -production setup, put Jenkins behind a reverse proxy such as nginx with a TLS certificate, then -serve the UI over HTTPS instead of exposing port 8080 directly. +**To restrict the UI to a specific IP:** -## Open the firewall +```bash +sudo ufw delete allow 8080/tcp +sudo ufw allow from to any port 8080 +``` -The instance allows only SSH (port 22) externally by default. Open the port(s) Jenkins needs and add -them to the instance's network/security rules in the portal: +**To reach the UI without opening the firewall, use an SSH tunnel:** ```bash -sudo ufw allow 8080/tcp +# Run this on your local machine +ssh -L 8080:localhost:8080 ubuntu@ ``` +**For production use**, place Jenkins behind a reverse proxy such as nginx with a TLS certificate +and serve the UI over HTTPS instead of exposing port 8080 directly. + ## Next steps - [Jenkins documentation](https://www.jenkins.io/doc/) -- [Jenkins installation guide](https://www.jenkins.io/doc/book/installing/linux/) +- [Managing plugins](https://www.jenkins.io/doc/book/managing/plugins/) +- [Pipeline reference](https://www.jenkins.io/doc/book/pipeline/) diff --git a/src/content/docs/public-cloud/marketplace/keycloak.md b/src/content/docs/public-cloud/marketplace/keycloak.md index 5ef5e09..dc1d425 100644 --- a/src/content/docs/public-cloud/marketplace/keycloak.md +++ b/src/content/docs/public-cloud/marketplace/keycloak.md @@ -4,15 +4,18 @@ title: Keycloak Keycloak is an open-source identity and access management platform. It provides single sign-on (SSO), user federation, social and identity-broker login, and fine-grained authorization through -standard protocols such as OpenID Connect, OAuth 2.0, and SAML. This guide runs the official -Keycloak container, with notes for both a quick development start and a production setup. +standard protocols such as OpenID Connect, OAuth 2.0, and SAML. -:::note[Coming soon] +## Software included -A pre-built Keycloak image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance from -the marketplace and follow the steps below to install Keycloak yourself. +| Component | Version | +| ---------- | ------------- | +| Keycloak | 26.6.4 | +| PostgreSQL | 18 | +| Docker | Latest stable | +| Ubuntu | 24.04 LTS | -::: +Keycloak runs in production mode (`start`) with a PostgreSQL database, as a Docker Compose stack. ## Requirements @@ -22,129 +25,102 @@ the marketplace and follow the steps below to install Keycloak yourself. | RAM | 2 GB | 4 GB | | Storage | 20 GB | 40 GB | -## Deploy the base instance +## Environment variables + +You can optionally set these when deploying Keycloak from the marketplace. Leave a password field +blank to have a secure random value generated automatically. + +| Variable | Description | +| ------------------------- | ------------------------------------------------------------------------------ | +| `KEYCLOAK_ADMIN` | Username for the initial admin account. Defaults to `admin` | +| `KEYCLOAK_ADMIN_PASSWORD` | Password for the initial admin account | +| `KC_HOSTNAME` | Public hostname or IP Keycloak is served from. Defaults to the VM's private IP | -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab, search for - **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from **Instances → - Create**. Either way you get a clean Ubuntu 24.04 VM. -2. Choose a plan that meets the requirements above and pick your region (YOW-1 or YUL-1). -3. When the instance is **Running**, connect over SSH: +## Getting started + +### 1. Connect to your VM ```bash ssh ubuntu@ ``` -4. Update the system: +### 2. Wait for first-boot configuration + +On the first boot, a setup script generates the admin and database passwords, writes the environment +file, and starts the stack with Docker Compose. This takes 1-2 minutes. Track progress: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u keycloak-first-boot.service -f ``` -## Install Keycloak +The login message (MOTD) confirms when Keycloak is ready and prints the admin credentials. -Keycloak is distributed as an official Docker image from `quay.io`, so install Docker Engine first. +### 3. Retrieve the admin credentials -Set up Docker's official APT repository for Ubuntu 24.04 LTS (`noble`): +The credentials are also written to a root-only file: ```bash -sudo apt install -y ca-certificates curl -sudo install -m 0755 -d /etc/apt/keyrings -sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc -sudo chmod a+r /etc/apt/keyrings/docker.asc -sudo tee /etc/apt/sources.list.d/docker.sources >/dev/null <:8080 ``` -To try Keycloak quickly, start it in development mode. This bootstraps an initial admin user and -serves the console on port 8080: +Sign in with the `admin` user and the generated password. -```bash -sudo docker run -d --name keycloak --restart unless-stopped \ - -p 8080:8080 \ - -e KEYCLOAK_ADMIN=admin \ - -e KEYCLOAK_ADMIN_PASSWORD='' \ - quay.io/keycloak/keycloak:latest start-dev -``` +| Field | Value | +| -------- | ------------------------------------ | +| Username | `admin` | +| Password | From `/etc/keycloak/credentials.txt` | -Open `http://:8080` and sign in to the admin console with the credentials above. - -## Configure Keycloak - -Development mode uses an in-memory database and insecure defaults, so it is not suitable for -production. For a production deployment, run Keycloak with the `start` command, an external -database, HTTPS on port 8443, and an explicit hostname. - -The example below uses Docker Compose with PostgreSQL. Create `docker-compose.yml`: - -```yaml -services: - postgres: - image: postgres:16 - restart: unless-stopped - environment: - POSTGRES_DB: keycloak - POSTGRES_USER: keycloak - POSTGRES_PASSWORD: - volumes: - - postgres_data:/var/lib/postgresql/data - - keycloak: - image: quay.io/keycloak/keycloak:latest - restart: unless-stopped - command: start - environment: - KEYCLOAK_ADMIN: admin - KEYCLOAK_ADMIN_PASSWORD: - KC_DB: postgres - KC_DB_URL: jdbc:postgresql://postgres:5432/keycloak - KC_DB_USERNAME: keycloak - KC_DB_PASSWORD: - KC_HOSTNAME: auth.example.com - KC_PROXY_HEADERS: xforwarded - KC_HTTP_ENABLED: 'true' - ports: - - '8080:8080' - depends_on: - - postgres - -volumes: - postgres_data: -``` +## Managing Keycloak -Start the stack: +Keycloak runs as a Docker Compose stack in `/opt/keycloak`. ```bash -sudo docker compose up -d +# Check status +cd /opt/keycloak && docker compose ps + +# Restart +cd /opt/keycloak && docker compose restart + +# View logs +cd /opt/keycloak && docker compose logs -f ``` -Point `auth.example.com` at the VM and place Keycloak behind a reverse proxy (Caddy, nginx, or -Traefik) that terminates TLS on 443 and forwards to host port 8080. +Environment configuration: `/opt/keycloak/.env`. PostgreSQL data is stored under +`/opt/keycloak/data/postgres` and is not exposed outside the Docker network. + +## Security + +Port 8080 is open on the VM's network interface. UFW is enabled and allows SSH (port 22) and +Keycloak (port 8080). Keycloak serves plain HTTP on 8080. -## Open the firewall +:::caution -The instance allows only SSH (port 22) externally by default. Open the port Keycloak serves and add -it to the instance's network/security rules in the portal: +`KC_HOSTNAME` defaults to the VM's private IP. If you later attach a public IP, DNS name, or reverse +proxy, set `KC_HOSTNAME` at deploy time (or edit `/opt/keycloak/.env` and run +`cd /opt/keycloak && docker compose up -d`), otherwise production-mode hostname checks can reject +requests from the new address. + +::: + +**For production use**, front Keycloak with a reverse proxy (Caddy, nginx, or Traefik) that +terminates TLS on port 443 and forwards to port 8080, and set `KC_PROXY_HEADERS=xforwarded` in +`/opt/keycloak/.env`. Restrict direct access to port 8080: ```bash -sudo ufw allow 8080/tcp +sudo ufw delete allow 8080/tcp +sudo ufw allow from to any port 8080 ``` -If you front Keycloak with a reverse proxy, open 443 instead and keep 8080 internal. - ## Next steps - [Keycloak documentation](https://www.keycloak.org/documentation) -- [Keycloak installation guide](https://www.keycloak.org/getting-started/getting-started-docker) +- [Configuring the hostname](https://www.keycloak.org/server/hostname) +- [Reverse proxy setup](https://www.keycloak.org/server/reverseproxy) diff --git a/src/content/docs/public-cloud/marketplace/lamp.md b/src/content/docs/public-cloud/marketplace/lamp.md index c858691..527bc61 100644 --- a/src/content/docs/public-cloud/marketplace/lamp.md +++ b/src/content/docs/public-cloud/marketplace/lamp.md @@ -12,21 +12,20 @@ to work together, ready for you to deploy your application. | -------------- | ------------------------------------------------------ | | Apache | 2.4.x | | MariaDB | Latest stable | -| PHP | 8.3 | +| PHP | 8.4 | | PHP extensions | cli, mysql, curl, gd, mbstring, xml, zip, bcmath, intl | | Ubuntu | 24.04 LTS | ## Environment variables -You can optionally set these when deploying LAMP from the marketplace. Leave any field blank to have -a secure random value generated automatically. +This image takes no deploy-time variables. MariaDB is installed with socket authentication for +`root`, and no application database is created. Create one after first boot: -| Variable | Description | -| --------------------- | ------------------------------------------ | -| `MYSQL_ROOT_PASSWORD` | Database root password | -| `MYSQL_DATABASE` | Name of the application database to create | -| `MYSQL_USER` | Application database username | -| `MYSQL_PASSWORD` | Application database user password | +```bash +sudo mariadb -e "CREATE DATABASE app;" +sudo mariadb -e "CREATE USER 'app'@'localhost' IDENTIFIED BY '';" +sudo mariadb -e "GRANT ALL PRIVILEGES ON app.* TO 'app'@'localhost';" +``` ## Getting started @@ -103,7 +102,7 @@ Key directories and files: | ------------------------------- | ---------------------------- | | `/var/www/html/` | Default web root | | `/etc/apache2/sites-available/` | Apache virtual hosts | -| `/etc/php/8.3/apache2/php.ini` | PHP configuration for Apache | +| `/etc/php/8.4/apache2/php.ini` | PHP configuration for Apache | | `/etc/mysql/mariadb.conf.d/` | MariaDB configuration | **To create a virtual host** for a domain, add a configuration file to diff --git a/src/content/docs/public-cloud/marketplace/lemp.md b/src/content/docs/public-cloud/marketplace/lemp.md index fb785bd..a6b15b4 100644 --- a/src/content/docs/public-cloud/marketplace/lemp.md +++ b/src/content/docs/public-cloud/marketplace/lemp.md @@ -13,7 +13,7 @@ management. | -------------- | ------------- | | Nginx | Latest stable | | MariaDB | Latest stable | -| PHP-FPM | 8.3 | +| PHP-FPM | 8.4 | | Docker | Latest stable | | Docker Compose | Latest stable | | Ubuntu | 24.04 LTS | diff --git a/src/content/docs/public-cloud/marketplace/mariadb.md b/src/content/docs/public-cloud/marketplace/mariadb.md index ac8afb8..51694af 100644 --- a/src/content/docs/public-cloud/marketplace/mariadb.md +++ b/src/content/docs/public-cloud/marketplace/mariadb.md @@ -1,5 +1,5 @@ --- -title: MariaDB 11.4 +title: MariaDB 11.8 --- MariaDB is an open-source relational database management system and a drop-in replacement for MySQL. @@ -10,7 +10,7 @@ storage. | Component | Version | | -------------- | ------------ | -| MariaDB Server | 11.4.x (LTS) | +| MariaDB Server | 11.8.x (LTS) | | Ubuntu | 24.04 LTS | ## Environment variables diff --git a/src/content/docs/public-cloud/marketplace/mysql.md b/src/content/docs/public-cloud/marketplace/mysql.md index ad5e3f9..28601b6 100644 --- a/src/content/docs/public-cloud/marketplace/mysql.md +++ b/src/content/docs/public-cloud/marketplace/mysql.md @@ -1,16 +1,19 @@ --- -title: MySQL 8.4 +title: MySQL --- MySQL is one of the most widely deployed open-source relational databases in the world. This image -ships MySQL 8.4 LTS, a long-term support release intended for production workloads. +ships a long-term support release intended for production workloads. + +MySQL is published as one image per maintained LTS line. Pick the version you need when you deploy. +Both 8.4 and 9.7 are current LTS lines, and 9.7 is the forward path off 8.4. ## Software included -| Component | Version | -| ------------ | ----------- | -| MySQL Server | 8.4.x (LTS) | -| Ubuntu | 24.04 LTS | +| Component | Version | +| ------------ | ---------------------------------- | +| MySQL Server | 8.4.x or 9.7.x (LTS, per template) | +| Ubuntu | 24.04 LTS | ## Environment variables @@ -105,5 +108,6 @@ Avoid exposing port 3306 to `0.0.0.0`. Restrict access to known IPs or use an SS ## Next steps +- [MySQL 9.7 documentation](https://dev.mysql.com/doc/refman/9.7/en/) - [MySQL 8.4 documentation](https://dev.mysql.com/doc/refman/8.4/en/) -- [MySQL security guide](https://dev.mysql.com/doc/refman/8.4/en/security.html) +- [MySQL security guide](https://dev.mysql.com/doc/refman/9.7/en/security.html) diff --git a/src/content/docs/public-cloud/marketplace/n8n.md b/src/content/docs/public-cloud/marketplace/n8n.md index 8485105..43f27a5 100644 --- a/src/content/docs/public-cloud/marketplace/n8n.md +++ b/src/content/docs/public-cloud/marketplace/n8n.md @@ -10,7 +10,7 @@ logic inside workflows. | Component | Version | | -------------- | ------------- | -| n8n | 1.121.0 | +| n8n | 2.29.8 | | Docker | Latest stable | | Docker Compose | Latest stable | | Ubuntu | 24.04 LTS | diff --git a/src/content/docs/public-cloud/marketplace/netbird.md b/src/content/docs/public-cloud/marketplace/netbird.md index 492687c..0079f46 100644 --- a/src/content/docs/public-cloud/marketplace/netbird.md +++ b/src/content/docs/public-cloud/marketplace/netbird.md @@ -11,7 +11,7 @@ ready to join your network. | Component | Version | | --------- | --------- | -| NetBird | 0.71.4 | +| NetBird | 0.74.3 | | Ubuntu | 24.04 LTS | ## Environment variables @@ -20,9 +20,10 @@ You can optionally provide a NetBird setup key when deploying from the marketpla joins your NetBird network automatically at first boot; if left blank, connect manually with `netbird up` after deploy. -| Variable | Description | -| -------------- | ---------------------------------------------------- | -| `NB_SETUP_KEY` | NetBird setup key used to join your network on boot. | +| Variable | Description | +| ------------------- | -------------------------------------------------------------- | +| `NB_SETUP_KEY` | NetBird setup key used to join your network on boot. | +| `NB_MANAGEMENT_URL` | Self-hosted NetBird management server. Omit for NetBird cloud. | ## Getting started diff --git a/src/content/docs/public-cloud/marketplace/ollama.md b/src/content/docs/public-cloud/marketplace/ollama.md index 8cc523e..8e211d6 100644 --- a/src/content/docs/public-cloud/marketplace/ollama.md +++ b/src/content/docs/public-cloud/marketplace/ollama.md @@ -7,12 +7,15 @@ such as Llama, Qwen, Gemma, and DeepSeek on your own hardware. It exposes a simp command-line interface, so you can run inference privately without sending data to a third-party provider. -:::note[Coming soon] +## Software included -A pre-built Ollama image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance from -the marketplace and follow the steps below to install Ollama yourself. +| Component | Version | +| --------- | --------- | +| Ollama | 0.31.2 | +| Ubuntu | 24.04 LTS | -::: +No models are pre-loaded. You pull the models you need on first boot (see +[Getting started](#getting-started)). ## Requirements @@ -51,64 +54,43 @@ enough RAM, and their root disk holds the model files. See Adjust from there: -- **Same RAM, lower cost**: the memory-optimized family gives the same RAM with fewer vCPUs, good - for occasional use. Use `cim1.*` in YOW-1 or `cam2.*` in YUL-1 (for example `cim1.xl` or `cam2.xl` - for 64 GB). -- **Faster responses**: add vCPUs with the cpu-optimized family (`cac1.*` in YOW-1, `cac2.*` in +- **Same RAM, lower cost**: the memory-focused family gives the same RAM with fewer vCPUs, good for + occasional use. Use `cim1.*` in YOW-1 or `cam2.*` in YUL-1 (for example `cim1.xl` or `cam2.xl` for + 64 GB). +- **Faster responses**: add vCPUs with the CPU-focused family (`cac1.*` in YOW-1, `cac2.*` in YUL-1), or choose a GPU plan for 13B and larger models. - **Several large models on one instance**: attach a [block storage volume](/public-cloud/compute/settings/block-storage/) instead of moving to a bigger plan. -## Deploy the base instance +## Getting started -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab. It opens on - **Featured** by default, so select **Marketplace** next to it. Pick your region (YOW-1 or YUL-1), - search for **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from - **Instances → Create**. Either way you get a clean Ubuntu 24.04 VM. - - ![The Marketplace tab in the ZSoftly Cloud portal, showing the region selector, category list, search box, and Deploy buttons](../../../../assets/marketplace/deploy-marketplace-tab.webp) - - ![Searching the Marketplace for an app, with the search box filtering the catalog down to a matching Deploy card](../../../../assets/marketplace/deploy-marketplace-search.webp) - -2. Choose a plan that meets the requirements above. - -3. When the instance is **Running**, connect over SSH: +### 1. Connect to your VM ```bash ssh ubuntu@ ``` -4. Update the system: - -```bash -sudo apt update && sudo apt upgrade -y -``` - -## Install Ollama +### 2. Wait for first-boot configuration -Run the official install script. It installs the `ollama` binary, creates a dedicated `ollama` -system user, and sets up a systemd service that starts automatically: +On the first boot, a setup script starts the service. This takes under a minute. Track progress: ```bash -curl -fsSL https://ollama.com/install.sh | sh +journalctl -u ollama-first-boot.service -f ``` -Confirm the service is running and check the version: - -```bash -systemctl status ollama --no-pager -ollama --version -``` +The login message (MOTD) confirms when Ollama is ready. -Pull a model and run a quick prompt: +### 3. Pull a model and run a prompt ```bash ollama pull llama3.2 ollama run llama3.2 "Hello, what can you do?" ``` -The API listens on `127.0.0.1:11434` by default. Test it locally: +### 4. Use the API + +The API listens on port `11434`. Test it from the VM: ```bash curl http://localhost:11434/api/generate -d '{ @@ -118,42 +100,54 @@ curl http://localhost:11434/api/generate -d '{ }' ``` -## Configure Ollama +From another host, replace `localhost` with the VM's IP. -By default Ollama binds only to localhost. To accept connections from other hosts, set `OLLAMA_HOST` -on the systemd service: +## Managing Ollama + +Ollama runs as a systemd service. ```bash -sudo systemctl edit ollama -``` +# Check status +systemctl status ollama + +# Restart +sudo systemctl restart ollama -Add the following override, then save: +# View logs +sudo journalctl -u ollama -f -```ini -[Service] -Environment="OLLAMA_HOST=0.0.0.0:11434" +# List, pull, and remove models +ollama list +ollama pull qwen2.5 +ollama rm qwen2.5 ``` -Reload and restart: +Models are stored in `/usr/share/ollama/.ollama/models`. A summary of URLs and commands is written +to `/etc/ollama/info.txt`. -```bash -sudo systemctl daemon-reload -sudo systemctl restart ollama -``` +## Security -Ollama has no built-in authentication. If you expose port 11434, place it behind a reverse proxy -that enforces TLS and authentication, or restrict access to trusted IPs only. +Port 11434 is open on the VM's network interface, and Ollama has **no built-in authentication**. UFW +is enabled and allows SSH (port 22) and the Ollama API (port 11434). -## Open the firewall +**To restrict the API to a specific IP:** -The instance allows only SSH (port 22) externally by default. Open the port Ollama needs and add it -to the instance's network/security rules in the portal: +```bash +sudo ufw delete allow 11434/tcp +sudo ufw allow from to any port 11434 +``` + +**To reach the API without opening the firewall, use an SSH tunnel:** ```bash -sudo ufw allow 11434/tcp +# Run this on your local machine +ssh -L 11434:localhost:11434 ubuntu@ ``` +**For production use**, place Ollama behind a reverse proxy that enforces TLS and authentication, or +restrict access to trusted IPs only. + ## Next steps - [Ollama documentation](https://docs.ollama.com/) -- [Ollama installation guide](https://docs.ollama.com/linux) +- [Ollama API reference](https://docs.ollama.com/api) diff --git a/src/content/docs/public-cloud/marketplace/openbao.md b/src/content/docs/public-cloud/marketplace/openbao.md index 7fe91ec..ab30df9 100644 --- a/src/content/docs/public-cloud/marketplace/openbao.md +++ b/src/content/docs/public-cloud/marketplace/openbao.md @@ -7,10 +7,20 @@ tokens, passwords, certificates, and encryption keys. It is the Linux Foundation HashiCorp Vault and remains API-compatible with it, so most Vault tooling works unchanged. You run it as a server, initialise it once, and unseal it to start serving secrets. -:::note[Coming soon] +## Software included -A pre-built OpenBao image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance from -the marketplace and follow the steps below to install OpenBao yourself. +| Component | Version | +| --------- | --------- | +| OpenBao | 2.5.5 | +| Ubuntu | 24.04 LTS | + +OpenBao runs as a systemd service with integrated Raft storage. Each VM generates its own TLS +certificate on first boot, so no private key is shared between deployments. + +:::caution + +This image deploys a single node. A one-node Raft cluster has no failover. For high availability, +provision more instances from this template and join them as Raft peers. ::: @@ -22,120 +32,109 @@ the marketplace and follow the steps below to install OpenBao yourself. | RAM | 1 GB | 2 GB | | Storage | 10 GB | 20 GB | -## Deploy the base instance +## Environment variables -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab, search for - **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from **Instances → - Create**. Either way you get a clean Ubuntu 24.04 VM. -2. Choose a plan that meets the requirements above and pick your region (YOW-1 or YUL-1). -3. When the instance is **Running**, connect over SSH: +You can optionally set these when deploying OpenBao from the marketplace. Leave them blank to use +the VM's own address and receive the generated secrets in plain text. -```bash -ssh ubuntu@ -``` +| Variable | Description | +| ---------------------------- | -------------------------------------------------------------------------------------- | +| `OPENBAO_ADDR` | Address embedded in the TLS certificate and the Raft cluster address | +| `OPENBAO_UNSEAL_PGP_KEYS` | Comma-separated PGP public keys. Each unseal key share comes back encrypted to one key | +| `OPENBAO_ROOT_TOKEN_PGP_KEY` | One PGP public key. The root token comes back encrypted to it | -4. Update the system: +Each PGP entry is either `keybase:` or a base64-encoded ASCII-armored public key. These +variables do not let you choose the secret values. OpenBao always generates the root token and the +unseal keys. They control only who those values are encrypted to. -```bash -sudo apt update && sudo apt upgrade -y -``` +:::note -## Install OpenBao +When you supply `OPENBAO_UNSEAL_PGP_KEYS`, the number of keys becomes the unseal key-share count and +threshold, and the VM cannot unseal itself, because it never holds a private key. Decrypt your share +locally and run `bao operator unseal` yourself. -OpenBao publishes an official APT repository. Add its signing key and source, then install the -`openbao` package. +::: -```bash -sudo apt install -y gpg wget -sudo mkdir -p /usr/share/keyrings -wget -qO- https://pkg.openbao.org/gpg.key | sudo gpg --dearmor -o /usr/share/keyrings/openbao-keyring.gpg -echo "deb [signed-by=/usr/share/keyrings/openbao-keyring.gpg] https://pkg.openbao.org/deb stable main" | sudo tee /etc/apt/sources.list.d/openbao.list -``` +## Getting started -Install OpenBao: +### 1. Connect to your VM ```bash -sudo apt update -sudo apt install -y openbao +ssh ubuntu@ ``` -The package installs the `bao` CLI, a dedicated `openbao` user, a systemd service, and a default -configuration file at `/etc/openbao/openbao.hcl`. - -## Configure OpenBao +### 2. Wait for first-boot configuration -Edit `/etc/openbao/openbao.hcl` to use integrated (Raft) storage and listen on all interfaces. This -quick-start listener disables TLS so you can verify the install. See the TLS note below before -exposing it. +On the first boot, a setup script generates a TLS certificate for this VM, starts OpenBao, +initialises it with 5 key shares and a threshold of 3, and unseals it. Track progress: ```bash -sudo tee /etc/openbao/openbao.hcl >/dev/null <<'EOF' -ui = true - -storage "raft" { - path = "/opt/openbao/data" - node_id = "openbao-1" -} +journalctl -u openbao-first-boot.service -f +``` -listener "tcp" { - address = "0.0.0.0:8200" - tls_disable = true -} +### 3. Retrieve the unseal keys and root token -api_addr = "http://127.0.0.1:8200" -cluster_addr = "https://127.0.0.1:8201" -EOF +They are written to a root-only file: -sudo mkdir -p /opt/openbao/data -sudo chown -R openbao:openbao /opt/openbao +```bash +sudo cat /etc/openbao/credentials.txt ``` -Enable and start the service, then point the CLI at the local API: +:::danger -```bash -sudo systemctl enable --now openbao -export BAO_ADDR='http://127.0.0.1:8200' -``` +Copy the unseal keys and the root token somewhere safe, then remove them from the VM. Anyone holding +the root token has full control of your secrets, and losing the unseal keys makes the data +unrecoverable. + +::: -Initialise OpenBao once. This prints the unseal keys and the initial root token. Store them -securely. They cannot be recovered: +### 4. Use the API ```bash -bao operator init +export BAO_ADDR=https://:8200 +export BAO_SKIP_VERIFY=true +bao status ``` -OpenBao starts **sealed**. Unseal it by supplying the threshold of unseal keys (three by default), -running the command once per key: +The certificate is self-signed, so either trust it or set `BAO_SKIP_VERIFY` while testing. Replace +it with your own certificate for production. + +## Managing OpenBao ```bash -bao operator unseal -``` +# Check status +sudo systemctl status openbao -Once unsealed, log in with the root token to start managing secrets: +# Restart +sudo systemctl restart openbao -```bash -bao login +# View logs +sudo journalctl -u openbao -f ``` -:::caution +Configuration lives in `/etc/openbao`, the Raft data in `/opt/openbao/data`, and the per-VM +certificate in `/etc/openbao/tls`. -The quick-start listener above runs without TLS. Before exposing OpenBao beyond this host, enable -TLS in the `listener "tcp"` block (set `tls_cert_file` and `tls_key_file`, drop `tls_disable`) or -place it behind a reverse proxy that terminates HTTPS. Never serve production secrets over plain -HTTP. +## Security -::: +Port 8200 is opened only after the service answers a health check over TLS. UFW is enabled and +allows that port plus SSH (port 22). + +OpenBao seals itself whenever the service restarts. Unseal it again with three of your key shares: -## Open the firewall +```bash +bao operator unseal +``` -The instance allows only SSH (port 22) externally by default. Open the API port OpenBao serves and -add it to the instance's network/security rules in the portal: +**To restrict access to a specific IP:** ```bash -sudo ufw allow 8200/tcp +sudo ufw delete allow 8200/tcp +sudo ufw allow from to any port 8200 ``` ## Next steps - [OpenBao documentation](https://openbao.org/docs/) -- [OpenBao installation guide](https://openbao.org/docs/install/) +- [Seal and unseal concepts](https://openbao.org/docs/concepts/seal/) +- [Integrated Raft storage](https://openbao.org/docs/internals/integrated-storage/) diff --git a/src/content/docs/public-cloud/marketplace/portainer.md b/src/content/docs/public-cloud/marketplace/portainer.md index 2ad0238..f8fe691 100644 --- a/src/content/docs/public-cloud/marketplace/portainer.md +++ b/src/content/docs/public-cloud/marketplace/portainer.md @@ -4,14 +4,15 @@ title: Portainer Portainer is a lightweight management UI for Docker and Kubernetes environments. It lets you deploy containers, manage images, volumes, and networks, and monitor your stacks from a single web console. -The UI runs on port 9443 over HTTPS (port 9000 for plain HTTP). +The UI runs on port 9443 over HTTPS. -:::note[Coming soon] +## Software included -A pre-built Portainer image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance -from the marketplace and follow the steps below to install Portainer yourself. - -::: +| Component | Version | +| ------------ | ------------- | +| Portainer CE | 2.39.4 | +| Docker | Latest stable | +| Ubuntu | 24.04 LTS | ## Requirements @@ -21,86 +22,97 @@ from the marketplace and follow the steps below to install Portainer yourself. | RAM | 1 GB | 2 GB | | Storage | 20 GB | 40 GB | -## Deploy the base instance +## Environment variables + +This image takes no deploy-time variables. It creates no shared administrator account. Open the +Portainer UI after first boot and create the first administrator there. -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab, search for - **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from **Instances → - Create**. Either way you get a clean Ubuntu 24.04 VM. -2. Choose a plan that meets the requirements above and pick your region (YOW-1 or YUL-1). -3. When the instance is **Running**, connect over SSH: +If the first-user setup session expires before you finish, restart Portainer and reload the UI: ```bash -ssh ubuntu@ +cd /opt/portainer && docker compose restart portainer ``` -4. Update the system: +## Getting started + +### 1. Connect to your VM ```bash -sudo apt update && sudo apt upgrade -y +ssh ubuntu@ ``` -## Install Portainer +### 2. Wait for first-boot configuration -Portainer runs as a Docker container, so install Docker Engine first using the official convenience -script: +On the first boot, a setup script starts the Portainer container with Docker Compose. This takes +under a minute. Track progress: ```bash -curl -fsSL https://get.docker.com | sudo sh +journalctl -u portainer-first-boot.service -f ``` -Confirm Docker is running: +The login message (MOTD) confirms when Portainer is ready. -```bash -docker version -``` +### 3. Create the administrator account -Create a volume for Portainer's persistent data: +Open a browser and navigate to: -```bash -docker volume create portainer_data +```text +https://:9443 ``` -Run the Portainer CE server container: +On first load, create your administrator account by setting a username and a strong password. +Portainer connects to the local Docker environment through the mounted socket, so your containers, +images, and volumes appear immediately. + +:::caution + +Portainer locks initial setup if no admin account is created shortly after the container starts. If +the setup window expires, restart Portainer and reload the page: ```bash -sudo docker run -d \ - -p 8000:8000 \ - -p 9443:9443 \ - --name portainer \ - --restart=always \ - -v /var/run/docker.sock:/var/run/docker.sock \ - -v portainer_data:/data \ - portainer/portainer-ce:lts +cd /opt/portainer && docker compose restart ``` -Confirm the container is running: +The UI uses a self-signed certificate, so your browser shows a security warning. Accept the +exception to proceed. + +::: + +## Managing Portainer + +Portainer runs as a Docker Compose stack in `/opt/portainer`. ```bash -docker ps -``` +# Check status +cd /opt/portainer && docker compose ps -## Configure Portainer +# Restart +cd /opt/portainer && docker compose restart -Portainer serves the UI on port 9443 over HTTPS with a self-signed certificate. Open -`https://:9443` in a browser within a few minutes of starting the container. For -security, Portainer locks initial setup if no admin account is created shortly after first boot. +# View logs +cd /opt/portainer && docker compose logs -f +``` -On first load, create your administrator account by setting a username and a strong password. -Portainer then connects to the local Docker environment through the mounted socket, so your -containers, images, and volumes appear immediately. The self-signed certificate triggers a browser -warning. For a production setup, put Portainer behind a reverse proxy such as nginx with a trusted -TLS certificate. +Portainer's persistent data is stored in `/var/lib/portainer`. A summary of URLs and paths is +written to `/etc/portainer/info.txt`. -## Open the firewall +## Security -The instance allows only SSH (port 22) externally by default. Open the port(s) Portainer needs and -add them to the instance's network/security rules in the portal: +Port 9443 is open on the VM's network interface. UFW is enabled and allows SSH (port 22) and +Portainer (port 9443). Ports 8000, 9000, and the Docker API are not opened by default. + +Portainer bind-mounts the host Docker socket, giving it full control of the VM's Docker daemon. +Restrict access to port 9443: ```bash -sudo ufw allow 9443/tcp +sudo ufw delete allow 9443/tcp +sudo ufw allow from to any port 9443 ``` +**For production use**, place Portainer behind a reverse proxy such as nginx with a trusted TLS +certificate. + ## Next steps - [Portainer documentation](https://docs.portainer.io/) -- [Portainer installation guide](https://docs.portainer.io/start/install-ce/server/docker/linux) +- [Managing Docker environments](https://docs.portainer.io/user/docker) diff --git a/src/content/docs/public-cloud/marketplace/postgresql.md b/src/content/docs/public-cloud/marketplace/postgresql.md index 425a544..d156c72 100644 --- a/src/content/docs/public-cloud/marketplace/postgresql.md +++ b/src/content/docs/public-cloud/marketplace/postgresql.md @@ -1,17 +1,20 @@ --- -title: PostgreSQL 17 +title: PostgreSQL --- PostgreSQL is an open-source object-relational database known for its reliability, standards compliance, and extensibility. It supports advanced data types, full-text search, JSON, and a wide range of extensions. +PostgreSQL is published as one image per supported major version. Pick 16, 17, or 18 when you +deploy. + ## Software included -| Component | Version | -| ---------- | --------- | -| PostgreSQL | 17.x | -| Ubuntu | 24.04 LTS | +| Component | Version | +| ---------- | ---------------------------------- | +| PostgreSQL | 16.x, 17.x, or 18.x (per template) | +| Ubuntu | 24.04 LTS | ## Environment variables @@ -80,7 +83,7 @@ sudo systemctl restart postgresql sudo journalctl -u postgresql -f ``` -Configuration directory: `/etc/postgresql/17/main/` +Configuration directory: `/etc/postgresql//main/` Key files: @@ -119,5 +122,5 @@ Avoid exposing port 5432 to `0.0.0.0`. Restrict access to known IPs or use an SS ## Next steps -- [PostgreSQL 17 documentation](https://www.postgresql.org/docs/17/) +- [PostgreSQL documentation](https://www.postgresql.org/docs/current/) - [PostgreSQL security guide](https://www.postgresql.org/docs/current/security.html) diff --git a/src/content/docs/public-cloud/marketplace/prometheus.md b/src/content/docs/public-cloud/marketplace/prometheus.md index ed95bc7..0625222 100644 --- a/src/content/docs/public-cloud/marketplace/prometheus.md +++ b/src/content/docs/public-cloud/marketplace/prometheus.md @@ -7,12 +7,15 @@ configured targets at intervals, stores them in a time-series database, and eval trigger alerts. It exposes a query interface and built-in expression browser on port 9090, and pairs well with Grafana for dashboards. -:::note[Coming soon] +## Software included -A pre-built Prometheus image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance -from the marketplace and follow the steps below to install Prometheus yourself. +| Component | Version | +| ---------- | --------- | +| Prometheus | 3.13.0 | +| Ubuntu | 24.04 LTS | -::: +The image ships the Prometheus server only. Add exporters (such as `node_exporter`) as scrape +targets, and run Alertmanager separately as its own component to handle alert routing. ## Requirements @@ -22,140 +25,90 @@ from the marketplace and follow the steps below to install Prometheus yourself. | RAM | 2 GB | 4 GB | | Storage | 20 GB | 50 GB | -## Deploy the base instance +Storage requirements grow with the number of series and the retention period. -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab. It opens on - **Featured** by default, so select **Marketplace** next to it. Pick your region (YOW-1 or YUL-1), - search for **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from - **Instances → Create**. Either way you get a clean Ubuntu 24.04 VM. +## Getting started - ![The Marketplace tab in the ZSoftly Cloud portal, showing the region selector, category list, search box, and Deploy buttons](../../../../assets/marketplace/deploy-marketplace-tab.webp) - - ![Searching the Marketplace for an app, with the search box filtering the catalog down to a matching Deploy card](../../../../assets/marketplace/deploy-marketplace-search.webp) - -2. Choose a plan that meets the requirements above. - -3. When the instance is **Running**, connect over SSH: +### 1. Connect to your VM ```bash ssh ubuntu@ ``` -4. Update the system: +### 2. Wait for first-boot configuration + +On the first boot, a setup script starts the service. This takes under a minute. Track progress: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u prometheus-first-boot.service -f ``` -## Install Prometheus +The login message (MOTD) confirms when Prometheus is ready. -Install Prometheus from the official binary release and run it as a systemd service. This is the -common production method and gives you full control over the version. +### 3. Access the Prometheus UI -Create a dedicated, unprivileged system user and the config and data directories: +Open a browser and navigate to the expression browser and built-in UI: -```bash -sudo useradd --no-create-home --shell /bin/false prometheus -sudo mkdir -p /etc/prometheus /var/lib/prometheus +```text +http://:9090 ``` -Download the latest release from prometheus.io and extract it. Check the -[releases page](https://prometheus.io/download/) for the current version and update it below: +### 4. Add scrape targets -```bash -PROM_VERSION=3.4.1 -cd /tmp -curl -fsSLO https://github.com/prometheus/prometheus/releases/download/v${PROM_VERSION}/prometheus-${PROM_VERSION}.linux-amd64.tar.gz -tar -xzf prometheus-${PROM_VERSION}.linux-amd64.tar.gz -cd prometheus-${PROM_VERSION}.linux-amd64 -``` - -Install the binaries and supporting files, then set ownership to the `prometheus` user: +Edit the scrape configuration, validate it, and reload without a restart: ```bash -sudo cp prometheus promtool /usr/local/bin/ -sudo cp -r consoles console_libraries /etc/prometheus/ -sudo cp prometheus.yml /etc/prometheus/prometheus.yml -sudo chown -R prometheus:prometheus /usr/local/bin/prometheus /usr/local/bin/promtool /etc/prometheus /var/lib/prometheus +sudo nano /etc/prometheus/prometheus.yml +promtool check config /etc/prometheus/prometheus.yml +sudo systemctl reload prometheus ``` -Write a minimal scrape configuration. The default scrapes Prometheus itself on port 9090. Add your -own targets under `scrape_configs`: +## Managing Prometheus + +Prometheus runs as a systemd service under a dedicated `prometheus` user. ```bash -sudo tee /etc/prometheus/prometheus.yml > /dev/null <<'EOF' -global: - scrape_interval: 15s - evaluation_interval: 15s - -scrape_configs: - - job_name: prometheus - static_configs: - - targets: ["localhost:9090"] -EOF -sudo chown prometheus:prometheus /etc/prometheus/prometheus.yml -``` +# Check status +systemctl status prometheus -Create the systemd service unit: +# Restart +sudo systemctl restart prometheus -```bash -sudo tee /etc/systemd/system/prometheus.service > /dev/null <<'EOF' -[Unit] -Description=Prometheus -Wants=network-online.target -After=network-online.target - -[Service] -User=prometheus -Group=prometheus -Type=simple -ExecStart=/usr/local/bin/prometheus \ - --config.file=/etc/prometheus/prometheus.yml \ - --storage.tsdb.path=/var/lib/prometheus/ \ - --web.console.templates=/etc/prometheus/consoles \ - --web.console.libraries=/etc/prometheus/console_libraries \ - --web.listen-address=0.0.0.0:9090 -Restart=on-failure - -[Install] -WantedBy=multi-user.target -EOF +# Reload the config without restarting +sudo systemctl reload prometheus + +# View logs +sudo journalctl -u prometheus -f ``` -Reload systemd, then enable and start the service: +| Path | Purpose | +| -------------------------------- | --------------------------- | +| `/etc/prometheus/prometheus.yml` | Main configuration | +| `/var/lib/prometheus/` | Time-series database (TSDB) | -```bash -sudo systemctl daemon-reload -sudo systemctl enable --now prometheus -sudo systemctl status prometheus -``` +## Security -## Configure Prometheus +Port 9090 is open on the VM's network interface, and Prometheus has **no built-in authentication**. +UFW is enabled and allows SSH (port 22) and Prometheus (port 9090). -1. Open `http://:9090` in a browser to reach the Prometheus expression browser and - built-in UI. -2. Add scrape targets by editing `/etc/prometheus/prometheus.yml` (for example, a `node_exporter` - running on a host), then validate and reload: +**To restrict the UI to a specific IP:** ```bash -promtool check config /etc/prometheus/prometheus.yml -sudo systemctl reload prometheus +sudo ufw delete allow 9090/tcp +sudo ufw allow from to any port 9090 ``` -3. Prometheus has no authentication of its own. For production, place it behind a reverse proxy such - as Nginx or Caddy to add TLS and access control on port 443, and restrict direct access to - port 9090. - -## Open the firewall - -The instance allows only SSH (port 22) externally by default. Open the port Prometheus needs and add -it to the instance's network/security rules in the portal: +**To reach the UI without opening the firewall, use an SSH tunnel:** ```bash -sudo ufw allow 9090/tcp +# Run this on your local machine +ssh -L 9090:localhost:9090 ubuntu@ ``` +**For production use**, place Prometheus behind a reverse proxy such as Nginx or Caddy to add TLS +and access control on port 443, and restrict direct access to port 9090. + ## Next steps - [Prometheus documentation](https://prometheus.io/docs/introduction/overview/) -- [Prometheus installation guide](https://prometheus.io/docs/prometheus/latest/installation/) +- [Configuration reference](https://prometheus.io/docs/prometheus/latest/configuration/configuration/) diff --git a/src/content/docs/public-cloud/marketplace/supabase.md b/src/content/docs/public-cloud/marketplace/supabase.md index 41c4e25..8492bed 100644 --- a/src/content/docs/public-cloud/marketplace/supabase.md +++ b/src/content/docs/public-cloud/marketplace/supabase.md @@ -7,12 +7,18 @@ authentication, instant REST and GraphQL APIs, realtime subscriptions, storage, dashboard into one self-hostable stack. The Studio and APIs are served through the Kong gateway on port 8000. -:::note[Coming soon] +## Software included -A pre-built Supabase image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance from -the marketplace and follow the steps below to install Supabase yourself. +| Component | Version | +| -------------- | ----------------- | +| Supabase | Self-hosted stack | +| PostgreSQL | 17 | +| Docker | Latest stable | +| Docker Compose | Latest stable | +| Ubuntu | 24.04 LTS | -::: +The stack includes Studio, the Kong API gateway, Auth (GoTrue), PostgREST, Realtime, Storage, and +postgres-meta, all on PostgreSQL 17. ## Requirements @@ -22,109 +28,90 @@ the marketplace and follow the steps below to install Supabase yourself. | RAM | 4 GB | 8 GB | | Storage | 30 GB | 80 GB | -## Deploy the base instance +## Environment variables -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab, search for - **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from **Instances → - Create**. Either way you get a clean Ubuntu 24.04 VM. -2. Choose a plan that meets the requirements above and pick your region (YOW-1 or YUL-1). -3. When the instance is **Running**, connect over SSH: +You can optionally set these when deploying Supabase from the marketplace. Leave a password field +blank to have a secure random value generated automatically. -```bash -ssh ubuntu@ -``` +| Variable | Description | +| -------------------- | --------------------------------------------------------- | +| `SITE_URL` | Public URL for the Supabase instance and Studio dashboard | +| `POSTGRES_PASSWORD` | Password for the PostgreSQL database | +| `DASHBOARD_PASSWORD` | Password for the Studio dashboard login | + +These are the only variables you set at deploy time. `SUPABASE_PUBLIC_URL` and `API_EXTERNAL_URL`, +referenced under [Security](#security), are edited in `/data/supabase/.env` on the running VM. -4. Update the system: +## Getting started + +### 1. Connect to your VM ```bash -sudo apt update && sudo apt upgrade -y +ssh ubuntu@ ``` -## Install Supabase +### 2. Wait for first-boot configuration -Supabase self-hosts as a Docker Compose stack, so install Docker Engine and the Compose plugin -first. - -Set up Docker's official APT repository for Ubuntu 24.04 LTS (`noble`): +On the first boot, a setup script generates the database password, JWT secret, API keys, and Studio +credentials, then pulls the container images and starts the stack. The image pull is large, so this +takes roughly 15-20 minutes. Track progress: ```bash -sudo apt install -y ca-certificates curl git -sudo install -m 0755 -d /etc/apt/keyrings -sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc -sudo chmod a+r /etc/apt/keyrings/docker.asc -sudo tee /etc/apt/sources.list.d/docker.sources >/dev/null <:8000 +``` -The repository ships helper scripts to generate matching secrets and API keys for you: +Sign in with the `supabase` username and the generated password. The REST and Auth APIs are served +through the same gateway at `http://:8000/rest/v1/` and +`http://:8000/auth/v1/`. -```bash -sh utils/generate-keys.sh -sh utils/add-new-auth-keys.sh -``` +## Managing Supabase -Pull the images and start the stack: +Supabase runs as a Docker Compose stack in `/data/supabase`. ```bash -sudo docker compose pull -sudo docker compose up -d --wait -``` +# Check status +cd /data/supabase && docker compose ps -Once the containers are healthy, the Studio dashboard and APIs are served through Kong on port 8000: +# Restart +cd /data/supabase && docker compose restart -- Studio dashboard: `http://:8000` (log in with `DASHBOARD_USERNAME` / - `DASHBOARD_PASSWORD`) -- REST API: `http://:8000/rest/v1/` -- Auth API: `http://:8000/auth/v1/` +# View logs +cd /data/supabase && docker compose logs -f +``` -For a production setup, put Supabase behind a reverse proxy such as nginx with a TLS certificate, -then serve Studio and the APIs over HTTPS instead of exposing port 8000 directly. +Environment configuration: `/data/supabase/.env`. Database and storage data are stored under +`/data/supabase/volumes`. -## Open the firewall +## Security -The instance allows only SSH (port 22) externally by default. Open the port(s) Supabase needs and -add them to the instance's network/security rules in the portal: +Ports 8000, 80, and 443 are open on the VM's network interface. UFW is enabled and allows those +ports plus SSH (port 22). Direct PostgreSQL access (5432) is not exposed. -```bash -sudo ufw allow 8000/tcp -``` +Change the Studio dashboard password after first login. **For production use**, set +`SUPABASE_PUBLIC_URL`, `API_EXTERNAL_URL`, and `SITE_URL` in `/data/supabase/.env` to your domain, +restart the stack, and place Supabase behind a reverse proxy such as nginx with a TLS certificate so +Studio and the APIs are served over HTTPS instead of exposing port 8000 directly. ## Next steps - [Supabase documentation](https://supabase.com/docs) -- [Supabase self-hosting guide](https://supabase.com/docs/guides/self-hosting/docker) +- [Self-hosting guide](https://supabase.com/docs/guides/self-hosting/docker) diff --git a/src/content/docs/public-cloud/marketplace/valkey.md b/src/content/docs/public-cloud/marketplace/valkey.md index 3efa9b9..999005b 100644 --- a/src/content/docs/public-cloud/marketplace/valkey.md +++ b/src/content/docs/public-cloud/marketplace/valkey.md @@ -1,5 +1,5 @@ --- -title: Valkey 9.0 +title: Valkey 9.1 --- Valkey is an open-source, high-performance in-memory data store and Redis-compatible alternative. It @@ -10,7 +10,7 @@ queues. | Component | Version | | --------- | --------- | -| Valkey | 9.0.x | +| Valkey | 9.1.x | | Ubuntu | 24.04 LTS | ## Environment variables diff --git a/src/content/docs/public-cloud/marketplace/vaultwarden.md b/src/content/docs/public-cloud/marketplace/vaultwarden.md index 8e9d532..f76b941 100644 --- a/src/content/docs/public-cloud/marketplace/vaultwarden.md +++ b/src/content/docs/public-cloud/marketplace/vaultwarden.md @@ -6,12 +6,17 @@ Vaultwarden is a lightweight, self-hosted password manager that implements the B fully compatible with official Bitwarden client apps and browser extensions, letting you store and sync passwords, secure notes, and other secrets on infrastructure you control. -:::note[Coming soon] +## Software included -A pre-built Vaultwarden image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance -from the marketplace and follow the steps below to install Vaultwarden yourself. +| Component | Version | +| -------------- | ------------- | +| Vaultwarden | 1.36.0 | +| Docker | Latest stable | +| Docker Compose | Latest stable | +| Ubuntu | 24.04 LTS | -::: +Vaultwarden stores its data in an embedded SQLite database and serves the web vault over HTTPS on +port 8000 with a self-signed certificate generated on first boot. ## Requirements @@ -21,118 +26,99 @@ from the marketplace and follow the steps below to install Vaultwarden yourself. | RAM | 1 GB | 2 GB | | Storage | 10 GB | 20 GB | -Vaultwarden is resource-light. A domain name and TLS certificate are strongly recommended, since -Bitwarden clients require HTTPS to connect. - -## Deploy the base instance +Vaultwarden is resource-light. -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab. It opens on - **Featured** by default, so select **Marketplace** next to it. Pick your region (YOW-1 or YUL-1), - search for **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from - **Instances → Create**. Either way you get a clean Ubuntu 24.04 VM. +## Environment variables - ![The Marketplace tab in the ZSoftly Cloud portal, showing the region selector, category list, search box, and Deploy buttons](../../../../assets/marketplace/deploy-marketplace-tab.webp) +You can optionally set these when deploying Vaultwarden from the marketplace. Leave `ADMIN_TOKEN` +blank to have a secure random value generated automatically. - ![Searching the Marketplace for an app, with the search box filtering the catalog down to a matching Deploy card](../../../../assets/marketplace/deploy-marketplace-search.webp) +| Variable | Description | +| -------------------- | -------------------------------------------------------------------- | +| `VAULTWARDEN_DOMAIN` | Full public URL clients use, for example `https://vault.example.com` | +| `ADMIN_TOKEN` | Token for the `/admin` panel | -2. Choose a plan that meets the requirements above. +## Getting started -3. When the instance is **Running**, connect over SSH: +### 1. Connect to your VM ```bash ssh ubuntu@ ``` -4. Update the system: - -```bash -sudo apt update && sudo apt upgrade -y -``` - -## Install Vaultwarden +### 2. Wait for first-boot configuration -Vaultwarden is distributed as an official Docker image, so install Docker Engine and the Compose -plugin first. - -Set up Docker's official APT repository for Ubuntu 24.04 LTS (`noble`): +On the first boot, a setup script generates a self-signed TLS certificate and the admin token, then +starts the container with Docker Compose. This takes under a minute. Track progress: ```bash -sudo apt install -y ca-certificates curl -sudo install -m 0755 -d /etc/apt/keyrings -sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc -sudo chmod a+r /etc/apt/keyrings/docker.asc -sudo tee /etc/apt/sources.list.d/docker.sources >/dev/null <:8000 ``` -## Configure Vaultwarden +The self-signed certificate triggers a browser warning. Accept the exception to proceed. The admin +panel is at `https://:8000/admin`. -:::caution +:::note -Bitwarden client apps refuse to connect over plain HTTP. Do not expose Vaultwarden directly. Always -place it behind a reverse proxy (Caddy, nginx, or Traefik) that terminates TLS and forwards to host -port 8080. +User self-registration is disabled by default (`SIGNUPS_ALLOWED=false`). To add users, open the +admin panel and invite them under **Users**, or enable open registration under **General Settings**. ::: -A minimal Caddy reverse proxy gives you automatic HTTPS. Point your domain's DNS at the VM, then: +## Managing Vaultwarden + +Vaultwarden runs as a Docker Compose stack in `/data/vaultwarden`. ```bash -sudo apt install -y caddy -echo 'vault.example.com { - reverse_proxy 127.0.0.1:8080 -}' | sudo tee /etc/caddy/Caddyfile -sudo systemctl restart caddy +# Check status +cd /data/vaultwarden && docker compose ps + +# Restart +cd /data/vaultwarden && docker compose restart + +# View logs +cd /data/vaultwarden && docker compose logs -f ``` -Set `DOMAIN` in the `docker run` command above to your real `https://` URL so vault item icons, -attachments, and WebAuthn work correctly. Once TLS is live, reach the admin page at -`https://vault.example.com/admin` and sign in with the password you hashed into `ADMIN_TOKEN`. Treat -that token like a root password. +Environment configuration: `/data/vaultwarden/vaultwarden.env`. The vault database and certificate +are stored under `/data/vaultwarden/data`. + +## Security + +Port 8000 is open on the VM's network interface. UFW is enabled and allows SSH (port 22) and the +Vaultwarden web vault (port 8000). Bitwarden clients require HTTPS, which the image serves with a +self-signed certificate by default. -## Open the firewall +Treat the admin token like a root password. -The instance allows only SSH (port 22) externally by default. Open the HTTPS port your reverse proxy -serves and add it to the instance's network/security rules in the portal: +**For production use**, set `DOMAIN` to the full public URL clients use, including the scheme and +any port or path (for example `https://vault.example.com` or `https://:8000`), in +`/data/vaultwarden/vaultwarden.env`, replace the self-signed certificate with a trusted one (or +front Vaultwarden with a reverse proxy such as Caddy that terminates TLS), and restart the stack: ```bash -sudo ufw allow 80/tcp -sudo ufw allow 443/tcp +cd /data/vaultwarden && docker compose restart ``` ## Next steps - [Vaultwarden documentation](https://github.com/dani-garcia/vaultwarden/wiki) -- [Vaultwarden installation guide](https://github.com/dani-garcia/vaultwarden/wiki/Starting-with-Docker) +- [Enabling HTTPS](https://github.com/dani-garcia/vaultwarden/wiki/Enabling-HTTPS) diff --git a/src/content/docs/public-cloud/marketplace/zabbix.md b/src/content/docs/public-cloud/marketplace/zabbix.md index ec42997..c285b8a 100644 --- a/src/content/docs/public-cloud/marketplace/zabbix.md +++ b/src/content/docs/public-cloud/marketplace/zabbix.md @@ -2,17 +2,19 @@ title: Zabbix --- -Zabbix is an enterprise-grade, open-source monitoring platform for networks, servers, cloud -services, and applications. It collects metrics through agents, SNMP, IPMI, and agentless checks, -then provides alerting, visualization, and dashboards from a single web frontend. This guide -installs the Zabbix server, web frontend, and agent with a MySQL backend on Apache. +Zabbix is an open-source monitoring platform for networks, servers, cloud services, and +applications. It collects metrics through agents, SNMP, IPMI, and agentless checks, then provides +alerting, visualization, and dashboards from a single web frontend. This image ships the Zabbix +server, web frontend, and agent with a MySQL backend on Apache. -:::note[Coming soon] +## Software included -A pre-built Zabbix image is on its way. For now, deploy a fresh **Ubuntu 24.04 LTS** instance from -the marketplace and follow the steps below to install Zabbix yourself. - -::: +| Component | Version | +| --------- | --------- | +| Zabbix | 7.0 (LTS) | +| MySQL | 8.0 | +| Apache | 2.4.x | +| Ubuntu | 24.04 LTS | ## Requirements @@ -22,110 +24,88 @@ the marketplace and follow the steps below to install Zabbix yourself. | RAM | 2 GB | 4 GB | | Storage | 30 GB | 60 GB | -## Deploy the base instance - -1. In the ZSoftly Cloud portal, open **Apps** and switch to the **Marketplace** tab. It opens on - **Featured** by default, so select **Marketplace** next to it. Pick your region (YOW-1 or YUL-1), - search for **Ubuntu 24.04 LTS**, and click **Deploy**. You can also create the instance from - **Instances → Create**. Either way you get a clean Ubuntu 24.04 VM. - - ![The Marketplace tab in the ZSoftly Cloud portal, showing the region selector, category list, search box, and Deploy buttons](../../../../assets/marketplace/deploy-marketplace-tab.webp) +## Environment variables - ![Searching the Marketplace for an app, with the search box filtering the catalog down to a matching Deploy card](../../../../assets/marketplace/deploy-marketplace-search.webp) +This image takes no deploy-time variables. It creates no shared administrator password. Zabbix ships +with a default `Admin` password, and first boot replaces it with a value unique to your VM. -2. Choose a plan that meets the requirements above. +## Getting started -3. When the instance is **Running**, connect over SSH: +### 1. Connect to your VM ```bash ssh ubuntu@ ``` -4. Update the system: +### 2. Wait for first-boot configuration + +On the first boot, a setup script initialises MySQL, imports the Zabbix schema, writes the frontend +configuration, starts the services, and rotates the default `Admin` password. Track progress: ```bash -sudo apt update && sudo apt upgrade -y +journalctl -u zabbix-first-boot.service -f ``` -## Install Zabbix +The login message (MOTD) confirms when Zabbix is ready. -Install the MySQL database server and Apache first: +### 3. Retrieve the admin password -```bash -sudo apt install -y mysql-server apache2 -``` - -Add the official Zabbix repository. Zabbix 7.4 is the current stable release. Install the Ubuntu -24.04 (`noble`) `zabbix-release` deb: +The credentials are written to a root-only file: ```bash -wget https://repo.zabbix.com/zabbix/7.4/release/ubuntu/pool/main/z/zabbix-release/zabbix-release_latest_7.4+ubuntu24.04_all.deb -sudo dpkg -i zabbix-release_latest_7.4+ubuntu24.04_all.deb -sudo apt update +sudo cat /root/.credentials/zabbix.txt ``` -Install the Zabbix server, frontend, and agent packages: +### 4. Open the web frontend -```bash -sudo apt install -y zabbix-server-mysql zabbix-frontend-php \ - zabbix-apache-conf zabbix-sql-scripts zabbix-agent2 +Open a browser and navigate to: + +```text +http:///zabbix/ ``` -## Configure Zabbix +Sign in as `Admin` with the password from the previous step. -1. Create the Zabbix database and user in MySQL: +:::caution - ```bash - sudo mysql -uroot -e "CREATE DATABASE zabbix CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;" - sudo mysql -uroot -e "CREATE USER 'zabbix'@'localhost' IDENTIFIED BY 'ChangeThisPassword';" - sudo mysql -uroot -e "GRANT ALL PRIVILEGES ON zabbix.* TO 'zabbix'@'localhost';" - sudo mysql -uroot -e "SET GLOBAL log_bin_trust_function_creators = 1;" - ``` +Zabbix ships with a well-known default `Admin` password. This image replaces it on first boot, so do +not reuse the documented default from the upstream project. -2. Import the initial schema and data (you will be prompted for the `zabbix` password): +::: - ```bash - sudo zcat /usr/share/zabbix-sql-scripts/mysql/server.sql.gz \ - | mysql --default-character-set=utf8mb4 -uzabbix -p zabbix - ``` +## Managing Zabbix -3. Disable the function-creator flag again: +```bash +# Check status +sudo systemctl status zabbix-server apache2 mysql - ```bash - sudo mysql -uroot -e "SET GLOBAL log_bin_trust_function_creators = 0;" - ``` +# Restart the server +sudo systemctl restart zabbix-server -4. Set the database password in `/etc/zabbix/zabbix_server.conf` by uncommenting and editing the - `DBPassword=` line to match the password above. -5. Start and enable all services: +# View logs +sudo tail -f /var/log/zabbix/zabbix_server.log +``` - ```bash - sudo systemctl restart zabbix-server zabbix-agent2 apache2 - sudo systemctl enable zabbix-server zabbix-agent2 apache2 - ``` +Server configuration lives in `/etc/zabbix/zabbix_server.conf` and the frontend configuration in +`/etc/zabbix/web/`. -6. Open `http:///zabbix` in your browser and complete the web setup wizard (database - connection, server details, timezone). -7. Log in with the default credentials **Admin** / **zabbix**, then immediately change the Admin - password under **Users → Users**. -8. For production, configure Apache with your domain and a TLS certificate so the frontend is served - over HTTPS on port 443. +## Security -## Open the firewall +Port 80 (web frontend) and port 10051 (Zabbix server, used by agents to report in) are open on the +VM's network interface. UFW is enabled and allows those ports plus SSH (port 22). -The instance allows only SSH (port 22) externally by default. Open the ports Zabbix needs and add -them to the instance's network/security rules in the portal: +**To restrict the web frontend to a specific IP:** ```bash -sudo ufw allow 80/tcp -sudo ufw allow 443/tcp -sudo ufw allow 10051/tcp +sudo ufw delete allow 80/tcp +sudo ufw allow from to any port 80 ``` -Port 80/443 serves the web frontend. Port 10051 is the Zabbix server port used by active agents and -proxies reporting in. +**For production use**, point a DNS record at the VM and front Apache with TLS, either with your own +certificate or a reverse proxy that terminates TLS. ## Next steps -- [Zabbix documentation](https://www.zabbix.com/documentation/current/) -- [Zabbix installation guide](https://www.zabbix.com/download) +- [Zabbix documentation](https://www.zabbix.com/documentation/7.0/en/) +- [Zabbix agent configuration](https://www.zabbix.com/documentation/7.0/en/manual/appendix/config/zabbix_agentd) +- [Zabbix API reference](https://www.zabbix.com/documentation/7.0/en/manual/api) diff --git a/src/content/docs/tutorials/index.md b/src/content/docs/tutorials/index.md index 1139fc6..1af382b 100644 --- a/src/content/docs/tutorials/index.md +++ b/src/content/docs/tutorials/index.md @@ -47,3 +47,16 @@ You learn how to: - [Public Cloud quickstart](/public-cloud/getting-started/quickstart): the same first deployment from the web portal - [Changelog](/changelog): what is new across the platform + +### [Manage ZCP with Terraform or OpenTofu](/tutorials/manage-infrastructure-terraform) + +Provision a network and a virtual machine declaratively with the official `zsoftly/zcp` provider, +published on the Terraform and OpenTofu registries. You write one configuration file, apply it, +change it, and destroy it, with every resource tracked. About 15 minutes. + +You learn how to: + +- Install the provider and authenticate with an API token +- Describe a network and a VM in HCL and apply the plan +- Resize in place and import resources you created elsewhere +- Destroy the whole stack with nothing left behind diff --git a/src/content/docs/tutorials/manage-infrastructure-terraform.mdx b/src/content/docs/tutorials/manage-infrastructure-terraform.mdx new file mode 100644 index 0000000..2013512 --- /dev/null +++ b/src/content/docs/tutorials/manage-infrastructure-terraform.mdx @@ -0,0 +1,261 @@ +--- +title: 'Manage ZCP with Terraform or OpenTofu' +description: + Provision a network and a virtual machine on the ZSoftly Cloud Platform declaratively with the + official zsoftly/zcp provider, from init to destroy. +sidebar: + label: 'Manage ZCP with Terraform / OpenTofu' +--- + +import { Tabs, TabItem } from '@astrojs/starlight/components'; + +Start with an empty directory and finish with a running virtual machine managed as code, using the +official `zsoftly/zcp` provider. The provider ships on the +[OpenTofu registry](https://search.opentofu.org/provider/zsoftly/zcp) and the +[Terraform Registry](https://registry.terraform.io/providers/zsoftly/zcp), and it behaves the same +with either tool, so pick whichever you already use. + +By the end you have: + +- The provider installed and authenticated with your account +- A network and a virtual machine defined in one configuration file +- The full lifecycle under your control: plan, apply, change, and destroy + +Plan for about 15 minutes. Most of it is the VM booting. + +:::note + +The slugs in this tutorial (region `yul-1`, project `default-9`, template `ubuntu-2204-lts-4`, +plans, and so on) are **examples from one account**. Yours will differ. Each step shows the `zcp` +CLI command to print the right value for your account and region. Always use those, don't copy the +examples verbatim. + +::: + +## Before you start + +- A ZSoftly Public Cloud account. [Sign up](/public-cloud/getting-started/account-signup) first if + you do not have one. +- [Terraform](https://developer.hashicorp.com/terraform/install) 1.0 or later, or + [OpenTofu](https://opentofu.org/docs/intro/install/) 1.6 or later. +- Optional but handy: the [`zcp` CLI](/public-cloud/cli/installation) to look up slugs for your + account. + +## Step 1: Get an API token + +The provider authenticates with the same bearer token as the CLI and the API. In the +[console](https://cloud.zcp.zsoftly.ca), go to **Account → API Keys** and create a token, then +export it: + +```bash +export ZCP_BEARER_TOKEN="" +``` + +The provider reads it from the environment, so the token never appears in your configuration or in +your state file. + +## Step 2: Declare the provider + +Create an empty directory with one file, `main.tf`, and declare the provider. The same source +address works for both tools: + +```hcl +terraform { + required_providers { + zcp = { + source = "zsoftly/zcp" + version = "~> 0.1" + } + } +} + +provider "zcp" { + default_project = "default-9" +} +``` + +`default_project` plays the role of a default region setting in other providers: resources without +an explicit project use it. Every account starts with a project whose slug ends in a number, like +`default-9`. Find yours with `zcp project list`. + +Then initialize the directory: + + + + + +```bash +tofu init +``` + + + + + +```bash +terraform init +``` + + + + + +The tool downloads the provider from its registry and verifies the release signature. + +## Step 3: Describe a network and a VM + +Append the resources to `main.tf`. The region data source feeds the correct `cloud_provider` value +to everything else, so you hardcode nothing twice: + +```hcl +data "zcp_region" "yul" { + slug = "yul-1" +} + +resource "zcp_network" "app" { + name = "app-network" + cloud_provider = data.zcp_region.yul.cloud_provider + region = data.zcp_region.yul.slug + network_plan = "pnet-yul" + billing_cycle = "hourly" +} + +resource "zcp_instance" "web" { + name = "web-01" + template = "ubuntu-2204-lts-4" + plan = "ca2sxs" + billing_cycle = "hourly" + network = zcp_network.app.id + storage_category = "premium-ssd" + cloud_provider = data.zcp_region.yul.cloud_provider + region = data.zcp_region.yul.slug +} + +output "public_ip" { + value = zcp_instance.web.public_ip +} + +output "private_ip" { + value = zcp_instance.web.private_ip +} +``` + +Look up the slugs for your account with the CLI: `zcp region list`, `zcp plan vm`, +`zcp plan network`, `zcp template list`, and `zcp storage-category list`. + +:::tip + +Declare the network as its own resource and attach the instance to it with `network`, as above. The +instance also accepts a `network_plan` shortcut. The platform then creates a network for you, but it +stays invisible to your configuration, so `destroy` leaves it behind. A tracked network comes and +goes with your stack. + +::: + +## Step 4: Plan and apply + + + + + +```bash +tofu plan +tofu apply +``` + + + + + +```bash +terraform plan +terraform apply +``` + + + + + +The plan shows two resources to add. Confirm with `yes` and wait: the apply blocks until the VM +reports **Running**, then prints the outputs. Expect about two to three minutes. + +``` +Apply complete! Resources: 2 added, 0 changed, 0 destroyed. + +Outputs: + +private_ip = "10.0.0.194" +public_ip = "23.229.49.88" +``` + +Run the plan again and it reports **No changes**: your file and the platform agree. + +## Step 5: Change something + +Edit the instance's `plan` to a bigger size (pick one from `zcp plan vm`) and apply again. The +provider resizes the VM in place: it stops the instance, changes the compute offering, and starts it +again, the same way an instance type change works on other clouds. Attributes shown as **forces +replacement** in the plan output (the template, the region) recreate the VM instead: read the plan +before you confirm. + +## Step 6: Import existing resources + +Bring resources you created in the console or with the CLI into the configuration rather than +recreating them. Write the matching resource block, then import by slug: + + + + + +```bash +tofu import zcp_instance.existing +``` + + + + + +```bash +terraform import zcp_instance.existing +``` + + + + + +Every resource in the provider supports import. Each resource's page on the registry documents its +import ID format: some are a plain slug, others are composite, like the SSH key's `/`. + +## Clean up + + + + + +```bash +tofu destroy +``` + + + + + +```bash +terraform destroy +``` + + + + + +Both resources go: the VM first, then the network, together with the network's public address. +Nothing keeps billing after a destroy of a fully tracked stack. + +## Next steps + +- Browse all 38 resources and 12 data sources in the provider documentation on the + [Terraform Registry](https://registry.terraform.io/providers/zsoftly/zcp/latest/docs) or the + [OpenTofu registry](https://search.opentofu.org/provider/zsoftly/zcp). +- Add an [SSH key resource](/public-cloud/compute/settings/ssh-keys) to your configuration to log in + to the instances you create. +- Watch the [changelog](/changelog) for new provider releases.