Skip to content

Latest commit

 

History

History
68 lines (38 loc) · 2.9 KB

variablehelp.md

File metadata and controls

68 lines (38 loc) · 2.9 KB
Raw

Variable Help

This document includes help for setting up your variables in the group_vars/all/vars.yml file. Remove <> tags but keep your variables inside of the "". Please be mindful that some passwords and API keys are in plain text.

username: Your Ubuntu username you chose at setup.

puid: Run the id command on your server and use the value in the uid field.

pgid: Run the id command on your server and use the value in the gid field.

ip_address: Your server IP address. Run the ip a on your server to see your IP.

timezone: Your timezone. Run the timedatectl list-timezones command to see what is a valid timezone.

domain: Your domain name

cloudflare_email: The email you used to sign up for Cloudflare

cloudflare_api_key: Your Cloudflare global API key

traefik_basic_auth_hash: Generate your hashed login credentials with the following command:

echo $(htpasswd -nb "<USER>" "<PASSWORD>") | sed -e s/\\$/\\$\\$/g

Replace <USER> with your username and <PASSWORD> with your password to be hashed.

jwt_secret: A random alphanumeric string. Generate it with this command:

docker run authelia/authelia:latest authelia crypto rand --length 64 --charset alphanumeric

authelia_sqlite_encryption_key: A random alphanumeric string with at least 20 characters. Run the command above to generate one. Don't reuse keys.

google_mail: Your google email

google_insecure_app_pass: An app password that allows SMTP through google. See instructions on how to get yours. Make sure it's the same account that's used above.

authelia_admin_mail: The admin email used in Authelia

authelia_admin_argon2id_pass: A hashed password using the Argon2 encryption algorithm.

docker run authelia/authelia:latest authelia crypto hash generate argon2 --password '<PASSWORD>'

vaultwarden_admin_argon2id_pass: Use the command above to generate a hashed password. Don't reuse passwords.

wg_password: The password to login into your wireguard client.

codeserver_password: The password to login into your code server client.

pihole_password: The password to login into your pihole client.

mysql_password: The password to login into your mysql client.

vpn_provider: The VPN provider you have an account with. See supported VPN Clients

vpn_config: The VPN server you want your Transmission client to connect to. Example: nl_all

vpn_username: The username you used to sign up to a VPN service.

vpn_password: The password you used to sign up to a VPN service.

local_network: Your local network. See how to find it Example: 192.168.0.0/16