Skip to main content

Get started with Gladys Assistant

Gladys Assistant is a free and open-source smart home software. It brings all your devices into one app, controls them from your phone, and automates your home, while running at home, not in someone else's cloud.

From zero to your first automation, here is the whole path:

The Gladys Assistant dashboard
The dashboard of Gladys: your devices, rooms, cameras and energy, on your computer and your phone.

How Gladys works​

Your devicesLights, sensors, plugs, heating, cameras… from any brand.
Gladys, at homeOn a small computer that stays on, like your Internet box.
Your phone & computerTo control everything, from your sofa or from anywhere.

Gladys is self-hosted: instead of a subscription to a cloud, you install it once on a small computer at home. That is why there is an installation step, and it's what makes Gladys private (by default, your data stays at home) and reliable (your home keeps working even when the Internet is down).

Step 1: Install Gladys​

Pick the machine Gladys will run on. Not sure? Take the mini-PC: it's what most users run, and what I use at home.

Recommended

On a mini-PC, with Gladys Assistant OS

  • About 30 minutes
  • No command line
  • Automatic updates

Our official installer does all the work: write it to a USB drive, start the mini-PC from it, answer a few questions, and Gladys installs itself. It then keeps itself up to date.

  • A new mini-PC: small, silent and frugal. I recommend the Beelink Mini S13, see also our mini-PC buying guide.
  • A refurbished mini-PC: often much cheaper. Look for at least 8 GB of RAM and an SSD.
  • A computer you already own: an old PC with an Intel or AMD processor that starts in UEFI mode, an SSD of at least 16 GB and an Ethernet port can become your Gladys box (its disk will be erased).
Install Gladys on a mini-PC

On a Raspberry Pi

  • 30 minutes to 1 hour
  • No command line

Already have a Raspberry Pi 3, 4 or 5? Flash our official 64-bit image with Raspberry Pi Imager: a great way to try Gladys. For everyday use in the long run, a mini-PC remains the better choice.

Install on a Raspberry Pi

On a server or a NAS you already run

  • About 10 minutes with Docker
  • For self-hosting regulars

Gladys installs next to your other services, no new machine to buy:

Step 2: Create your account​

Once Gladys is running, open it in your browser, from a computer or a phone on the same network:

  • http://gladysassistant.local: Gladys announces this name on your network, with Gladys Assistant OS, the Raspberry Pi image, Proxmox or Docker. On a Synology NAS, add the port you chose, for example http://gladysassistant.local:8420;
  • otherwise (Unraid, some Android phones, guest networks…): the IP address of the machine, for example http://192.168.1.42, followed by the port on a NAS.

A short wizard guides you: create the administrator account, choose your preferences (language, units), then name your house and its rooms. It takes two minutes, and everything you enter stays in the local database of Gladys.

The welcome screen of Gladys Assistant

Moving from a previous installation? The Gladys Plus backup restore button of this screen brings back your whole setup.

Step 3: Connect your devices​

In Gladys, open Integrations and pick the brand of your devices. Gladys works with 1,200+ integrations, the most popular ones built in and the others installable in one click:

Each integration has its own page in this documentation, with the steps to follow.

Starting from scratch? Go Zigbee

If you are buying devices, I recommend Zigbee: a USB Zigbee dongle (about $30) plugged into your Gladys box, and the Zigbee2MQTT integration, let you use thousands of affordable sensors, plugs, bulbs and remotes, from any brand, with no vendor hub and no cloud. My selection of reliable models is on the recommended hardware page.

Example: equip a living room for about $150

Start with one room, see what you like, then extend room by room.

DevicePriceLink
Zigbee Temperature/Humidity Sensor with Display$19.99Amazon US
ZigBee Smart Plug 4 Pack with Real-time Energy Monitoring$16.99Amazon US
IKEA TRÅDFRI E27 Bulb (Ceiling Light)$13.99IKEA US
IKEA STYRBAR Remote (Brightness)$13.99IKEA US
Zigbee Motion Sensor 4 Pack$75.99Amazon US

Step 4: Automate your home​

This is where Gladys shines. Your devices show up on the dashboard, which you can customize and share with your family. Then, scenes make your home work on its own: a trigger (a time, a sensor, someone coming home…), a few conditions, and actions.

A scene in Gladys Assistant

A few ideas for a first scene:

  • Light the hallway at nightWhen motion is detected after sunset, turn the light on for 2 minutes.
  • Leave home with peace of mindWhen the house is empty, turn everything off and arm the alarm.
  • Heat only when neededLower the heating at night and when nobody is home.
  • Be warned right awayGet a message when water leaks or a door opens during your holidays.

👉 Create your first scene

To use Gladys like an app, install it on your phone. To control it when you're away, Gladys Plus, our optional service, gives you end-to-end encrypted remote access, with no network setup.

Frequently asked questions​

Is Gladys really free?

Yes. Gladys is open source (Apache 2.0 license) and free, with no limit on devices or features. Gladys Plus is an optional paid service on top of it (remote access, daily backups, Google Home and Alexa, AI); it funds the development of the project.

Do I need to know how to code, or to use a terminal?

No. With Gladys Assistant OS or the Raspberry Pi image, you install Gladys without typing a single command, and everything else is done from the interface of Gladys.

Does Gladys work without Internet?

Yes. Gladys runs locally: your devices, your dashboard and your scenes keep working without Internet. You only need a connection to install Gladys and get updates, and for the integrations of cloud services.

I already use another smart home software, can I switch?

Yes, and Gladys can even run next to it while you move your devices over. Most Zigbee, Matter, Philips Hue or Shelly devices pair with Gladys directly. See how Gladys compares to Home Assistant or Jeedom.

Need help?​

Stuck at any step? Ask on the forum: the community and I answer every day.

Subscribe to the Gladys Assistant newsletter

A few emails per month about new releases and project news. Sent by Pierre-Gilles Leymarie, founder of the project. Unsubscribe anytime 🙂