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

docs: Add Docker Compose Installation #188

Merged
merged 1 commit into from
Nov 10, 2023
Merged
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
44 changes: 44 additions & 0 deletions docs/installation/3_docker-compose.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
id: docker-compose
title: Installation with Docker Compose
sidebar_label: Docker Compose
---

In this tutorial, we go through the instructions for installing Gladys Assistant with Docker Compose. This tutorial works for any system (Raspberry Pi, Ubuntu VM, Synology NAS).

## Requirements

To install Docker Compose, you must first install Docker. Please refer to [Install Docker documentation](/docs/installation/docker)

### Install Docker Compose

You should install Docker Compose v2 as a Docker plugin. To do so, you can follow the [official documentation](https://docs.docker.com/compose/install/#scenario-two-install-the-compose-plugin)

## Copy/Import the Gladys Docker Compose file descriptor

You can find a Docker Compose file example on our github repository : https://raw.githubusercontent.com/GladysAssistant/Gladys/master/docker/docker-compose.yml

Save this file into a directory on your system.

Things you may want to change:

- `SERVER_PORT: 80` => You can change the default port where the Gladys UI will be exposed.
- `TZ: Europe/Paris` => Timezone used by container. Feel free to consult [this list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) on wikipedia if you need to change this value.

## Start Gladys

You can start Gladys (and Watchtower) containers with the command:

```bash
docker compose up -d
```

Note:

- `-d` => This option is launching the containers in a detached mode, meaning you can disconnect and the containers will stay.

## Accessing Gladys

You can access Gladys directly by typing the IP of your machine (the Raspberry Pi for example) in your browser.

To find the IP, just type `ifconfig` on the linux machine shell, or use a network scanner app ([Network Scanner](https://play.google.com/store/apps/details?id=com.easymobile.lan.scanner&hl=fr) on Android or [iNet](https://itunes.apple.com/fr/app/inet-network-scanner/id340793353?mt=8) on iOS)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
id: docker-compose
title: Installation avec Docker Compose
sidebar_label: Docker Compose
---

Ce tutoriel vous explique comment installer Gladys manuellement avec Docker Compose, quel que soit la machine sur laquelle vous faites tourner Gladys : Un Raspberry Pi, un NAS Synology, une VM linux, peu importe.

## Requirements

Pour installer Docker Compose, vous devez d'abord installer Docker. Veuillez suivre la documentation [ici](/fr/docs/installation/docker).

### Installer Docker Compose

Vous devez installer Docker Compose v2 comme un plugin Docker. Pour faire cela, vous pouvez suivre la [documentation officielle](https://docs.docker.com/compose/install/#scenario-two-install-the-compose-plugin)

## Copier/Importer le fichier de configuration Gladys Docker Compose

Vous pouvez trouver un exemple de fichier Docker Compose dans notre repository Github : https://raw.githubusercontent.com/GladysAssistant/Gladys/master/docker/docker-compose.yml

Sauvegardez ce fichier dans un répertoire de votre système.

Quelques paramètres que vous pouvez changer :

- `SERVER_PORT: 80` => Vous pouvez changer le port par défaut de l'interface Gladys.
- `TZ: Europe/Paris` => Pour changer le fuseau horaire du conteneur, vous pouvez modifier cette variable. Vous trouverez toutes les valeurs possibles sur [cette liste](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).

## Lancer Gladys Assistant

Pour lancer Gladys (et Watchtower), exécutez la commande suivante :

```bash
docker compose up -d
```

Note:

- `-d` => Cette option permet de lancer les containers de manière détachée. Ainsi, vous pouvez vous déconnecter et les containers continueront d'exister.

## Accéder à Gladys Assistant sur le navigateur

Vous pouvez accéder à Gladys en saisissant l'IP de votre machine sur votre navigateur, vous devez être sur le même réseau que la machine attention !

Pour trouver l'IP de votre machine, si vous êtes sur le même réseau local, vous pouvez utiliser des apps comme ([Network Scanner](https://play.google.com/store/apps/details?id=com.easymobile.lan.scanner&hl=fr) sur Android ou [iNet](https://itunes.apple.com/fr/app/inet-network-scanner/id340793353?mt=8) sur iOS).
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ module.exports = {
"installation/hardware",
"installation/raspberry-pi",
"installation/docker",
"installation/docker-compose",
"installation/synology",
"installation/unraid",
"installation/freebox-delta",
Expand Down
Loading