Skip to content
This repository has been archived by the owner on May 22, 2024. It is now read-only.
/ home-station Public archive

A fancy, easy-to-use, docker compose based app manager for your self-hosted home server.

License

Notifications You must be signed in to change notification settings

sharknoon/home-station

Repository files navigation

TODO ICON OR FANCY HEADER LOGO

Home Station

A fancy, easy-to-use, docker compose based app manager for your self-hosted home server.

GitHub Repo stars GitHub Release GitHub last commit

TODO SCREENSHOT

Live Demo

Try it!

https://demo.home-station.org/

It is a read-only live demo, you can't make any permanent changes.

⭐️ Features

  • 🖱️ Install your favorite open-source apps with one click
  • 🏬 App marketplace with over 1 free apps
  • 🔐 Integrated reverse proxy, so you don't have to worry about ports and certificates
  • ⬆️ Automatic updates for your apps (can be turned off)
  • 🖥️ Fancy, easy-to-use and multi-language UI (with themes 🎨)
  • 👤 Multi user capable (share your home server with your family & friends)

🔧 How to install

🐳 Docker

docker run -d --restart=always -p 80:80 -p 443:443 -v home-station:/data -v /var/run/docker.sock:/var/run/docker.sock --network home-station --name home-station ghcr.io/sharknoon/home-station

Home Station is now running at http://home-station.localhost

Note

If your ports 80 and 443 are already occupied, feel free to test Home Station with other ports:
-p 8080:80 -p 8433:443

🎶 Docker Compose

curl -L -o compose.yml https://raw.githubusercontent.com/sharknoon/home-station/main/packages/home-station/compose.yml
docker compose up -d

Home Station is now running at http://home-station.localhost

Note

If your ports 80 and 443 are already occupied, feel free to test Home Station with other ports by editing the downlaoded compose.yml file:

ports:
   - 8080:80
   - 8433:443

Important

On macOS Safari doesn't resolve *.localhost subdomains. To avoid this issue, use a different browser like Firefox or Chrome. However, accessing a hosted Home Station via a domain works just fine.

🚧 Roadmap

  • 🛟 Automatic Backups to popular cloud providers like Google Drive, Onedrive etc... as well as your own hardware
  • 🛡️ Single sign-on for all your apps
  • 🔗 Multi host support (allows multiple machines to be managed by one Home Station)

Screenshots

TODO

Motivation

I have been using Portainer for all my docker compose stacks and traefik as my reverse proxy. Installing a new open-source app incorporated at least the following steps:

  1. Copying the docker-compose.yml (or creating one from a given docker run command)
  2. Applying proxy settings in the form of labels to it
  3. Adding it to the reverse proxy network
  4. Creating volumes to persist data

One day I had enough, because I already had installed ~100 compose stacks this way. I wanted to create an opiniated approach to installing apps, that just requires one click and is the same for everybody.

The goal with Home Station is to allow you to focus on using the apps, rather than on deploying them.

If you love this project, please consider giving it a ⭐.