Déployer

Déployons Hyvor Blogs sur votre serveur en utilisant Docker Compose. Vous pouvez facilement adapter ce guide à d’autres méthodes de déploiement telles que Kubernetes.

Prérequis

Serveur : Un serveur Linux avec au moins 1 Go de RAM et 1 vCPU.

Docker : Installez Docker en suivant le guide officiel.

Fournisseur OpenID Connect (OIDC) : Hyvor Blogs s’appuie sur OIDC pour l’authentification. Créez une application chez votre fournisseur OIDC et obtenez l’URL de l’émetteur, l’ID client et le secret client. Puis, autorisez les URL suivantes :

  • URL de rappel (Callback URL) : https://<your-app-domain>/api/oidc/callback
  • URL de déconnexion (Logout URL) : https://<your-app-domain>

Domaine : Nom de domaine pour votre instance Hyvor Blogs. On l’appelle le « domaine de l’application » (App Domain).

Domaine de l'application
Hyvor Blogs est conçu pour gérer plusieurs domaines dans une seule installation (domaines personnalisés pour des blogs individuels). Le domaine de l'application est l'endroit où l'API principale et la Console sont hébergées. Tous les autres domaines sont considérés comme des domaines personnalisés.

Routage DNS

Pointez votre domaine d’application vers l’adresse IP de votre serveur.

Type
Hôte
Valeur
A
blogs.example.com
123.123.123.123

Consultez Reverse Proxy si vous exécutez Hyvor Blogs derrière un reverse proxy.

Installer

Obtenez le paquet de déploiement auprès de l’administrateur du service, extrayez-le, puis ouvrez le répertoire deploy.

Cela vous donne deux fichiers :

deploy/
   compose.yaml
   .env

Configurer

Modifiez le fichier .env et renseignez les valeurs requises :

  • APP_SECRET : Une chaîne aléatoire robuste. Vous pouvez en générer une avec la commande suivante : 
    openssl rand -base64 32
  • POSTGRES_PASSWORD : Utilisez un mot de passe robuste et compatible avec les URL pour la base de données Postgres. Vous pouvez en générer un avec la commande suivante : 
    openssl rand -base64 32 | tr '+/' '-_' | tr -d '='
  • DOMAIN_APP : Le domaine principal où votre instance Hyvor Blogs est hébergée (par exemple, blogs.example.com). C’est ici que vous accédez à la Console, à Sudo et aux API.
  • OIDC_ISSUER_URL, OIDC_CLIENT_ID, OIDC_CLIENT_SECRET : Définissez ces variables en fonction de la configuration de votre fournisseur OIDC.

Consultez Variables d’environnement pour toutes les variables d’environnement disponibles.

Mode TLS

TLS_MODE contrôle la manière dont HTTPS est géré pour le domaine de l’application (DOMAIN_APP). Cela n’affecte pas les domaines personnalisés attachés à des blogs individuels, qui obtiennent toujours des certificats TLS automatiquement. Définissez-le sur l’une des valeurs suivantes :

Mode
Comportement
auto
Par défaut. Caddy obtient et renouvelle automatiquement un certificat auprès de Let's Encrypt. Nécessite que DOMAIN_APP soit résolvable publiquement, avec les ports 80 et 443 accessibles depuis internet.
external
Utilisez ce mode si vous exécutez un reverse proxy (Nginx, Traefik, un équilibreur de charge, etc.) devant Hyvor Blogs qui termine le TLS. Le conteneur est accessible uniquement en HTTP ; seul le port 80 doit être publié. Le conteneur ne redirige pas lui-même HTTP vers HTTPS dans ce mode — gérez cela dans votre reverse proxy si nécessaire. Assurez-vous que votre proxy transmet les en-têtes X-Forwarded-Proto: https et X-Forwarded-For, et que son IP est incluse dans TRUSTED_PROXIES.
manual
Fournissez votre propre certificat et clé en les montant dans le conteneur à /certs/cert.pem et /certs/key.pem.
disabled
TLS est entièrement désactivé et aucune redirection HTTPS ne se produit. Tous les liens sont générés en http://. Utilisez ceci uniquement sur un réseau interne de confiance.

Si vous exécutez Hyvor Blogs derrière un reverse proxy, consultez Reverse Proxy.

Démarrer

docker compose up -d

Hyvor Blogs démarrera et exécutera automatiquement les migrations de base de données au premier lancement.

Pour vérifier les journaux (logs) :

docker compose logs -f blogs

Pour vérifier votre configuration :

docker compose exec blogs bin/console app:verify

Mise à niveau

Pour effectuer une mise à niveau vers la dernière version, remplacez la version de l’image dans compose.yaml :

services:
  blogs:
    image: hyvor/blogs:<version>

Puis, exécutez :

docker compose up -d

Les migrations sont appliquées automatiquement au démarrage.