Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

guides: deployment: add doc about ROOT_URL #199

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions content/docs/guides/deploy/docker-compose/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
13 changes: 11 additions & 2 deletions content/docs/guides/deploy/docker-compose/_index.fr.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
Loading