Homeway empowers the Home Assistant community by providing secure, private, and free remote access. We are dedicated to supporting every possible Home Assistant setup. Building on our Home Assistant Add-on and the standalone Linux CLI, we are excited to announce the launch of our new standalone Docker image!
No matter which installation option you choose for Homeway, you will enjoy free, private, and secure remote access to your Home Assistant server. All install options support Sage AI, Alexa, Google Assistant, and the official Home Assistant app!
Choose An Install Option
Pick the ideal Homeway install, depending on your Home Assistant setup. If you’re unsure which to choose, our step-by-step guide will help you decide.
- Does your Home Assistant support Add-ons?
- Install the Homeway Add-on. It is the easiest to install, update, and integrate into Home Assistant.
- Do you have SSH access to the Home Assistant device?
- Use the Homeway Standalone CLI. Running the CLI on the same device makes a few integration points easier.
- Use the Homeway Standalone Docker Image or Linux CLI.
- The Homeway Docker image can run anywhere Docker or Docker Compose runs, like Windows, Mac, Linux, and more.
- The Homeway Linux CLI can run on any Debian Linux device on your LAN.
Homeway Standalone Docker Setup
Required Setup Information
To connect to your Home Assistant server, provide the Docker container with two pieces of information. This information remains on your device and is never sent to the cloud.
- Your Home Assistant’s server IP or hostname.
- Your Home Assistant server hostname might be
homeassistant.local, localhost, or some other .local domain. The IP address might be192.168.1.5or similar.
- Your Home Assistant server hostname might be
- A Long-Lived Access Token from your Home Assistant server.
- Open the Home Assistant web UI and go to your user profile:
- Something like http://homeassistant.local:8123/profile
- On your profile page, click the “Security” tab at the top.
- Scroll down to the bottom, to the “Long-lived access tokens” box.
- Click “CREATE TOKEN”
- Enter any name; something “Homeway Addon” works just fine.
- Copy the Access Token to use in the following steps.
- Open the Home Assistant web UI and go to your user profile:
Set Up The Docker Image
There are two ways to run the Homeway Docker image: using Docker Compose or directly using Docker. We recommend using Docker Compose, as it makes the setup easier and cleaner.
To Use Docker Compose…
- Install Docker and Docker Compose.
- Clone the Homeway Addon git repo.
- Edit the
./docker-compose.ymlfile to enter the Home Assistant server information you got above. - Run
docker compose up -d
To Use Docker Directly…
Run Docker using the following command line and substitute the Home Assistant server information you got above.
Homeway needs a local device directory to store its config files, so the info persists when the container is restarted. You can edit the ./data directory to be any file path you wish.
docker run --name homeway -p 11027:11027 -e HOME_ASSISTANT_IP=homeassistant.local -e HOME_ASSISTANT_ACCESS_TOKEN=token -v ./data:/data -d homewayio/homeway
Link The Homeway Docker Container
Finally, you must link the Docker container to your secure Homeway account. When the Docker container is running, use the logs to find the linking URL:
Docker Compose:
docker compose logs | grep https://homeway.io/getstarted
Docker:
docker logs homeway | grep https://homeway.io/getstarted
Setup Complete🎉
That’s it! You now have lightning-fast Home Assistant remote access from anywhere! Welcome to the Homeway community.
Explore the Homeway website for guides on setting up Sage AI, Alexa, Google Assistant, or the Home Assistant App. Be sure to join our Discord server if you have any questions or feedback or want to be part of our social community!