Déployer Devolutions Server avec Docker

Cet article explique comment déployer Devolutions Server à l'aide de Docker.

Par souci de simplicité, la version de l'image Docker de Devolutions Server est écrite 20XX.X dans les blocs de code de cet article. Modifiez cette variable selon la version que vous souhaitez utiliser.

Prérequis

• Docker version 20.10.X ou ultérieure. Sur macOS ARM64, utilisez --platform linux/amd64 durant la phase d'initialisation en raison de la compatibilité des assemblages. Le mode d'exécution fonctionne nativement sur ARM64.
• Une instance SQL Server correctement configurée pour Devolutions Server.
• Les exigences système minimales pour exécuter Devolutions Server.

Windows

Configuration initiale de Devolutions Server

1. Créez une connexion et une base de données dédiées à l'aide d'un compte administrateur (par exemple, sa ou un administrateur Azure SQL). Accordez un accès de moindre privilège à Devolutions Server.
2. Téléchargez la dernière image Docker de Devolutions Server :

   docker pull devolutions/devolutions-server:release-20XX.X

3. Exécutez Devolutions Server en mode initialisation pour créer le schéma de base de données et son premier administrateur, générer les clés de chiffrement et configurer HTTPS avec un certificat auto-signé. Enregistrez App_Data afin que la configuration de chiffrement puisse être récupérée à l'étape suivante.

docker volume create dvls-init-data

docker run --rm `
  -e DATABASE_HOST=your-sql-server.database.windows.net `
  -e DATABASE_NAME=dvls `
  -e DATABASE_USERNAME=dvls_user `
  -e DATABASE_PASSWORD='YourSecurePassword!' `
  -e HOSTNAME=localhost `
  -e WEB_SCHEME=https `
  -e PORT=5000 `
  -e DVLS_INIT=true `
  -v dvls-init-data:/opt/devolutions/dvls/App_Data `
  -p 5000:5000 `
  devolutions/devolutions-server:release-20XX.X

1. Extrayez encryption.config du volume d'initialisation :

   docker run --rm `
     -v dvls-init-data:/data `
     alpine `
     cat /data/encryption.config

2. Convertissez le fichier extrait en base64 et conservez-le de façon sécuritaire, car il sera nécessaire à chaque démarrage en mode d'exécution :

   docker run --rm `
     -v dvls-init-data:/data `
     alpine `
     cat /data/encryption.config > $env:TEMP\encryption.config
   
   $content = Get-Content -Path "$env:TEMP\encryption.config" -Raw
   $bytes = [System.Text.Encoding]::UTF8.GetBytes($content)
   $base64 = [System.Convert]::ToBase64String($bytes)
   $base64 | Out-File -FilePath "$env:TEMP\encryption.config.b64" -NoNewline -Encoding ASCII

3. Démarrez Devolutions Server en utilisant la configuration de chiffrement en base64. Une fois cela fait, utilisez les commandes docker ps et docker logs dvls-server pour vous assurer que tout fonctionne correctement.

   $encryptionConfig = Get-Content "$env:TEMP\encryption.config.b64" -Raw
   
   docker run -d --name dvls-server `
     -e DATABASE_HOST=your-sql-server.database.windows.net `
     -e DATABASE_NAME=dvls `
     -e DATABASE_USERNAME=dvls_user `
     -e DATABASE_PASSWORD='YourSecurePassword!' `
     -e HOSTNAME=localhost `
     -e WEB_SCHEME=https `
     -e PORT=5000 `
     -e DVLS_ENCRYPTION_CONFIG_B64="$encryptionConfig" `
     -p 5000:5000 `
     devolutions/devolutions-server:release-20XX.X

4. Accédez à l'interface Web en ouvrant https://localhost:5000 dans votre navigateur. Passez outre l'avertissement de sécurité du certificat auto-signé en cliquant sur Avancé – Continuer. Vous pourrez monter un certificat TSL personnalisé plus tard.
5. Connectez-vous en utilisant dvls-admin comme nom d'utilisateur et mot de passe.

Immédiatement après la connexion, changez le mot de passe par défaut en vous rendant dans Administration – Utilisateurs, en cliquant sur le bouton de points de suspension verticaux de l'utilisateur dvls-admin, puis en sélectionnant Changer le mot de passe.

1. Assurez-vous que Devolutions Server fonctionne avec DVLS_ENCRYPTION_CONFIG_B64, que son interface web est accessible et que encryption.config.b64 est enregistré dans un emplacement sécuritaire (il est nécessaire à chaque redémarrage et redéploiement). Une fois cela fait, le volume d'initialisation temporaire peut être supprimé en toute sécurité :

   docker volume rm dvls-init-data

Modes de fonctionnement

Le conteneur Docker DVLS fonctionne selon trois modes distincts :

Mode	Variable d'environnement	Objectif	Comportement
Exécution (par défaut)	Aucune variable spéciale	Fonctionnement normal	Démarre le serveur web et continue de fonctionner.
Initialisation	DVLS_INIT=true	Configuration initiale	Crée le schéma de base de données et l'utilisateur administrateur, puis se termine.
Mise à jour	DVLS_UPDATE_MODE=true	Mise à niveau de la base de données	Sauvegarde les fichiers de configuration, migre la base de données, puis se termine.

Les modes Initialisation et Mise à jour sont mutuellement exclusifs.

Port personnalisé

Modifiez le port sur lequel Devolutions Server écoute en définissant la variable d'environnement PORT, par exemple avec le port 8080 comme dans l'exemple ci-dessous :

docker run -d --name dvls-server `
  -e DATABASE_HOST=your-sql-server.database.windows.net `
  -e DATABASE_NAME=dvls `
  -e DATABASE_USERNAME=dvls_user `
  -e DATABASE_PASSWORD='YourSecurePassword!' `
  -e HOSTNAME=localhost `
  -e WEB_SCHEME=https `
  -e PORT=8080 `
  -p 8080:8080 `
  devolutions/devolutions-server:release-20XX.X

Monter un certificat TSL personnalisé

Montez vos propres fichiers de certificat plutôt que d'utiliser le certificat auto-signé généré automatiquement :

mkdir -p /host/path/certs
cp /path/to/server.pem /host/path/certs/
cp /path/to/server.key /host/path/certs/

docker run -d --name dvls-server `
  -e DATABASE_HOST=your-sql-server.database.windows.net \
  -e DATABASE_NAME=dvls `
  -e DATABASE_USERNAME=dvls_user `
  -e DATABASE_PASSWORD='YourSecurePassword!' `
  -e HOSTNAME=devolutions-server.company.com `
  -e WEB_SCHEME=https `
  -e PORT=5000 `
  -e TLS_CERTIFICATE_FILE=/opt/devolutions/dvls/certs/server.pem `
  -e TLS_PRIVATE_KEY_FILE=/opt/devolutions/dvls/certs/server.key `
  -p 5000:5000 `
  -v /host/path/certs:/opt/devolutions/dvls/certs:ro `
  devolutions/devolutions-server:release-20XX.X

Gestion des conteneurs

Commandes	Fonctions
docker start dvls-server	Démarre le conteneur.
docker stop dvls-server	Arrête le conteneur.
docker rm dvls-server	Supprime le conteneur.

La suppression du conteneur est sécuritaire dans la mesure où vous possédez le fichier encryption.config.b64, l'accès à votre base de données SQL Server et la documentation de vos variables d'environnement.

macOS

Configuration initiale de Devolutions Server

1. Créez une connexion et une base de données dédiées à l'aide d'un compte administrateur (par exemple, sa ou un administrateur Azure SQL). Accordez un accès de moindre privilège à Devolutions Server.
2. Téléchargez la dernière image Docker de Devolutions Server :

   docker pull devolutions/devolutions-server:release-20XX.X

3. Exécutez Devolutions Server en mode initialisation pour créer le schéma de base de données et son premier administrateur, générer les clés de chiffrement et configurer HTTPS avec un certificat auto-signé. Enregistrez App_Data afin que la configuration de chiffrement puisse être récupérée à l'étape suivante.

Sur macOS, c'est ici qu'il faut ajouter --platform linux/amd64.

docker volume create dvls-init-data

docker run --rm \
  -e DATABASE_HOST=your-sql-server.database.windows.net \
  -e DATABASE_NAME=dvls \
  -e DATABASE_USERNAME=dvls_user \
  -e DATABASE_PASSWORD='YourSecurePassword!' \
  -e HOSTNAME=localhost \
  -e WEB_SCHEME=https \
  -e PORT=5000 \
  -e DVLS_INIT=true \
  -v dvls-init-data:/opt/devolutions/dvls/App_Data \
  -p 5000:5000 \
  devolutions/devolutions-server:release-20XX.X

1. Extrayez encryption.config du volume d'initialisation :

   docker run --rm \
     -v dvls-init-data:/data \
     alpine \
     cat /data/encryption.config

2. Convertissez le fichier extrait en base64 et conservez-le de façon sécuritaire, car il sera nécessaire à chaque démarrage en mode d'exécution :

   docker run --rm \
     -v dvls-init-data:/data \
     alpine \
     cat /data/encryption.config > /tmp/encryption.config
   
   base64 -i /tmp/encryption.config -o /tmp/encryption.config.b64

3. Démarrez Devolutions Server en utilisant la configuration de chiffrement en base64. Une fois cela fait, utilisez les commandes docker ps et docker logs dvls-server pour vous assurer que tout fonctionne correctement :

   docker run -d --name dvls-server \
     -e DATABASE_HOST=your-sql-server.database.windows.net \
     -e DATABASE_NAME=dvls \
     -e DATABASE_USERNAME=dvls_user \
     -e DATABASE_PASSWORD='YourSecurePassword!' \
     -e HOSTNAME=localhost \
     -e WEB_SCHEME=https \
     -e PORT=5000 \
     -e DVLS_ENCRYPTION_CONFIG_B64="$(cat /tmp/encryption.config.b64)" \
     -p 5000:5000 \
     devolutions/devolutions-server:release-20XX.X

4. Accédez à l'interface Web en ouvrant https://localhost:5000 dans votre navigateur. Passez outre l'avertissement de sécurité du certificat auto-signé en cliquant sur Avancé – Continuer. Vous pourrez monter un certificat TSL personnalisé plus tard.
5. Connectez-vous en utilisant dvls-admin comme nom d'utilisateur et mot de passe.

Immédiatement après la connexion, changez le mot de passe par défaut en vous rendant dans Administration – Utilisateurs, en cliquant sur le bouton de points de suspension verticaux de l'utilisateur dvls-admin, puis en sélectionnant Changer le mot de passe.

1. Assurez-vous que Devolutions Server fonctionne avec DVLS_ENCRYPTION_CONFIG_B64, que son interface web est accessible et que encryption.config.b64 est enregistré dans un emplacement sécuritaire (il est nécessaire à chaque redémarrage et redéploiement). Une fois cela fait, le volume d'initialisation temporaire peut être supprimé en toute sécurité :

   docker volume rm dvls-init-data

Modes de fonctionnement

Le conteneur Docker DVLS fonctionne selon trois modes distincts :

Mode	Variable d'environnement	Objectif	Comportement
Exécution (par défaut)	Aucune variable spéciale	Fonctionnement normal	Démarre le serveur web et continue de fonctionner.
Initialisation	DVLS_INIT=true	Configuration initiale	Crée le schéma de base de données et l'utilisateur administrateur, puis se termine.
Mise à jour	DVLS_UPDATE_MODE=true	Mise à niveau de la base de données	Sauvegarde les fichiers de configuration, migre la base de données, puis se termine.

Les modes Initialisation et Mise à jour sont mutuellement exclusifs.

Port personnalisé

Modifiez le port sur lequel Devolutions Server écoute en définissant la variable d'environnement PORT, par exemple avec le port 8080 comme dans l'exemple ci-dessous :

docker run -d --name dvls-server \
  -e DATABASE_HOST=your-sql-server.database.windows.net \
  -e DATABASE_NAME=dvls \
  -e DATABASE_USERNAME=dvls_user \
  -e DATABASE_PASSWORD='YourSecurePassword!' \
  -e HOSTNAME=localhost \
  -e WEB_SCHEME=https \
  -e PORT=8080 \
  -p 8080:8080 \
  devolutions/devolutions-server:release-20XX.X

Monter un certificat TSL personnalisé

Montez vos propres fichiers de certificat plutôt que d'utiliser le certificat auto-signé généré automatiquement :

mkdir -p /host/path/certs
cp /path/to/server.pem /host/path/certs/
cp /path/to/server.key /host/path/certs/

docker run -d --name dvls-server \
  -e DATABASE_HOST=your-sql-server.database.windows.net \
  -e DATABASE_NAME=dvls \
  -e DATABASE_USERNAME=dvls_user \
  -e DATABASE_PASSWORD='YourSecurePassword!' \
  -e HOSTNAME=devolutions-server.company.com \
  -e WEB_SCHEME=https \
  -e PORT=5000 \
  -e TLS_CERTIFICATE_FILE=/opt/devolutions/dvls/certs/server.pem \
  -e TLS_PRIVATE_KEY_FILE=/opt/devolutions/dvls/certs/server.key \
  -p 5000:5000 \
  -v /host/path/certs:/opt/devolutions/dvls/certs:ro \
  devolutions/devolutions-server:release-20XX.X

Gestion des conteneurs

Commandes	Fonctions
docker start dvls-server	Démarre le conteneur.
docker stop dvls-server	Arrête le conteneur.
docker rm dvls-server	Supprime le conteneur.

La suppression du conteneur est sécuritaire dans la mesure où vous possédez le fichier encryption.config.b64, l'accès à votre base de données SQL Server et la documentation de vos variables d'environnement.

Linux

Configuration initiale de Devolutions Server

1. Créez une connexion et une base de données dédiées à l'aide d'un compte administrateur (par exemple, sa ou un administrateur Azure SQL). Accordez un accès de moindre privilège à Devolutions Server.
2. Téléchargez la dernière image Docker de Devolutions Server :

   docker pull devolutions/devolutions-server:release-20XX.X

3. Exécutez Devolutions Server en mode initialisation pour créer le schéma de base de données et son premier administrateur, générer les clés de chiffrement et configurer HTTPS avec un certificat auto-signé. Enregistrez App_Data afin que la configuration de chiffrement puisse être récupérée à l'étape suivante.

docker volume create dvls-init-data

docker run --rm \
  -e DATABASE_HOST=your-sql-server.database.windows.net \
  -e DATABASE_NAME=dvls \
  -e DATABASE_USERNAME=dvls_user \
  -e DATABASE_PASSWORD='YourSecurePassword!' \
  -e HOSTNAME=localhost \
  -e WEB_SCHEME=https \
  -e PORT=5000 \
  -e DVLS_INIT=true \
  -v dvls-init-data:/opt/devolutions/dvls/App_Data \
  -p 5000:5000 \
  devolutions/devolutions-server:release-20XX.X

1. Extrayez encryption.config du volume d'initialisation :

   docker run --rm \
     -v dvls-init-data:/data \
     alpine \
     cat /data/encryption.config

2. Convertissez le fichier extrait en base64 et conservez-le de façon sécuritaire, car il sera nécessaire à chaque démarrage en mode d'exécution :

   docker run --rm \
     -v dvls-init-data:/data \
     alpine \
     cat /data/encryption.config > /tmp/encryption.config
   
   base64 -w 0 /tmp/encryption.config > /tmp/encryption.config.b64

3. Démarrez Devolutions Server en utilisant la configuration de chiffrement en base64. Une fois cela fait, utilisez les commandes docker ps et docker logs dvls-server pour vous assurer que tout fonctionne correctement :

   docker run -d --name dvls-server \
     -e DATABASE_HOST=your-sql-server.database.windows.net \
     -e DATABASE_NAME=dvls \
     -e DATABASE_USERNAME=dvls_user \
     -e DATABASE_PASSWORD='YourSecurePassword!' \
     -e HOSTNAME=localhost \
     -e WEB_SCHEME=https \
     -e PORT=5000 \
     -e DVLS_ENCRYPTION_CONFIG_B64="$(cat /tmp/encryption.config.b64)" \
     -p 5000:5000 \
     devolutions/devolutions-server:release-20XX.X

4. Accédez à l'interface Web en ouvrant https://localhost:5000 dans votre navigateur. Passez outre l'avertissement de sécurité du certificat auto-signé en cliquant sur Avancé – Continuer. Vous pourrez monter un certificat TSL personnalisé plus tard.
5. Connectez-vous en utilisant dvls-admin comme nom d'utilisateur et mot de passe.

Immédiatement après la connexion, changez le mot de passe par défaut en vous rendant dans Administration – Utilisateurs, en cliquant sur le bouton de points de suspension verticaux de l'utilisateur dvls-admin, puis en sélectionnant Changer le mot de passe.

1. Assurez-vous que Devolutions Server fonctionne avec DVLS_ENCRYPTION_CONFIG_B64, que son interface web est accessible et que encryption.config.b64 est enregistré dans un emplacement sécuritaire (il est nécessaire à chaque redémarrage et redéploiement). Une fois cela fait, le volume d'initialisation temporaire peut être supprimé en toute sécurité :

   docker volume rm dvls-init-data

Modes de fonctionnement

Le conteneur Docker DVLS fonctionne selon trois modes distincts :

Mode	Variable d'environnement	Objectif	Comportement
Exécution (par défaut)	Aucune variable spéciale	Fonctionnement normal	Démarre le serveur web et continue de fonctionner.
Initialisation	DVLS_INIT=true	Configuration initiale	Crée le schéma de base de données et l'utilisateur administrateur, puis quitte.
Mise à jour	DVLS_UPDATE_MODE=true	Mise à niveau de la base de données	Sauvegarde les fichiers de configuration, migre la base de données, puis quitte.

Les modes Initialisation et Mise à jour s'excluent mutuellement.

Port personnalisé

Changez le port sur lequel Devolutions Server écoute en définissant la variable d'environnement PORT, par exemple avec le port 8080 comme dans l'exemple ci-dessous :

docker run -d --name dvls-server \
  -e DATABASE_HOST=your-sql-server.database.windows.net \
  -e DATABASE_NAME=dvls \
  -e DATABASE_USERNAME=dvls_user \
  -e DATABASE_PASSWORD='YourSecurePassword!' \
  -e HOSTNAME=localhost \
  -e WEB_SCHEME=https \
  -e PORT=8080 \
  -p 8080:8080 \
  devolutions/devolutions-server:release-20XX.X

Monter un certificat TSL personnalisé

Montez vos propres fichiers de certificat au lieu d'utiliser le certificat auto-signé généré automatiquement :

mkdir -p /host/path/certs
cp /path/to/server.pem /host/path/certs/
cp /path/to/server.key /host/path/certs/

docker run -d --name dvls-server \
  -e DATABASE_HOST=your-sql-server.database.windows.net \
  -e DATABASE_NAME=dvls \
  -e DATABASE_USERNAME=dvls_user \
  -e DATABASE_PASSWORD='YourSecurePassword!' \
  -e HOSTNAME=devolutions-server.company.com \
  -e WEB_SCHEME=https \
  -e PORT=5000 \
  -e TLS_CERTIFICATE_FILE=/opt/devolutions/dvls/certs/server.pem \
  -e TLS_PRIVATE_KEY_FILE=/opt/devolutions/dvls/certs/server.key \
  -p 5000:5000 \
  -v /host/path/certs:/opt/devolutions/dvls/certs:ro \
  devolutions/devolutions-server:release-20XX.X

Gestion des conteneurs

Commandes	Fonctions
docker start dvls-server	Démarre le conteneur.
docker stop dvls-server	Arrête le conteneur.
docker rm dvls-server	Supprime le conteneur.

La suppression du conteneur est sans risque tant que vous disposez du fichier encryption.config.b64, de l'accès à votre base de données SQL Server et de vos variables d'environnement documentées.

Voir aussi

• Liste de vérification de la sécurité
• Déploiement de Devolutions Server sur Azure App Service à l'aide d'un conteneur
• Configuration Docker avancée pour Devolutions Server