diff --git a/README.md b/README.md index 8ecc28e5..ce325345 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Denys Dovhan Smart Home -![Home](https://user-images.githubusercontent.com/3459374/152371766-1d2a1e17-34d3-4fe6-9e6d-aded02f14de1.png) +![Smart Home dashboard overview](https://github.com/denysdovhan/smart-home/assets/3459374/3eb9c007-4443-4e8d-98bf-cce0e85d631e) [![GitHub Workflow Status][github-img]][github-url] [![Last Commit][last-commit-img]][github-url] @@ -11,7 +11,7 @@ [![GitHub Stars][stars-img]][github-url] [![Twitter Followers][twitter-img]][twitter-url] -This is my personal Home Assistant configuration, awakening my home with automations. I hope this will help you inspire on the way to built your own smart home. +This is my personal smart-home configuration, awakening my home with services and tools. I hope this will help you inspire on the way to built your own smart home. [**Read the documentation**](https://denysdovhan.com/smart-home) @@ -24,7 +24,7 @@ I also have a [public Notion board](https://www.notion.so/denysdovhan/f09ea06da5 [github-url]: https://github.com/denysdovhan/smart-home -[github-img]: https://img.shields.io/github/actions/workflow/status/denysdovhan/smart-home/homeassistant.yml?style=flat-square +[github-img]: https://img.shields.io/github/actions/workflow/status/denysdovhan/smart-home/docs.yml?style=flat-square [last-commit-img]: https://img.shields.io/github/last-commit/denysdovhan/smart-home?style=flat-square [commit-activity-img]: https://img.shields.io/github/commit-activity/m/denysdovhan/smart-home?style=flat-square [license-url]: https://github.com/denysdovhan/smart-home/blob/master/LICENSE diff --git a/docs/index.md b/docs/index.md index ca280539..d35f727f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # Welcome to my Smart Home! -![Screenshot 2024-05-24 at 18 48 01](https://github.com/denysdovhan/smart-home/assets/3459374/3eb9c007-4443-4e8d-98bf-cce0e85d631e) +![Smart Home dashboard overview](https://github.com/denysdovhan/smart-home/assets/3459374/3eb9c007-4443-4e8d-98bf-cce0e85d631e) [![GitHub Workflow Status][github-img]][github-url] [![Last Commit][last-commit-img]][github-url] diff --git a/docs/software/index.md b/docs/software/index.md new file mode 100644 index 00000000..e4516adb --- /dev/null +++ b/docs/software/index.md @@ -0,0 +1,25 @@ +# Introduction + +This page describes my system setup. Here you can find software I rely on for running my smart home system. + +## Using Proxmox + +## Ubuntu LXC + +I use [Ubuntu](https://ubuntu.com/) as a primary OS for my Raspberry Pi. Ubuntu is a well-maintained Linux distribution with a huge community and large support forums. + +It officially [supports Raspberry Pi](https://ubuntu.com/download/raspberry-pi) and can be easily installed via the official Raspberry Pi Imager. + +## [Docker](https://www.docker.com/) + +I use [Docker](https://www.docker.com/) for managing all containers in my smart home. + +Docker allows to encapsulate everything related to a single service within a container. This approach helps to maintain host system clean and manage (start, stop, update and delete) every container separately. + +### Enabling hardware acceleration + +## smart-home CLI + +This is just a bash script I wrote for personal need. You can [find it here](https://github.com/denysdovhan/smart-home/blob/master/bin/smart-home). + +This performs typical tasks I do in my smart home, like bootstraping, controlling server, updating, etc. diff --git a/docs/software/ports.md b/docs/software/ports.md deleted file mode 100644 index c7c77a0a..00000000 --- a/docs/software/ports.md +++ /dev/null @@ -1,28 +0,0 @@ -# Ports - -Here's a table of services and ports exposed via `docker-compose`: - -| Service | Exposed port | -| ------------------- | ---------------------------------------------------------------- | -| Cockpit | 9090 | -| Portainer CE | 9000 | -| Home Assistant | 8123 | -| Mosquitto | 1888 | -| Zigbee2MQTT | 8099 | -| ESPHome | 6052 | -| Duplicati | 8200 | -| Adminer | 8080 | -| Nginx Proxy Manager | 80, 443, 8081 | -| Samba | 139, 445, 137, 138 | -| Pi-hole | 53, 67, 5300 | -| Plex | 32400, 3005, 5353, 1900, 8324, 32469, 32410, 32412, 32413, 32414 | -| Transmission | 9091, 51413 | -| Vaultwarden | 3880 | -| Sonarr | 8989 | -| Radarr | 7878 | -| Prowlarr | 9696 | -| PS5MQTT | 8645 | - - -!!! info - Some services are exposed as `network_mode: host`, so some exposed port might not be listed in the table below. diff --git a/docs/software/system.md b/docs/software/system.md deleted file mode 100644 index a35f8903..00000000 --- a/docs/software/system.md +++ /dev/null @@ -1,55 +0,0 @@ -# System Overview - -This page describes my system setup. Here you can find software I rely on for running my smart home system. - -## [Ubuntu Server 22.04 LTS](https://ubuntu.com/download/server) - -I use [Ubuntu](https://ubuntu.com/) as a primary OS for my Raspberry Pi. Ubuntu is a well-maintained Linux distribution with a huge community and large support forums. - -It officially [supports Raspberry Pi](https://ubuntu.com/download/raspberry-pi) and can be easily installed via the official Raspberry Pi Imager. - -## [Docker](https://www.docker.com/) - -I use [Docker](https://www.docker.com/) for managing all containers in my smart home. - -Docker allows to encapsulate everything related to a single service within a container. This approach helps to maintain host system clean and manage (start, stop, update and delete) every container separately. - -[`docker-compose`](https://docs.docker.com/compose/`) helps to describe my whole setup in a single file and manage it with a few commands. - -## [Cockpit](https://cockpit-project.org/) - -![Cockpit UI](https://user-images.githubusercontent.com/3459374/115122655-bdfe5b80-9fc1-11eb-9a68-9ce67f12ce8e.png) - -[Cockpit](https://cockpit-project.org/) is a web-based graphical interface for servers. Ubuntu is officially supported. - -This tool let me easily manage my system from web browser: network, external drives, processes and services, system update, etc. - -## [smart-home](https://github.com/denysdovhan/smart-home/blob/master/bin/smart-home) - -This is just a bash script I wrote for personal need. You can [find it here](https://github.com/denysdovhan/smart-home/blob/master/bin/smart-home). - -This performs typical tasks I do in my smart home, like bootstraping, controlling server, updating, etc. - -## Prior art - -### Home Assistant OS - -Previously, I've been using [Home Assistant OS](https://www.home-assistant.io/installation/#compare-installation-methods) installation. Home Assistant OS was installed directly on my Raspberry Pi, controlling every aspect of it. - - -!!! info - Home Assistant OS is nice, especially for newbies. Supervisor handles everything: networking, addons, updates, backups, etc. This lets you start quickly, automate your home, thinking in a safe box. - - **Please, use it if you don't fell confident enough** in networking, Linux, and DevOps stuff. - -The only major downside is an inability to control the system. You cannot host custom software alongside Home Assistant, you don't have full access to your system, you cannot mount external drives. - -As my knowledge was growing, so was my demands. Raspberry Pi is a very capable device, so I knew I can host more useful things for my home on it. First of all, I wanted to hook up an external hard drive and stream my media via Plex. - -However, leaving Home Assistant OS means **no more benefits of Supervisor**. I should manage my system myself: network, updates, backups. This bears more responsibility and headache. - -I've been developing an alternative solution gradually for a few months, looking for a replacement for every part of the Supervisor's functionality. Then, when I felt confident, I migrated to my new setup. - -### Home Assistant Supervised - -I was running HA Supervies for a year or so. This worked well for me, though I've decied to move back to Container since it gives much more freedom and control over my system. diff --git a/mkdocs.yml b/mkdocs.yml index e625b29d..e847889c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -52,13 +52,12 @@ nav: - Home: index.md - Hardware: hardware.md - Software: - - software/system.md + - software/index.md - software/getting-started.md - software/docker.md - software/media.md - software/external-access.md - software/ad-blocking.md - - software/ports.md - Inspiration: resources.md # Link to my smart-home setup # Ref: https://github.com/denysdovhan/home-assistant-config