Getting Started

Congratulations! You have successfully installed HomelabOS!

Using Included Services

Click Software on the left of this Documentation. Pick the service you want to access. Everything you need to get started with it will be there.

Enabling More Services

Type make set SERVICENAME.enable true where SERVICENAME is the service you want to start.

Securing Services

If you want to add an extra layer of authentication to a service, all you have to do is set servicename.auth to true. If Authelia is enabled, it will handle authentication. Otherwise, Traefik will use HTTP Basic Auth with default_username and default_password as the credentials.

File locations

HomelabOS sets up {{ volumes_root }} on your server, which maps to /var/homelabos by default

Organizr

You should be able to load Organizr at http://{% if organizr.domain %}{{ organizr.domain }}{% else %}{{ organizr.subdomain + "." + domain }}{% endif %}/.

You can click the Settings link, then Edit Tabs to be able to add links to all the various HomelabOS services.

HTTPS via LetsEncrypt

HomelabOS will use Traefik's built in LetsEncrypt integration to automatically generate SSL certificates for your various services. If initially some of the certificates don't appear valid, you have likely run into LetsEncrypt rate limits. Unfortunately the only fix we have for that right now is 'wait a week'.