Skip to content

GladysAssistant/Gladys


Gladys Assistant Logo
Gladys Assistant

Your privacy-first, open-source smart home assistant

Try It β€’ Getting Started β€’ Contribute β€’ Contributors β€’ License

Gladys on multiple devices


πŸš€ Try Gladys Assistant

Spin up a local Gladys Assistant instance in seconds using Docker:

sudo docker run -d \
  --log-driver json-file \
  --log-opt max-size=10m \
  --cgroupns=host \
  --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 \
  -v /run/udev:/run/udev:ro \
  gladysassistant/gladys:v4

Prefer using Docker Compose? Check out our Docker Compose installation guide.

πŸ“š Getting Started

To install Gladys Assistant on your smart home setup, head over to our official website for a step-by-step guide.

Whether you're installing on a mini-PC, a NAS or a Raspberry Pi, we've got you covered with clear instructions tailored to your setup.


🀝 Contribute to Gladys

We welcome contributions of all kinds β€” code, documentation, translations, or feature ideas.

Gladys is built by an open-source community, and you can be a part of it!

1. Set up your development environment

Follow the guide that matches your system to get started:

2. Start developing

Once your environment is ready, dive into our contributing guide to understand the project structure, how to build features, and how to open a pull request.


πŸ§‘β€πŸ’» Contributors

A huge thank you to all our amazing contributors! πŸ’œ
Gladys wouldn't be where it is today without your help.

Thanks goes to these wonderful people πŸ‘

Pierre-Gilles Leymarie
Pierre-Gilles Leymarie

πŸ’» πŸ’Ό πŸ“– πŸ€”
Vincent KULAK
Vincent KULAK

πŸ’» πŸš‡ πŸ“– πŸ€”
Alexandre Trovato
Alexandre Trovato

πŸ’» πŸ“– πŸ€”
Bertrand d'Aure
Bertrand d'Aure

πŸ’»
Terdious
Terdious

πŸ’» πŸ€”
StΓ©phane
StΓ©phane

πŸ’» πŸš‡ πŸ€”
Scott Fischer
Scott Fischer

🌍
thib_rdr
thib_rdr

πŸ“–
Callum Macdonald
Callum Macdonald

πŸ“–
Redshark30
Redshark30

πŸ“–
Lamanda
Lamanda

πŸ’»
Thibaut Courvoisier
Thibaut Courvoisier

πŸ’»
FrΓ©dΓ©ric Le Barzic
FrΓ©dΓ©ric Le Barzic

πŸ’»
NickDub
NickDub

πŸ’»
Cyril Beslay
Cyril Beslay

πŸ’»
callemand
callemand

πŸ’»
Brad Sanders
Brad Sanders

πŸ“–
Rob McCann
Rob McCann

πŸ’»
Ikko Ashimine
Ikko Ashimine

πŸ“–
Ehtesham Siddiqui
Ehtesham Siddiqui

πŸ“–
Pochet Romuald
Pochet Romuald

πŸ’»
Martin Garcia
Martin Garcia

πŸ’»
euguuu
euguuu

πŸ’»
Jonathan Brisavoine
Jonathan Brisavoine

πŸ’»
Alex
Alex

πŸ’»

This project follows the all-contributors specification. Contributions of any kind welcome!

Read Contributing.md if you want to help us on Gladys Assistant.

Articles

πŸ“„ License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.

Β© 2014–present Gladys Assistant.