Passer au contenu

Vous consultez le site de documentation en préversionCe contenu est destiné aux tests et peut différer de la documentation de production.

Accéder à la documentation de production

Aperçu de l'auto-hébergement

Exécutez votre propre instance et chaque secret, chaque compte et chaque ligne de journal reste sur une infrastructure que vous contrôlez. Vous décidez de la façon dont les comptes sont authentifiés, si l’instance est accessible depuis l’Internet public ou non, et de l’image de marque affichée par l’interface.

Le mode détermine ce qui doit tourner en plus, alors fixez-le avant d’installer.

simple est le mode par défaut livré et ne nécessite que le magasin de données Valkey/Redis. full ajoute une base de données SQL pour les comptes, qui utilise SQLite par défaut à sqlite://data/auth.db ; PostgreSQL est une option prise en charge, pas une exigence. Dans un conteneur, ce fichier a besoin d’un volume monté pour survivre à un redémarrage.

Simple ou Full décrit ce que chaque mode débloque, où cette base de données doit résider et à quel point il est difficile de changer de mode par la suite.

Vous êtes pressé et vous disposez déjà d’un Valkey ou d’un Redis ? La commande docker run unique décrite dans Installer avec Docker démarre une instance sur le port 3000 avec une valeur SECRET générée. Tout le reste de cette page s’applique toujours une fois l’instance démarrée.

  • Images et variantes — quelle image publiée exécuter, et comment fonctionnent les étiquettes de version.
  • Installer avec Docker — les deux piles Compose livrées avec le projet.
  • Installer sur Linux — une installation sur machine physique sous Debian ou Ubuntu. Aucune autre famille de distributions n’est couverte par les tests d’installation du projet.
  • Exécuter en tant que service — les unités systemd livrées dans le dépôt, et le lanceur Procfile pour les hôtes sans systemd.
  • Proxy inverse et TLS — l’application ne termine jamais le TLS, un proxy placé devant elle est donc présupposé. Lisez cette page avant d’exposer l’instance.
  • Vérifier votre installation — assurez-vous que l’instance fonctionne réellement avant de la confier à quiconque, puis créez le premier compte : le rôle d’opérateur du site s’attribue uniquement depuis la CLI.

Vous mettez à niveau une installation existante ? Les guides de mise à niveau répertorient les guides disponibles, du plus récent au plus ancien. Commencez par le premier guide qui suit la version que vous exécutez actuellement et avancez dans l’ordre, en lisant les notes de version de chaque version intermédiaire.

Recommandée pour une instance fonctionnant en mode d’authentification simple :

  • 2 cœurs de processeur ou plus
  • 2 Go de RAM ou plus
  • 10 Go d’espace disque ou plus

Un déploiement en mode full qui exécute également PostgreSQL, le worker d’arrière-plan et le planificateur nécessite environ le double.

Certaines tâches d’administration n’ont pas d’écran dans l’application et s’effectuent depuis la ligne de commande de l’instance.

Le transfert d’une organisation à un nouveau propriétaire est la principale. Les propriétaires d’organisation n’ont ni écran ni point de terminaison pour cela, c’est donc à vous d’effectuer le transfert. Utilisez la commande ci-dessous. Pour l’automatisation, l’API Colonel expose la même opération à POST /api/colonel/organizations/:org_id/transfer-ownership ; elle requiert le rôle colonel, prend le nom de l’organisation comme confirmation et s’applique immédiatement, sans aperçu.

Fenêtre de terminal
bin/ots org transfer-ownership ORG NEW_OWNER

ORG est l’identifiant public de l’organisation (extid, celui qu’affiche la CLI) ou son identifiant interne (objid). NEW_OWNER est une adresse e-mail, l’extid d’un client ou un identifiant de compte Rodauth, et cette personne doit déjà être un membre actif : la commande ne crée jamais de client, exécutez donc bin/ots memberships add ORG CUSTOMER au préalable si ce n’est pas le cas.

Exécutée sans --yes, la commande planifie le transfert avant de toucher à quoi que ce soit : elle affiche qui perd la propriété, combien d’adhésions de propriétaire seraient rétrogradées et vers quel rôle, puis vous demande de confirmer. Répondre n est la façon de prévisualiser un transfert. Les options sont --demote-to ROLE (n’importe quel rôle d’adhésion sauf owner, par défaut admin), --yes (ou -y et -f) et --json.

Le propriétaire sortant est rétrogradé, pas supprimé. L’opération promeut le nouveau propriétaire avant de rétrograder l’ancien — la protection contre l’absence de propriétaire refuse tout autre ordre — de sorte que, pendant la durée de ces deux écritures, l’organisation compte deux adhésions de propriétaire et bin/ots org doctor signale la vérification 4 (membership_role_sync) comme un avertissement. Si un transfert est interrompu dans cet intervalle, relancez la commande de transfert, et non org doctor. Le transfert est idempotent et rétrograde tous les autres propriétaires ; org doctor marque cette vérification repairable: false et ne la corrige pas.

Le pendant de tout ceci côté utilisateur est la page Propriété et transfert, que vos utilisateurs auront lue avant de vous solliciter.