Meet Homepage - Your HomeLab Services Dashboard
Vložit
- čas přidán 19. 06. 2024
- Meet Homepage, your new HomeLab services dashboard homepage! Homepage is an open source, highly customizable homepage (or startpage) dashboard that runs on Docker and is integrated with over 100 API services. It's easy to set up, looks good by default, and helps you keep track of everything you are running in your HomeLab and more. Today we'll set up Homepage and get it running in Docker in no time.
Video Notes: technotim.live/posts/homepage...
Homepage: gethomepage.dev/latest/
Support me on Patreon: / technotim
Sponsor me on GitHub: github.com/sponsors/timothyst...
Subscribe on Twitch: / technotim
Become a CZcams member: / @technotim
Merch Shop 🛍️: l.technotim.live/shop
Gear Recommendations: l.technotim.live/gear
Get Help in Our Discord Community: l.technotim.live/discord
Tinkers channel: / @technotimtinkers
(Affiliate links may be included in this description. I may receive a small commission at no cost to you.)
00:00 - What is Homepage?
01:08 - Homepage Prerequisites
01:18 - Setting Up Homepage with Docker
01:40 - Explaining Docker Compose Properties
03:02 - Docker Server Tasks
04:11 - Starting Homepage
04:52 - Exploring HomePage
06:00 - Customizing Homepage
07:20 - Customizing Background Image
08:16 - Dark Mode & Color
08:51 - Adding Services
09:32 - Icons Repos
10:30 - Icons with CSS
11:46 - Add Services Group
12:04 - Adding Widgets (e.g. Pi-Hole)
14:01 - .env File
15:09 - Service Widgets on Homepage
15:30 - Standalone Widgets
16:25 - Recreating My Old Homepage
17:43 - Sharing Config
18:20 - Kubernetes Config
Thank you for watching! - Věda a technologie
So cool to see you do this , I've been using homepage for like 2 years now!
Dude thanks a ton, this is incredible. Insanely easy to work with and add services to, and it looks SO clean! Like WAY more sleek than almost every other dashboard out there!
Hey Tim, this is AWESOME!!! Another great tutorial and easy to follow along with. I am currently using Dashy and have been looking for a different dashboard for my home lab and this one fits the bill. Thank you and keep up the awesome work that you do.
Super huge thanks for this Tim. I have been wanting to switch to this, but was overwhelmed by it. Your video made it super easy to understand and your documentation allowed for me to visually see your dashboard and then look at the configuration for me to understand what I was looking at in the code.
Right when I lost hope on someone posting some sort of video to help with homepage setup, Tim comes through..thanks man
Can’t thank enough for making this video. I had tried installing Homepage before but I couldn’t get it to work properly, with the help of the video and the documentation I was able to recreate my home dashboard exactly how I wanted it. Thank you Tim, great work!
Tim, just compelled to Thank You for such a great tutorial. It was ironic how a question would form in my mind while watching, and you answer it in your next breath! You are an excellent teacher!
Thanks to you, I just spent the last 3.5 hours configuring homepage in my Kubernetes cluster. My favorite part: Adding to homepage via annotations on your ingresses. Absolutely delightful to have services self-register.
Glad this came across my recommendations. Was in the middle of setting up my homelab past few days so perfect timing. TY!
Thank you so much.. finaly i have a great dashboard. Used yours as a good base and fixed it for my needs. tried homepage before, but i was thinking it was to complex, but you made it EASY.. thank you
Thanks for bringing this to my attention, i've spent the last couple of days setting this up and even had some back and forth with it's devs due to some irregularities and bugs. All in all, it's a great piece of software.
Thank you so much for showing this. I've been having a blast tinkering with it. You can almost get as obsessed with this as Home Assistant. One cool thing i was able to do, I used the customapi widget to create items for my Nest Wifi Pro.
Been using homepage for about a year, so knew most of the stuff but still learned a few things. Great video.
Also fyi, homepage recently added support for tabs which is a really great feature when you have a lot of icons
Hey Tim, huge thanks for such a great introduction to homepage, this will be a great addition to the resources new users have. Love your videos as always.
Been using Homepage for ages, thanks for your amazing work
funny how you guys thinks how yaml is basic stuff, I mean it is, but I think its taking for granted that everyone knows it. I guess its a matter of time that HomePage will be improved a bit like Homarr? I really like this intro too, without it I would not even consider that app on my homelab ;)
There is also Homarr which can be easily configured in UI.
Made the change from Heimdall to Homepage and at the first glance homepage was very confusing to me. But once you read the docs or watch a good youtube video like this it gets really easy to setup and very powerful. Had some trouble with the background but I will change it now thanks to this tutorial :) Great video.
Excellent tutorial as usual. Instructions easy to follow. I'm convinced. Thanks Tim.
How you know fun is on the way: Tim - "We have a couple of tasks to do!"
Tim, you can also define which container each link refers to, in the services yaml file. You can get either show healthy/running statements or just a green/orange dot. indicates which container is running or paused
Great howto...wish it was more click and go like heimdall...but it does make for one heck of a clean look...and is massively customizable
Thanks so much for this howto/walkthru!
Keep em coming!!!!
Moved to this from Homarr a couple weeks ago and been loving it. Glad to see you give it some love.
Hi
I was wondering if Home page is better than Homarr. For me Homarr looks much better, easy to control and mange.
What do you see on Home page that Homarr doesn’t have?
@@MGHOL-nv4xb Homarr was and still is perfectly fine. Homepage just fits my preferences more in how it presents things.
@@MGHOL-nv4xb For me, the big things are that Homepage is more lightweight and more configurable. I actually *want* YAMLs, whereas the lack thereof seems to be a major selling point for Homarr. IMO it also looks better.
Been using this for at least a year. I really like it.
Brilliant. I just installed it. Thanks for sharing.
Great video! Was just putting together layout info for Homer, but also lamenting that there wouldn't be any dymanic content.
And Stay warm...
I just moved to homepage after using homer and homarr and it seems much more customizable. Neat trick with the coloring of the icons I will have to see if I can try this with the background color for the icon space.
Always enjoy seeing your homelab tours and dashboard videos. McDonald's was a funny addition, In-N-Out for the win though 😂.
Same here. Loved Homarr but this is so much better.
Agreed!@@tifflabs
Brilliant thank you, setting this up now!
Great! Im looking for a replacement for my homelab dashboard and homepage seems to be a perfect match! Awesome!
This is great! I have been using Dashy for a while now, I like it, but I need a challenge and this is right up my alley! Thanks TechnoTim! BTW I love your white workbench, it's giving me ideas for the garage 😃
Same here!
perfect timing i just completed configuring vlan on my network, time to move on with this project.
I pillaged your configs. Thank you, sir. I was foolish for sleeping on Homepage. It’s fantastic.
When I 1st saw your HomPage .... I always wanted to know that how you did it...!! Thank You for this...!!!
This was really bad ass.. thanks for the detailed write up..
Another awesome video Tim! Helpful as always. Currently trying to decide between Homepage or Dashy as a replacement for Hiemdall in my homelab.
I was thinking about needing a dashboard an hour ago lol great timing
Great intro to homepage! If you do a refresh to this, I'd love to see a quick config of the 'customapi' widget. Very useful for showing any JSON (or HealthCheck) from hosted services that don't have an api integration yet.
I was looking for a comment like that. +1
Damnt.... I had kinda ignored these homepage style setup for my own lab.... but this one actually looks pretty cool I love the widget integrations with the different services thats what kinda seals the deal for me.... Ug now to go off and build my dashboard..... hehe the life of a homelabber... always something to tinker with
Thank you! great and helpful as always)
too cool! Thx for sharing. I've been wanting to switch to something else for a white (was using Heimdall).
❤🔥
Great video! Thanks for sharing!
This was great, thanks.
I've been using Homepage for a couple weeks now and enjoying it. I built it from Source for Windows because I'm not using Docker or anything like that. So mine runs as a Windows Service with Node and NSSM.
Thanks for this, I was just trying to set up Homarr, and I think this is nicer. 🙂
Just spent a few hours setting up Dashy to my liking. After watching this, I think I'll give it a try. Devs did a nice job.
Few hours messing with Homepage, absolutely loving it. The extended linked resources are unbelievable. Being a longtime Home Assistant user, loving the yaml configuration of Homepage. Between css and yaml, it's perfect! Thanks again for posting.
Thanks for the video Tim! i was looking at homepage when first setting up a dashboard and ended up with heimdall with just its ease and setup use. This is a great breakdown of how to setup homepage and really appreciate it. Time to target using homepage again!
Thanks for this am liking your videos alot thanks for taking the time
nice and thank you Tim.
Great video, you have a great didatic and i hope to see more vids like that.
Nice and easy tutorial on how to set it up :)
thank you. that a keeper for me !
very nice! thx for sharing!
Thank you for the video
Tim is my homelab superman 💪
Thanks Tim.
Hey Tim - Quality content as always 😊 wondering if you could do a Unifi Controller in Docker video? Really having issues since the introduction of the external Mongo DB and the way you breakdown the creation of the structure and config is incredible
Some important feature (for me) is that you can create Tabs and separete your Dashboard services and widgets a little further. Thx for the Video, love all of them!
did you mean "groups"? i didn't see any way of creating tabs, which would be an awesome addition
never mind. i see there's a comment below that says they've added tabs now
awesome! ty for tutorial
I've been giving homepage a spin. Lots to love and one thing to really really really dislike: lack of netdata widgets/integration. Heimdall supports Warnings and Critical alerts "out of the box" without additional configs. I think I'll move to homepage and keep Heimdall around to keep an eye on netdata. Surely, the good folks at homepage must be working on a netdata widget! :)
super helpful!
I’ve been looking into various homepage upgrade options. I’d love to hear your thoughts on some candidates. Homepage, Homarr, Dashy are some ones I’ve been looking at.
Thanks a lot for sharing the video and especially your config files with us, Tim! This is an almost perfect fit for my own environment as I have a similar setup in my homelab as you (4 PVE Server, 3 DNS Server, 3 TrueNAS Scale Server, ....) so this will save me tons of time for my very own configuration 🙂 Thumbs up!
Great intro to home page. This may be a use case just for me but do you know if you can use something like teleport or a login page and depending on the user it shows different pages
You’re an angel.
This looks great. been using homarr but I prefer something that I can have configured completely from code.
*- Tim turns off dark mode -*
Me: BRIGHT LIGHT! BRIGHT LIGHT!
😂😂😂
Hey Tim. Did you seen Homarr? Huge amount of integrations, includes docker and easy to configure
Other than the Homepage itself, I usually install another docker container called "FileBrowser" which I add the Homepage config folder to be editable in FileBrowser app. In such case, I can use FileBrowser to modify the Homepage config yaml files directly without using command line or ssh.
also @technotim is your documentation site self hosted? if so, what did you use to create it and is there a video by chance ? Thank you sir.
Thanks for the great video Tim! Would you be able to explain - if possible on a video - how to set up the API from Proxmod and get it imported with homepage. Appreciate it.
Now THIS is a good one. VERY manageable. Thanks for the detailed tutorial! My only problem is that my services run vertically within the groups and not horizontally like yours.
*EDIT: Cancel that. I forgot to add the relevant directives in settings.yaml*
Great product. I'll check this out. Wondering if you could define "sub directories" entries like in Heindall so that all your links don't end up on the same page. I have a screen real estate problem as you can imagine... Heimdall provides this but as you said it has other limitations...
Hi Tim, thanks this is a great video and i just went from Heimdall to Homepage thanks to you. However i have a question for you, i saw on widgets you can manage fields for some of them. But i don't find the right syntax or how to implement them. Did you read something on it? Thanks !
Seems neat, maybe I´ll try it and replace my hand rolled single html file + json config with it. Btw, I don´t think the version in docker-compose has anything at all to do with what version of docker-compose you are using. It´s the version of the file format and largly unrelated to the docker-compose version (no 1:1 match at the very least). I have stuck with 3.0 for the most part and never bothered to use anything else after having tried the "latest and greatest" at some point and coming to the realization that it does not make a whole ton of sence, because it was missing a bunch of stuff I needed at the time and seemed largly scewed to work better with docker swarm that I am not using.
I found the docker label system easier so that I don't have to remember to go to the homepage config and add the new service. I can just add the labels to the other container's compose file.
nice, i use dashy but this looks nice. but, can i use local icons? i want all mor local and not relay on internet services. so can i pick an icon from the local filesystem within docker?
after i JUST setup heimdall last week! 🤣
Thanks for the Kubernetes config. I added a Service and Ingress (with TLS) if you'd like me to submit a PR.
discovered this a few months ago and its awesome, would be great to have a way to easily update it.
Hi Tim - I love your videos. This one, though, maybe too short for me trying to install HomePage in Kubernetes. First, I got an error in VSC when I copied the deployment.yaml around line 38. I believe it is because once you set resources then there is also a need for limits:
I added this code below requests to get it working:
limits:
memory: "512Mi"
cpu: "1000m"
Another issue is that I believe it is best to kubectl apply -f config.yaml and secret.yaml before deploying deployment.yaml - otherwise there is a need for redeploying the workload in Rancher.
Huge thank you for all that you do!
Oh no, I moved from Heimdall to Homer last year and now I need to move to Homepage 😱
Widget stuff never worked for me in Homer (and Heimdall too) because of all x-cors issues, but that's probably due to something else in my crappy setup.
Dude, mind reading. I’ve been thinking of this. I’m a dashy user and was thinking of switching. This is a great video and just the kick in the butt I needed. Thanks again!
This is awesome! Installed it on unraid. But I'm having an issue with getting the key to work with portainer. Says I need to add the env number from the environment endpoint. I use portainer as a server and have agents on each docker container.
So the main list under environments had /endpoint and no number. How do I get this api to work to show all of my containers?
Many thanks
Thank you for that great tuto. Does it has to be what the have setup on widgets? How about I want to add owncloud, another game servers beside minecraft, another services, for example subsonic, onlyoffice, samba webgui and so on? I was trying to add, lets say a Left 4 Dead 2 Server, used the minecraft widget, did not work. Is there another way to add them?
Oh nice. I've been looking for something else to try.
I just switched to Homarr, and it's great. No YAML =D
Last edit: Managed to do it with the service widgets at last. Bottom line. If you make changes t ovariable etc a simple start stop docker won t do it. Maybe a reboot won t do it either. I was trying different things and I couldn t know the difference since each change requires to docker compose up -d again (in the path the docker-compose.yml file exists). Only then it played out immediately !!!
Nice presentation. At 18:18 (if you pause) noticed that for proxmox widget you can set a parameter of api key as password instead of the password itself?
Also as parameter for node option can be whatever name you want or something that correlates with an already proxmox given value in its interface? Because value xing-01/-02/-03 doesnt show up anywhere on the homepage site.
PS
While doing that in an unpriviledged LXC based on Debian 12 and having created a user (lets say dock, but I also tried with root user) who has being added to sudo and docker groups (usermod -aG sudo dock / usermod -aG docker dock), while docker compose up -d started and finished with no errors, even after 5 min if I issue the docker ps command it states the container as Up 6 minutes (unhealthy).
.env and docker-compose.yaml files are inside homepage but configs (for mapping it to :/app/config) is outside homepage path like - /home/dock_user/docker_volumes/configs:/app/config . As a result I dont have anything inside the config folder and typing the ip:3000 get me a refused to connect message.
Any thoughts? By the way docker-copose version shows up ->docker-compose version 1.29.2, build unknown
and plain docker-compose version ->
docker-compose version 1.29.2, build unknown
docker-py version: 5.0.3
CPython version: 3.11.2
OpenSSL version: OpenSSL 3.0.11 19 Sep 2023
I re-created the CT as privileged and did all steps with root (commented PUID,PGID and ENV_FILE) and it played out right away.
So was it the user or the privileged CT? As soon as I used the new created user same unhealthy status. Does all the path
/home/dockuser/docker_volumes/configs/homepage needs to owned both as user and group by the created user or by the docker group?
Hey there,
thanks for the great stuff.
Basically I've now got my homelab running, like proxmox, jellyfin, truenas and so on.
Now also homepage but I struggle to get it running via my kinda reverse proxy (just :80 to externalIp for my traefik).
I've got kubernetes running on 2 nodes, 1 master 1 worker, and a small vm running caddy as a reverse proxy redirecting to my traefik as I know no other easy way like configuring a hostname to the reverse proxys vm.
But now I've got the issue that I can only access it via its externalIp but not via traefik even though traefik finds the service.
Now I've got the deployment running on port 3000, the service mapping 3000 to 80 for traefik and traefik binds to port 80 alongside PathPrefix in ingressroute.
But there I somehow receive a 404 but neither from caddy nor from traefik.
It looks like a 404 from homepage but I dont know why...
Anyone got any ideas?
Not sure if you are using Proxmox PBS but how did you get up the authentication..... I cant get the API key to work with homepage
For the Proxmox URL, do you need to point to the API URL? I'm getting "API Error: Unexpected token 'I', "Internal S"... is not valid JSON"
This is way better than the dashboards I have tried before!
I had my homepage working for about a couple weeks, I made it the day you upload the video, today docker container was stopped without any notizable problem on the server..and after re start it it was again on the demo yaml setings. I will redo my homepage, but is there a way to avoid this? well backup i know, just added proxmox bkup task but I cant figure out what happended
Awesome
Hey, what’s your opinion on using VMs for a small software house? Few Windows VMs for web development, a couple of VMs IIS web server, one VM for SQL server, one VM for TrueNAS, one VM for Firewall OR should we use separate 1U server machines for each purpose?
Dang it, Tim. I went from using Heimdall to using Homer, which was a big step forward already. But now I may switch to Homepage because of you...shame on you! 😜 lol jk, thank you for the introduction. I would switch to Homepage for no longer having to make my own icons alone!
Like it.
maybe stupid question, is there a reason you use compose files instead of portainer stacks?
Ahhh, a rabbit hole project...
Heh funny ... Moved over from Heimdall to Homepage about 2 weeks ago >:D
Tim, in your opinion, between Dashy and Homepage, which is more interesting?
What’s font name you is using in terminal?
The setup doesn't look as easy as homarr, but it has so much more to offer. What terminal are you using?
I don’t want use docker. Any idea to run as systemd service?