{"id":30512914,"url":"https://github.com/ericklv/nas","last_synced_at":"2026-04-07T21:31:06.980Z","repository":{"id":310303478,"uuid":"1039384996","full_name":"ericklv/nas","owner":"ericklv","description":"Home automation using docker","archived":false,"fork":false,"pushed_at":"2025-08-24T22:11:42.000Z","size":20,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-08T14:50:39.587Z","etag":null,"topics":["cloudflared","docker","docker-compose","home-assistant","nas","orangepi","pihole","portainer","raspberrypi","sftpgo","tailscale","watchtower"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ericklv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-17T05:24:59.000Z","updated_at":"2025-08-24T22:11:45.000Z","dependencies_parsed_at":"2025-08-24T18:23:35.296Z","dependency_job_id":null,"html_url":"https://github.com/ericklv/nas","commit_stats":null,"previous_names":["ericklv/nas"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ericklv/nas","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericklv%2Fnas","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericklv%2Fnas/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericklv%2Fnas/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericklv%2Fnas/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ericklv","download_url":"https://codeload.github.com/ericklv/nas/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ericklv%2Fnas/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31530640,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T16:28:08.000Z","status":"ssl_error","status_checked_at":"2026-04-07T16:28:06.951Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloudflared","docker","docker-compose","home-assistant","nas","orangepi","pihole","portainer","raspberrypi","sftpgo","tailscale","watchtower"],"created_at":"2025-08-26T06:00:26.014Z","updated_at":"2026-04-07T21:31:06.670Z","avatar_url":"https://github.com/ericklv.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Home Automation\n\nAutomation using docker compose in your NAS (raspberry pi, orange pi, nuc or delorean lol)\n\n##  Steps\n\n- Install docker\n- Install docker compose\n- Configure Github user if you need it (see Github section)\n- Check `mount-hdd.sh` to mount your disk in NAS\n- Clone this repository\n- Set static ip in the NAS (explained below)\n- Configure your `.env` file with all variables required as described in `.env.example`\n- Run ` docker compose up --build -d ` to start containers\n- Run `sh install-hacs.sh` to install HACS in Home Assistant container\n- Configure your router with the static ip assigned to NAS as DNS primary, necessary for pihole\n- Configure all devices you need in Home Assistant\n- Go to Cloudflare Tunnel Dashboard and expose all containers you want. You need a domain previously configured in  Cloudflare\n- Enjoy!\n\n## Services\n\n### Available\n\n- Home Assistant (HACS)\n- SFTPGo (secure file transfer)\n- Homebridge (integrate devices with HomeKit)\n- Cloudflared (Cloudflare Tunnel)\n- Portainer (Manage containers)\n- WatchTower (Update containers)\n- PiHole (DNS filtering / ad blocking / privacy)\n- Tailscale (VPN)\n\n### Coming soon\n\n- WireGuard Easy (VPN) ...some day. CGNAT is too complicated.\n- Addons for Home Assistant\n- QBitTorrent\n- Mosquitto (MQTT Broker for IOT)\n\n## Configuration\n\n### Set static ip\n\n```\nsudo nmtui\n```\n\nEdit your connection with this values.\n\n### Values\n\n- address: 192.168.1.10/24 (static ip example)\n- gateway: 192.168.1.1\n- dns: 1.1.1.1\n- dns: 1.0.0.1\n\n## Github\n\n### Generate ssh key in NAS with email\n\n```\nssh-keygen -t rsa -b 4096 -C \"your@email.com\"\n```\n\n### Add ssh key in Github\n\nSetting \u003e SSH and GPG keys \u003e New SSH key\n\nGood job, you can now clone all repositories!\n\n## Tailscale\n\n### Create account and generate auth key\n\nGo to [Tailscale](https://tailscale.com/) and create account.\nMove to Setting \u003e Personal Settings \u003e Keys \u003e Generate auth key\n\nComplete form and enable _Reusable_ option. Remember auth key expire in 90 days (free mode). Add this key in your `.env` file.\n\nAfter run docker containers go to Machines section, in *homelab-docker* machine \u003e 3 dots \u003e edit route settings \u003e check if _subnet routes_ and _exit node_ is enabled.\n\nInstall tailscale app in your mobile, login with your account and enjoy!\n\n## PiHole\nFix database, maybe you need in first time\n```\ndocker exec -it pihole pihole -g\n```\n\n## Home Assistant in Cloudflare Tunnel.\nGo to Home Assistant \u003e File Editor \u003e configuration.yaml \u003e Edit\n```\nhttp:\n  use_x_forwarded_for: true\n  trusted_proxies:\n    - 172.20.0.0/24\n  ip_ban_enabled: true\n  login_attempts_threshold: 5\n```\n\n## Docker commands\n\nUp services\n\n```\ndocker compose up --build -d\n```\n\nCheck status\n\n```\ndocker ps\n```\n\nEnter into container\n\n```\ndocker exec -ti \u003ccontainer-name-or-id\u003e /bin/bash\n```\n\nStop services\n\n```\ndocker compose down\n```\n\nSee logs\n\n```\ndocker compose logs -f \u003ccontainer-name-or-id\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fericklv%2Fnas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fericklv%2Fnas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fericklv%2Fnas/lists"}