Déploiement Standard Linux

Cet article vous guidera à travers la procédure pour installer et déployer Bitwarden sur votre propre serveur Linux. Bitwarden peut également être installé et déployé sur des machines Windows. Veuillez consulter la documentation de soutien à la libération du logiciel Bitwarden.

Ce qui suit est un résumé de la procédure d'installation dans cet article. Les liens dans cette section vous dirigeront vers des sections détaillées sur la procédure d'installation :

1. Configurez votre domaine . Définissez les enregistrements DNS pour un nom de domaine pointant vers votre machine, et ouvrez les ports 80 et 443 sur la machine.

2. Installez Docker et Docker Compose sur votre machine.

3. Créez un utilisateur et un répertoire Bitwarden à partir desquels terminer l'installation.

4. Récupérez un identifiant et une clé d'installation à partir de https://bitwarden.com/host pour utilisation dans l'installation.

   Pour plus d'informations, voir À quoi servent mon identifiant d'installation et ma clé d'installation ?

5. Installez Bitwarden sur votre ordinateur.

6. Configurez votre environnement en ajustant les paramètres dans ./bwdata/env/global.override.env .

   pointe

   Au minimum, configurez les variables globalSettings__mail__smtp... pour mettre en place un serveur de courriel pour inviter et vérifier les utilisateurs.

7. Démarrez votre instance .

8. Testez votre installation en ouvrant votre domaine configuré dans un navigateur web.

9. Une fois déployé, nous recommandons régulièrement de sauvegarder votre serveur et de vérifier les mises à jour du système.

Par défaut, Bitwarden sera servi via les ports 80 (http) et 443 (https) sur la machine hôte. Ouvrez ces ports afin que Bitwarden puisse être accessible depuis l'intérieur et/ou l'extérieur du réseau. Vous pouvez choisir différents ports lors de l'installation.

Nous recommandons de configurer un nom de domaine avec des enregistrements DNS qui pointent vers votre machine hôte (par exemple, bitwarden.example.com), surtout si vous servez Bitwarden sur Internet.

Bitwarden sera déployé et exécuté sur votre machine en utilisant un ensemble de conteneurs Docker. Bitwarden peut être exécuté avec n'importe quelle édition ou plan Docker. Évaluez quelle édition est la meilleure pour votre installation.

Le déploiement de conteneurs est orchestré en utilisant Docker Compose. Certaines installations Docker, y compris Docker pour macOS, sont livrées avec Docker Compose déjà installé.

Installez Docker et Docker Compose sur votre machine avant de procéder à l'installation. Reportez-vous à la documentation Docker suivante pour obtenir de l'aide :

• Installez Docker Engine

• Installez Docker Compose

Nous recommandons de configurer votre serveur Linux avec un bitwarden compte de service dédié, à partir duquel installer et exécuter Bitwarden. Ce faisant, votre instance Bitwarden sera isolée des autres applications en cours d'exécution sur votre serveur.

Ces étapes sont les meilleures pratiques recommandées par Bitwarden, mais ne sont pas obligatoires. Pour plus d'informations, consultez la documentation de Docker sur les Étapes post-installation pour Linux.

1. Créez un utilisateur Bitwarden :

   Bash
   sudo adduser bitwarden

2. Définir le mot de passe pour l'utilisateur Bitwarden (mot de passe fort) :

   Bash
   sudo passwd bitwarden

3. Créez un groupe Docker (s'il n'existe pas déjà) :

   Bash
   sudo groupadd docker

4. Ajoutez l'utilisateur Bitwarden au groupe docker :

   Bash
   sudo usermod -aG docker bitwarden

5. Créez un répertoire Bitwarden :

   Bash
   sudo mkdir /opt/bitwarden

6. Définissez les autorisations pour le répertoire /opt/bitwarden :

   Bash
   sudo chmod -R 700 /opt/bitwarden

7. Définissez l'utilisateur de Bitwarden comme propriétaire du répertoire /opt/bitwarden :

   Bash
   sudo chown -R bitwarden:bitwarden /opt/bitwarden

Bitwarden fournit un script shell pour une installation facile sur Linux et Windows (PowerShell). Suivez les étapes suivantes pour installer Bitwarden en utilisant le script shell :

1. Téléchargez le script d'installation de Bitwarden (bitwarden.sh) sur votre machine :

   Bash
   curl -Lso bitwarden.sh "https://func.bitwarden.com/api/dl/?app=self-host&platform=linux" && chmod 700 bitwarden.sh

2. Exécutez le script d'installation. Un répertoire ./bwdata sera créé par rapport à l'emplacement de bitwarden.sh.

   Bash
   ./bitwarden.sh install

3. Complétez les instructions dans l'installateur :

   • Entrez le nom de domaine pour votre instance Bitwarden :

     Typiquement, cette valeur devrait être l'enregistrement DNS configuré.

   • Voulez-vous utiliser Let's Encrypt pour générer un certificat SSL gratuit ? (o/n) :

     Spécifiez y pour générer un certificat SSL de confiance en utilisant Let's Encrypt. On vous demandera de saisir une adresse de courriel pour les rappels d'expiration de Let's Encrypt. Pour plus d'informations, voir Options de Certificat.

     Alternativement, spécifiez n et utilisez l'option Avez-vous un certificat SSL à utiliser ?.

   • Entrez votre identifiant d'installation :

     Récupérez un identifiant d'installation en utilisant un courriel valide à https://bitwarden.com/host. Pour plus d'informations, voir à quoi servent mon identifiant d'installation et ma clé d'installation ?

   • Entrez votre clé d'installation :

     Récupérez une clé d'installation en utilisant un courriel valide à https://bitwarden.com/host. Pour plus d'informations, voir À quoi servent mon identifiant d'installation et ma clé d'installation ?

   • Avez-vous un certificat SSL à utiliser ? (o/n):

     Si vous avez déjà votre propre certificat SSL, spécifiez y et placez les fichiers nécessaires dans le répertoire ./bwdata/ssl/votre.domaine. On vous demandera si c'est un certificat SSL de confiance (o/n). Pour plus d'informations, voir Options de Certificat.

     Alternativement, spécifiez n et utilisez l'option certificat SSL auto-signé ?, qui est seulement recommandée à des fins de test.

   • Voulez-vous générer un certificat SSL auto-signé ? (o/n) :

     Spécifiez y pour que Bitwarden génère un certificat auto-signé pour vous. Cette option est uniquement recommandée pour les tests. Pour plus d'informations, voir Options de Certificat.

     Si vous spécifiez n, votre instance n'utilisera pas de certificat SSL et vous devrez mettre en avant votre installation avec un proxy HTTPS, sinon les applications Bitwarden ne fonctionneront pas correctement.

La configuration de votre environnement peut impliquer des modifications sur deux fichiers ; un fichier de variables d'environnement et un fichier d'installation :

Variables d'environnement (requis)

Certaines fonctionnalités de Bitwarden ne sont pas configurées par le script bitwarden.sh. Configurez ces paramètres en éditant le fichier d'environnement, situé à ./bwdata/env/global.override.env. Au minimum, vous devriez remplacer les valeurs pour :

Bash
...
globalSettings__mail__smtp__host=<placeholder>
globalSettings__mail__smtp__port=<placeholder>
globalSettings__mail__smtp__ssl=<placeholder>
globalSettings__mail__smtp__username=<placeholder>
globalSettings__mail__smtp__password=<placeholder>
...
adminSettings__admins=
...

Remplacez les espaces réservés globalSettings__mail__smtp...= pour vous connecter au serveur de courrier SMTP qui sera utilisé pour envoyer des courriels de vérification aux nouveaux utilisateurs et inviter des organisations. Ajouter une adresse de courriel à adminSettings__admins= permettra d'accéder au Portail de l'Administrateur Système.

Après avoir édité global.override.env, exécutez la commande suivante pour appliquer vos modifications :

Bash
./bitwarden.sh restart

Fichier d'installation

Le script d'installation de Bitwarden utilise les paramètres dans ./bwdata/config.yml pour générer les actifs nécessaires à l'installation. Certains scénarios d'installation (comme les installations derrière un proxy avec des ports alternatifs) peuvent nécessiter des ajustements à config.yml qui n'ont pas été fournis lors de l'installation standard.

Éditer config.yml selon les besoins et appliquer vos modifications en exécutant :

Bash
./bitwarden.sh rebuild

Une fois que vous avez terminé toutes les étapes précédentes, démarrez votre instance Bitwarden :

Bash
./bitwarden.sh start

Vérifiez que tous les conteneurs fonctionnent correctement :

Bash
docker ps

Félicitations ! Bitwarden est maintenant opérationnel à l'adresse https://your.domain.com. Visitez le coffre web dans votre navigateur web pour confirmer qu'il fonctionne.

Vous pouvez maintenant enregistrer un nouveau compte et vous connecter. Vous devrez avoir configuré les variables d'environnement smtp (voir Variables d'Environnement) afin de vérifier le courriel pour votre nouveau compte.

• Si vous prévoyez d'auto-héberger une organisation Bitwarden, consultez auto-héberger une organisation pour commencer.

• Pour plus d'informations, consultez les FAQ sur l'auto-hébergement.

Le script d'installation de Bitwarden (bitwarden.sh ou bitwarden.ps1) a les commandes suivantes disponibles :