Installation


Raspberry Pi

Download Gladys Raspbian image

We provide a pre-built Raspbian image with Gladys already configured.

Download the image

And unzip the downloaded zip file to get a .img file.

Clone the image on a SD card

Then, you just have to clone this image on the SD card you want to use with you Raspberry Pi.

I recommend the software Etcher (Linux/MacOS/Windows compatible).

Install Etcher, plug your SD card into your computer, and clone the .img file on your SD card.

Etcher

Plug your Raspberry Pi

Plug your Raspberry Pi to your local network and the current.

Give it some time to boot.

Access Gladys

To access Gladys, open your browser on any computer on the local network your Raspberry Pi is connected. Then enter the URL http://gladys.local.

You should see Gladys web UI!

Note : If it doesn’t work, you can access Gladys directly by typing the IP of your Raspberry Pi in your browser. To find the IP, you can use a network scanner app to find the IP, like (Network Scanner on Android or iNet on iOS)


Docker

On a Raspberry Pi

This tutorial is for Raspberry Pi owner who wants to install Gladys with Docker.

Install Docker on the Raspberry Pi

curl -fsSL https://get.docker.com -o get-docker.sh
chmod u+x get-docker.sh
./get-docker.sh

Start Gladys

If you tried the alpha before the beta, you need to remove the /var/lib/gladysassistant folder to ensure all files from the alpha are deleted. Warning: you’ll lose any data saved in Gladys alpha.

docker run -d \
--restart=always \
--privileged \
--network=host \
--name gladys \
-e NODE_ENV=production \
-e SERVER_PORT=80 \
-e TZ=Europe/Paris \
-e SQLITE_FILE_PATH=/var/lib/gladysassistant/gladys-production.db \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /var/lib/gladysassistant:/var/lib/gladysassistant \
-v /dev:/dev \
gladysassistant/gladys:4.0.0-beta-arm

Note:

  • If you are on a x64/x86 architecture, you can change the image to gladysassistant/gladys:4.0.0-beta-amd64
  • -e TZ=Europe/Paris => Timezone used by container. Feel free to consult this list on wikipedia if you need to change this value.

Accessing Gladys

You can access Gladys directly by typing the IP of your Raspberry Pi in your browser. To find the IP, just type ifconfig on the Raspberry Pi shell, or you can use a network scanner app to find the IP (Network Scanner on Android or iNet on iOS)

On any system

You can run Gladys on any system:

  • A Synology NAS
  • A VM
  • Any Linux machine
  • On MacOS
  • On Windows

Install Docker

I recommend going to the docker documentation and looking for instructions for your system.

Start Gladys

Run the command:

docker run -d \
--restart=always \
--privileged \
--network=host \
--name gladys \
-e NODE_ENV=production \
-e SERVER_PORT=80 \
-e TZ=Europe/Paris \
-e SQLITE_FILE_PATH=/var/lib/gladysassistant/gladys-production.db \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /var/lib/gladysassistant:/var/lib/gladysassistant \
-v /dev:/dev \
gladysassistant/gladys:4.0.0-beta-amd64

You can edit the open ports / network mode depending of your system.


MacOS/Windows

The process is almost the same as on the Raspberry Pi, it’s just a container to start.

Install Docker Desktop

You first need to install Docker Desktop.

Follow the instructions on Docker website.

Docker Desktop should install Kitematic, a Docker GUI. If it doesn’t, you can install get it on Kitematic website.

Start Gladys

You need to start Kitematic first.

Then, search for “gladysassistant”:

Kitematic gladys assistant

Select the tag “4.0.0-beta-amd64”:

Kitematic gladys assistant

Click on “Create” to start a new container:

Kitematic gladys assistant

Then open in your browser the address showed by Docker (here, “http://localhost:32768”)

Kitematic gladys assistant

Success!