Skip to content

Commit

Permalink
docs: deployment: specify that docker deployment is unsafe for produc…
Browse files Browse the repository at this point in the history
…tion
  • Loading branch information
Castavo committed Sep 11, 2024
1 parent ae731a9 commit 4352e04
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
9 changes: 8 additions & 1 deletion 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 Down
9 changes: 8 additions & 1 deletion 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 Down

0 comments on commit 4352e04

Please sign in to comment.