Skip to content

Getting Started

Once you are all setup and ready to go you should be able to load Organizr at http://{% if organizr.domain %}{{ organizr.domain }}{% else %}{{ organizr.subdomain + "." + domain }}{% endif %}/.

If you see { domain } in the link above, you are either viewing these docs on the hosted GitLab pages and not actually through HomelabOS, or something is configured incorrectly.

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

Using Organizr

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

In the very near future, HomelabOS will provision these tab links for you automatically.

The URLs for all the services can be found in their individual documentation section.

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'.

Homelab Commands

make -t will list all available commands. make -h COMMAND will show help info for the specified command.

Last update: July 23, 2021