2.44 KB
Newer Older
1 2 3 4
# Installation

Clone the repository if you have git `git clone` or [download it from GitLab](

Nick Busey's avatar
Nick Busey committed
5 6 7
Make sure you have Ansible 2.5+ installed on your computer.

Ensure you can access your server with a local IP through [passwordless SSH]( and your user has [passwordless sudo](

From inside the HomelabOS folder execute the terminal command `make setup` to configure your server settings.

Once that is done, you can run `make` to have HomelabOS install itself.

To configure additional services, look at the options available in `group_vars/all` and override them in `host_vars/myserver`.

You can always change settings by hand in `host_vars/myserver` and re-run `make` again to update the server with your new settings.
16 17 18 19 20

## Network Configuration

It is recommended to register an actual domain to point at your Homelab, but if you can't or would prefer not to, you can use HomelabOS fully inside your network. Simply make up a domain that ends in `.local` and enter that as your domain in `host_vars/myserver`.

When HomelabOS `make` command completes, it creates a file on the computer which ran make `/tmp/homelabos_hosts`. You can take the contents of this file and create local DNS overrides using it. All your requests should complete as expected.
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

## NAS Network Area Storage Configuration

It is a good idea to keep your files as a whole, media, documents, etc., on a Network Area Storage device or NAS.

For a typical HomelabOS setup you will want at least the following directories inside your NAS:


All you have to do is enter your NAS network path, username and password into your `host_vars/myserver` file. You can find the template in `host_vars/all` in the `# NAS Config` section.

It should look something like this, depending on your setup:

nas_path: //
nas_user: guest
nas_workgroup: WORKGROUP

This NAS resource will be mounted under `/mnt/nas` in the various containers that would benefit from access.

Assuming you have created the folders above, for [Emby](/software/emby) for example you could point it to `/mnt/nas/tv` and `/mnt/nas/movies` while [Paperless](/software/paperless) would point at `/mnt/nas/documents`.