Skip to main content

Dependencies

  1. Install docker and docker-compose.
sudo apt install -y docker docker-compose
  1. Install git.
sudo apt install -y git
  1. Install your favourite text editor. For example, nano.
sudo apt install -y nano

Install process

  1. Open the ports 80 and 443 on your router/firewall if needed.

  2. Create a DDNS domain and set it using your public IP. DuckDNS and no-ip are supported.

  3. Clone the repo and cd into it.

git clone https://github.com/kikeelectronico/Homeware-LAN.git
cd Homeware-LAN
  1. Create your own .env file from .env.template. Data will be used to generate certs on letsencrypt.
cp configuration_templates/.env.template .env
  1. Replace the default data with your values.
  • DOMAIN: your domain name from step 2.
  • EMAIL: your email. It is used for getting the SSL certificate from Let's Encrypt.
  • HOMEWARE_USER: the admin username that you will use to log in.
  • HOMEWARE_PASSWORD: the admin password that you will use to log in.
  1. Copy the docker-compose file.
  • Debian / Ubuntu
cp docker/docker-compose-debian.yaml docker-compose.yaml
  • Raspberry Pi / ARM cores
cp docker/docker-compose-raspberry.yaml docker-compose.yaml
  1. Start the project.
docker-compose up -d

  1. Follow this steps to link Homeware with Google Home: https://homeware.enriquegomez.me/docs/connect-with-google

  2. Finally, set up the necessary data using the Homeware's Settings page.

Default MQTT user and password

  • User: mosquitto
  • Password: homewarelan123

You may create a different mosquitto_passwd file following these steps

Thanks to @ajpl for the PR.