diff --git a/content/docs/guides/deploy/docker-compose/_index.en.md b/content/docs/guides/deploy/docker-compose/_index.en.md index 6c43edfbd..50997343b 100644 --- a/content/docs/guides/deploy/docker-compose/_index.en.md +++ b/content/docs/guides/deploy/docker-compose/_index.en.md @@ -5,7 +5,14 @@ weight: 10 description: Using docker compose for single node deployment --- -The OSRD project includes a `docker-compose.yml` file designed to facilitate the deployment of a fully functional OSRD environment. Primarily intended for development purposes, this Docker Compose configuration can also be adapted for quick, single-node deployments. +The OSRD project includes a `docker-compose.yml` file designed to facilitate the deployment of a fully functional OSRD environment. +Only intended for development purposes, this Docker Compose configuration could be adapted for quick, single-node deployments. + +{{% alert title="Disclaimer" color="warning"%}} +This setup is designed for development only. +For example no authentication is supported and the front-end is served in development mode (rebuilt on the fly). +If you mean to deploy a production ready version of OSRD, please follow the [Kubernetes-based deployment](../kubernetes/) +{{% /alert %}} ## Prerequisites @@ -30,7 +37,9 @@ Each service is configured with health checks, volume mounts and necessary envir ## Deployment Steps 1. **Clone the Repository**: First, clone the OSRD repository to your local machine. -2. **Environment Variables** (optional): Set necessary environment variables if you need to adjust some configurations. +2. **Configuration**: The default configuration requires setting an environment variable for the Editoast service: `ROOT_URL`. + It should be set to the URL pointing to the Editoast service through the gateway. For example, "http://your-domain.com/api". + You can also adjust other environment variables if needed. 3. **Build and Run**: Navigate to the directory containing `docker-compose.yml` and run: ```bash diff --git a/content/docs/guides/deploy/docker-compose/_index.fr.md b/content/docs/guides/deploy/docker-compose/_index.fr.md index 3f74a0bfe..7b42932b5 100644 --- a/content/docs/guides/deploy/docker-compose/_index.fr.md +++ b/content/docs/guides/deploy/docker-compose/_index.fr.md @@ -5,7 +5,14 @@ weight: 10 description: Utiliser docker compose pour un déploiement sur un seul nœud --- -Le projet OSRD inclut un fichier docker-compose.yml conçu pour faciliter le déploiement d'un environnement OSRD pleinement fonctionnel. Initialement destiné à des fins de développement, ce Docker Compose peut également être adapté pour des déploiements rapides sur un seul nœud. +Le projet OSRD inclut un fichier docker-compose.yml conçu pour faciliter le déploiement d'un environnement OSRD pleinement fonctionnel. +Exclusivement destiné à des fins de développement, cette configuration Docker Compose pourrait être adaptée pour des déploiements rapides sur un seul nœud. + +{{% alert title="Avertissement" color="warning"%}} +Cette configuration est prévue seulement à des fins de développement. +Par exemple, aucune authentification n'est prise en charge et le front-end est déployé en mode développement (reconstruit à la volée). +Si vous souhaitez déployer une version d'OSRD dédiée à un environment de production, veuillez suivre le [déploiement via Kubernetes](../kubernetes/) +{{% /alert %}} ## Prérequis @@ -31,7 +38,9 @@ Chaque service est configuré avec des contrôles de santé, des montages de vol ## Étapes du déploiement 1. **Cloner le dépôt** : Tout d'abord, clonez le dépôt OSRD sur votre machine locale. -2. **Variables d'environnement** (facultatif) : Définissez les variables d'environnement nécessaires si vous devez ajuster certaines configurations. +2. **Configuration** : La configuration par défaut nécessite le renseignement d'une variable d'environnement pour le service Editoast: `ROOT_URL`. +Il faut lui donner la valeur de l'URL qui pointe vers le service Editoast par la passerelle. Par exemple "http://your-domain.com/api". +Vous pouvez également ajuster d'autres variables d'environnement si nécessaire. 3. **Construire et exécuter** : Naviguez vers le répertoire contenant `docker-compose.yml` et exécutez : ```bash