config.yml.j2 4.23 KB
Newer Older
1 2 3 4 5 6
# These are the default settings. Copy this file to `host_vars/myserver` then in that file set the values to match your setup.

### REQUIRED ### 
# These values are REQUIRED for HomelabOS to work.

# Default user name to create as admin with services
Nick Busey's avatar
Nick Busey committed
7
default_username: {{default_username}}
8 9

# Default password to go with the default user
Nick Busey's avatar
Nick Busey committed
10
default_password: {{default_password}}
11 12

# User name used to connect via ssh. Must have passwordless sudo.
Nick Busey's avatar
Nick Busey committed
13
tincserver_ssh_user: {{tincserver_ssh_user}}
Nick Busey's avatar
Nick Busey committed
14
homelab_ssh_user: {{homelab_ssh_user}}
15 16

# SSH accessible IP address
Nick Busey's avatar
Nick Busey committed
17
tincserver_ip: {{tincserver_ip}}
Nick Busey's avatar
Nick Busey committed
18
homelab_ip: {{homelab_ip}}
19 20

# Timezone of the server
Nick Busey's avatar
Nick Busey committed
21
common_timezone: {{common_timezone}}
22 23 24

# Domain that will be used to point at the server
# Must have a DNS A record of `*.yourserver.com` pointing at your server's IP.
Nick Busey's avatar
Nick Busey committed
25
domain: {{domain}}
26 27 28

# An email that is accessible outside of HomelabOS that you can receive system alerts and notices at.
# Necessary for SSL / LetsEncrypt to work.
Nick Busey's avatar
Nick Busey committed
29
admin_email: {{admin_email}}
30 31 32 33 34

# Features

# You can enable/disable different HomelabOS features here by changing False to True and vice versa.

Nick Busey's avatar
Nick Busey committed
35
enable_tinc: {{enable_tinc}}
Nick Busey's avatar
Nick Busey committed
36
enable_tor: {{enable_tor}}
37 38 39 40 41

# Services

# You can enable/disable services individually by changing False to True and vice versa.

Nick Busey's avatar
Nick Busey committed
42 43
enable_apple_health_influx: {{enable_apple_health_influx}}
enable_bitwarden: {{enable_bitwarden}}
Nick Busey's avatar
Nick Busey committed
44
enable_bookstack: {{enable_bookstack}}
Nick Busey's avatar
Nick Busey committed
45 46 47
enable_bulletnotes: {{enable_bulletnotes}}
enable_darksky_influx: {{enable_darksky_influx}}
enable_dasher: {{enable_dasher}}
48
enable_docs: {{enable_docs}}
Nick Busey's avatar
Nick Busey committed
49 50 51 52 53
enable_emby: {{enable_emby}}
enable_firefly_iii: {{enable_firefly_iii}}
enable_gitea: {{enable_gitea}}
enable_grafana: {{enable_grafana}}
enable_homeassistant: {{enable_homeassistant}}
54
enable_homedash: {{enable_homedash}}
Nick Busey's avatar
Nick Busey committed
55
enable_inventario: {{enable_inventario}}
Nick Busey's avatar
Nick Busey committed
56 57
enable_jackett: {{enable_jackett}}
enable_kibitzr: {{enable_kibitzr}}
58
enable_mashio: {{enable_mashio}}
Nick Busey's avatar
Nick Busey committed
59 60 61 62 63 64
enable_matomo: {{enable_matomo}}
enable_miniflux: {{enable_miniflux}}
enable_minio: {{enable_minio}}
enable_monicahq: {{enable_monicahq}}
enable_nextcloud: {{enable_nextcloud}}
enable_nzbget: {{enable_nzbget}}
65
enable_openldap: {{enable_openldap}}
Nick Busey's avatar
Nick Busey committed
66 67 68 69 70 71 72 73 74 75 76
enable_openvpn: {{enable_openvpn}}
enable_organizr: {{enable_organizr}}
enable_paperless: {{enable_paperless}}
enable_pihole: {{enable_pihole}}
enable_plex: {{enable_plex}}
enable_portainer: {{enable_portainer}}
enable_sonarr: {{enable_sonarr}}
enable_radarr: {{enable_radarr}}
enable_restic: {{enable_restic}}
enable_syncthing: {{enable_syncthing}}
enable_thelounge: {{enable_thelounge}}
77
enable_tick: {{enable_tick}}
Nick Busey's avatar
Nick Busey committed
78 79
enable_transmission: {{enable_transmission}}
enable_xfinityusageinfluxdb: {{enable_xfinityusageinfluxdb}}
80 81

### END REQUIRED ###
Nick Busey's avatar
Nick Busey committed
82

83 84 85
### OPTIONAL ### These valuse are OPTIONAL and enable extra HomelabOS functionality.

# Your DarkSky API Key. Get one at http://darksky.net/dev
Nick Busey's avatar
Nick Busey committed
86
darksky_key: {{darksky_key}}
87 88

# Your location
Nick Busey's avatar
Nick Busey committed
89 90
latitude: {{latitude}}
longitude: {{longitude}}
91 92

# VPN For Transmission to use for Downloads
Nick Busey's avatar
Nick Busey committed
93 94 95
openvpn_provider: {{openvpn_provider}}
openvpn_username: {{openvpn_username}}
openvpn_password: {{openvpn_password}}
96
openvpn_config: {{openvpn_config}}
97 98

# NAS Config name: Docs: https://nickbusey.gitlab.io/HomelabOS/setup/installation/#nas-network-area-storage-configuration
Nick Busey's avatar
Nick Busey committed
99 100 101 102
nas_path: {{nas_path}}
nas_user: {{nas_user}}
nas_pass: {{nas_pass}}
nas_workgroup: {{nas_workgroup}}
103 104

# Restic S3 Backup Server Information name: Docs: https://nickbusey.gitlab.io/HomelabOS/setup/backups/
Nick Busey's avatar
Nick Busey committed
105 106 107
s3_access_key: {{s3_access_key}}
s3_secret_key: {{s3_secret_key}}
s3_backup_password: {{s3_backup_password}}
108 109

# Example: 0 4 * * *
110
# Backup every day at 4:00 AM
Nick Busey's avatar
Nick Busey committed
111
s3_backup_cron: {{s3_backup_cron}}
112 113

# Home Assitant API Key
Nick Busey's avatar
Nick Busey committed
114
homeassistant_api_key: {{homeassistant_api_key}}
115 116

# Apple Health Data Importer name: Docs: https://nickbusey.gitlab.io/HomelabOS/software/applehealth/
Nick Busey's avatar
Nick Busey committed
117
apple_health_nextcloud_username: {{apple_health_nextcloud_username}}
118 119

# Xfinity Data Usage Settings
Nick Busey's avatar
Nick Busey committed
120 121
xfinity_user: {{xfinity_user}}
xfinity_password: {{xfinity_password}}
122 123

# Monica Settings
Nick Busey's avatar
Nick Busey committed
124
monica_db_password: {{monica_db_password}}
125 126

# SMTP Settings
Nick Busey's avatar
Nick Busey committed
127 128 129 130 131 132
smtp_host: {{smtp_host}}
smtp_port: {{smtp_port}}
smtp_user: {{smtp_user}}
smtp_pass: {{smtp_pass}}
smtp_from_email: {{smtp_from_email}}
smtp_from_name: {{smtp_from_name}}
133 134 135

# LDAP Settings
ldap_org_name: {{ldap_org_name}}