Repository navigation
Installation documentation Dokumentation zur Installation
To install and run BetterBahn, please follow the respective steps for your operating system.
Note
There is no installation documentation for BetterBahn on macOS yet.
Linux Installation Guide
This guide will help you install and run BetterBahn on Linux using Docker. We'll explain every step in detail, assuming you're new to using the command line.
- A Linux distribution (Ubuntu, Fedora, etc.)
- Docker installed on your system. If not, follow the instructions at https://docs.docker.com/engine/install/ for your distribution.
- Docker Compose (usually included with Docker, or install separately if needed).
- Ensure Docker is running: Open a terminal and run
sudo systemctl start docker(if using systemd).
-
Open a Terminal:
- Press Ctrl+Alt+T (on most Linux distributions) to open a terminal window.
- If that doesn't work, look for "Terminal" in your applications menu.
-
Download the Docker Compose File:
-
In the terminal, type the following command and press Enter:
curl -o docker-compose.yaml https://raw.githubusercontent.com/l2xu/betterbahn/main/docker-compose/docker-compose.yaml
This will download the file to your current directory (usually your home folder).
-
If curl is not installed, you can install it with
sudo apt install curl(on Ubuntu/Debian) or equivalent for your distribution. -
Alternatively, download it manually:
- Open your web browser and go to https://raw.githubusercontent.com/l2xu/betterbahn/main/docker-compose/docker-compose.yaml.
- Right-click on the page and select "Save Link As..." to save the file as
docker-compose.yamlin a folder you can easily find, like your Downloads or Desktop.
-
-
Navigate to the Folder (if downloaded manually):
-
If you downloaded the file to a specific folder, you need to go to that folder in the terminal.
-
For example, if it's in your Downloads folder, type:
cd Downloadsand press Enter.
-
To see what's in the current folder, type
lsand press Enter.
-
-
Run the Application:
-
In the terminal, type:
docker compose up -d
and press Enter.
-
You might need to run it with sudo:
sudo docker compose up -d -
This command will pull the necessary Docker image and start the application in the background. It might take a few minutes the first time.
-
-
Access the Application:
- Open your web browser (like Firefox or Chrome).
- In the address bar, type http://localhost:3000 and press Enter.
- The BetterBahn application should load.
-
Stop the Application (when needed):
-
To stop the application, go back to the terminal and type:
docker compose down
(or
sudo docker compose down) and press Enter.
-
- If you get permission errors, try running the commands with
sudo. - If Docker is not running, start it with
sudo systemctl start docker(on systems with systemd). - If port 3000 is already in use, you can change the port mapping in the
docker-compose.yamlfile. - If a command doesn't work, make sure you're typing it exactly as shown, including spaces.
- To close the terminal, type
exitand press Enter.
Windows Installation Guide
This guide will help you install and run BetterBahn on Windows using Docker Desktop. We'll explain every step in detail, assuming you're new to using the command line.
- Windows 10 or later (64-bit)
- Docker Desktop for Windows installed. You can download it from https://www.docker.com/products/docker-desktop.
- Ensure Docker Desktop is running and configured to use Linux containers (default).
-
Open Command Prompt:
- Press the Windows key on your keyboard (usually between Ctrl and Alt).
- Type "cmd" and press Enter.
- A black window called "Command Prompt" should open. This is where you'll type commands.
-
Download the Docker Compose File:
-
In the Command Prompt window, type the following command and press Enter:
curl -o docker-compose.yaml https://raw.githubusercontent.com/l2xu/betterbahn/main/docker-compose/docker-compose.yaml
This will download the file to your current directory (usually your user folder).
-
If curl doesn't work, you can download it manually:
- Open your web browser and go to https://raw.githubusercontent.com/l2xu/betterbahn/main/docker-compose/docker-compose.yaml.
- Right-click on the page and select "Save as..." to save the file as
docker-compose.yamlin a folder you can easily find, like your Desktop or Documents.
-
-
Navigate to the Folder (if downloaded manually):
-
If you downloaded the file to a specific folder, you need to go to that folder in Command Prompt.
-
For example, if it's on your Desktop, type:
cd Desktopand press Enter.
-
To see what's in the current folder, type
dirand press Enter.
-
-
Run the Application:
-
In the Command Prompt, type:
docker compose up -d
and press Enter.
-
This command will pull the necessary Docker image and start the application in the background. It might take a few minutes the first time.
-
-
Access the Application:
- Open your web browser (like Chrome, Edge, or Firefox).
- In the address bar, type http://localhost:3000 and press Enter.
- The BetterBahn application should load.
-
Stop the Application (when needed):
-
To stop the application, go back to the Command Prompt and type:
docker compose down
and press Enter.
-
- If you encounter issues with Docker, ensure that Docker Desktop is running and that virtualization is enabled in your BIOS.
- For Windows Home edition, you might need to enable WSL2. Follow the instructions on the Docker Desktop website.
- If port 3000 is already in use, you can change the port mapping in the
docker-compose.yamlfile. - If a command doesn't work, make sure you're typing it exactly as shown, including spaces.
- To close Command Prompt, type
exitand press Enter.
Um BetterBahn zu installieren und auszuführen, folge bitte den Schritten für dein Betriebssystem.
Note
Es gibt aktuell noch keine Installationsanleitung für macOS.
Linux-Installationsanleitung
Diese Anleitung hilft Ihnen, BetterBahn auf Linux mit Docker zu installieren und auszuführen. Wir erklären jeden Schritt im Detail, als ob Sie neu bei der Befehlszeile sind.
- Eine Linux-Distribution (Ubuntu, Fedora, etc.)
- Docker auf Ihrem System installiert. Falls nicht, folgen Sie den Anweisungen unter https://docs.docker.com/engine/install/ für Ihre Distribution.
- Docker Compose (normalerweise mit Docker enthalten, oder separat installieren falls nötig).
- Stellen Sie sicher, dass Docker läuft: Öffnen Sie ein Terminal und führen Sie
sudo systemctl start dockeraus (falls systemd verwendet wird).
-
Ein Terminal öffnen:
- Drücken Sie Strg+Alt+T (auf den meisten Linux-Distributionen), um ein Terminalfenster zu öffnen.
- Falls das nicht funktioniert, suchen Sie nach "Terminal" in Ihrem Anwendungsmenü.
-
Docker Compose-Datei herunterladen:
-
Im Terminal geben Sie den folgenden Befehl ein und drücken Enter:
curl -o docker-compose.yaml https://raw.githubusercontent.com/l2xu/betterbahn/main/docker-compose/docker-compose.yaml
Dies lädt die Datei in Ihr aktuelles Verzeichnis herunter (normalerweise Ihr Home-Ordner).
-
Falls curl nicht installiert ist, können Sie es mit
sudo apt install curl(auf Ubuntu/Debian) oder entsprechend für Ihre Distribution installieren. -
Alternativ manuell herunterladen:
- Öffnen Sie Ihren Webbrowser und gehen Sie zu https://raw.githubusercontent.com/l2xu/betterbahn/main/docker-compose/docker-compose.yaml.
- Rechtsklicken Sie auf die Seite und wählen Sie "Link speichern unter...", um die Datei als
docker-compose.yamlin einem leicht zu findenden Ordner zu speichern, z.B. Downloads oder Desktop.
-
-
In den Ordner navigieren (falls manuell heruntergeladen):
-
Falls Sie die Datei in einen bestimmten Ordner heruntergeladen haben, müssen Sie in der Eingabeaufforderung dorthin gehen.
-
Zum Beispiel, falls sie in Ihrem Downloads-Ordner ist, geben Sie ein:
cd Downloadsund drücken Enter.
-
Um zu sehen, was im aktuellen Ordner ist, geben Sie
lsein und drücken Enter.
-
-
Anwendung ausführen:
-
Im Terminal geben Sie ein:
docker compose up -d
und drücken Enter.
-
Möglicherweise müssen Sie es mit sudo ausführen:
sudo docker compose up -d -
Dieser Befehl lädt das erforderliche Docker-Image herunter und startet die Anwendung im Hintergrund. Beim ersten Mal kann es einige Minuten dauern.
-
-
Anwendung aufrufen:
- Öffnen Sie Ihren Webbrowser (z.B. Firefox oder Chrome).
- Geben Sie in die Adressleiste http://localhost:3000 ein und drücken Enter.
- Die BetterBahn-Anwendung sollte laden.
-
Anwendung stoppen (falls erforderlich):
-
Um die Anwendung zu stoppen, gehen Sie zurück zum Terminal und geben ein:
docker compose down
(oder
sudo docker compose down) und drücken Enter.
-
- Falls Sie Berechtigungsfehler erhalten, versuchen Sie die Befehle mit
sudoauszuführen. - Falls Docker nicht läuft, starten Sie es mit
sudo systemctl start docker(auf Systemen mit systemd). - Falls Port 3000 bereits verwendet wird, können Sie die Port-Zuordnung in der
docker-compose.yaml-Datei ändern. - Falls ein Befehl nicht funktioniert, stellen Sie sicher, dass Sie ihn genau so eingeben, wie gezeigt, inklusive Leerzeichen.
- Um das Terminal zu schließen, geben Sie
exitein und drücken Enter.
Windows-Installationsanleitung
Diese Anleitung hilft Ihnen, BetterBahn auf Windows mit Docker Desktop zu installieren und auszuführen. Wir erklären jeden Schritt im Detail, als ob Sie neu bei der Befehlszeile sind.
- Windows 10 oder neuer (64-Bit)
- Docker Desktop für Windows installiert. Sie können es von https://www.docker.com/products/docker-desktop herunterladen.
- Stellen Sie sicher, dass Docker Desktop läuft und für die Verwendung von Linux-Containern konfiguriert ist (Standard).
-
Eingabeaufforderung öffnen:
- Drücken Sie die Windows-Taste auf Ihrer Tastatur (normalerweise zwischen Strg und Alt).
- Geben Sie "cmd" ein und drücken Sie Enter.
- Ein schwarzes Fenster namens "Eingabeaufforderung" sollte sich öffnen. Hier geben Sie die Befehle ein.
-
Docker Compose-Datei herunterladen:
-
Im Eingabeaufforderungsfenster geben Sie den folgenden Befehl ein und drücken Enter:
curl -o docker-compose.yaml https://raw.githubusercontent.com/l2xu/betterbahn/main/docker-compose/docker-compose.yaml
Dies lädt die Datei in Ihr aktuelles Verzeichnis herunter (normalerweise Ihr Benutzerordner).
-
Falls curl nicht funktioniert, können Sie sie manuell herunterladen:
- Öffnen Sie Ihren Webbrowser und gehen Sie zu https://raw.githubusercontent.com/l2xu/betterbahn/main/docker-compose/docker-compose.yaml.
- Rechtsklicken Sie auf die Seite und wählen Sie "Speichern unter...", um die Datei als
docker-compose.yamlin einem leicht zu findenden Ordner zu speichern, z.B. Desktop oder Dokumente.
-
-
In den Ordner navigieren (falls manuell heruntergeladen):
-
Falls Sie die Datei in einen bestimmten Ordner heruntergeladen haben, müssen Sie in der Eingabeaufforderung dorthin gehen.
-
Zum Beispiel, falls sie auf Ihrem Desktop ist, geben Sie ein:
cd Desktopund drücken Enter.
-
Um zu sehen, was im aktuellen Ordner ist, geben Sie
direin und drücken Enter.
-
-
Anwendung ausführen:
-
In der Eingabeaufforderung geben Sie ein:
docker compose up -d
und drücken Enter.
-
Dieser Befehl lädt das erforderliche Docker-Image herunter und startet die Anwendung im Hintergrund. Beim ersten Mal kann es einige Minuten dauern.
-
-
Anwendung aufrufen:
- Öffnen Sie Ihren Webbrowser (z.B. Chrome, Edge oder Firefox).
- Geben Sie in die Adressleiste http://localhost:3000 ein und drücken Enter.
- Die BetterBahn-Anwendung sollte laden.
-
Anwendung stoppen (falls erforderlich):
-
Um die Anwendung zu stoppen, gehen Sie zurück zur Eingabeaufforderung und geben ein:
docker compose down
und drücken Enter.
-
- Falls Sie Probleme mit Docker haben, stellen Sie sicher, dass Docker Desktop läuft und dass die Virtualisierung in Ihrem BIOS aktiviert ist.
- Bei Windows Home Edition müssen Sie möglicherweise WSL2 aktivieren. Folgen Sie den Anweisungen auf der Docker Desktop-Website.
- Falls Port 3000 bereits verwendet wird, können Sie die Port-Zuordnung in der
docker-compose.yaml-Datei ändern. - Falls ein Befehl nicht funktioniert, stellen Sie sicher, dass Sie ihn genau so eingeben, wie gezeigt, inklusive Leerzeichen.
- Um die Eingabeaufforderung zu schließen, geben Sie
exitein und drücken Enter.