Repository navigation
Expand file tree
/
Copy path.env.example
More file actions
87 lines (72 loc) · 4.07 KB
/
Copy path.env.example
File metadata and controls
87 lines (72 loc) · 4.07 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# candygoogy-bot configuration. Copy this file and fill it in:
# systemd: /etc/candygoogy/bot.env (see deploy/candygoogy-bot.service)
# Docker: .env next to docker-compose.yml
# local: .env next to bot.py
# Never commit the real file. `python bot.py --check-config` checks it.
#
# Every UNCOMMENTED variable below is required (deploy/check-env.sh enforces
# that before a restart). Everything commented is optional, shown with its
# default or an example. The example values are placeholders: they don't work.
# --- Required ------------------------------------------------------------------
# The bot's token from @BotFather.
BOT_TOKEN=123456:replace-with-your-bot-token
# Who may use the bot: Telegram user IDs, separated by commas. Messages the bot
# sends on its own (alerts, summaries) go to each of them.
AUTHORIZED_USER_IDS=your-telegram-user-id
# --- The machines -------------------------------------------------------------------
# Set EITHER the four lines of one Windows PC, OR MACHINES_FILE (any number of
# Windows, Linux and macOS machines), not both.
# One Windows PC: its MAC (for Wake-on-LAN), its fixed IP, and the user the bot
# logs in as over SSH.
# WORKSTATION_MAC=00:00:5e:00:53:01
# WORKSTATION_IP=192.0.2.10
# SSH_USER=botuser
# The bot's private SSH key (no passphrase). Default: ~/.ssh/id_ed25519 of the
# user the bot runs as. With MACHINES_FILE, it's the default for every machine.
# The systemd unit and docker-compose.yml set it to /etc/candygoogy/ssh/id_ed25519.
# SSH_KEY_PATH=/etc/candygoogy/ssh/id_ed25519
# Several machines, or a Linux or macOS one: a TOML file, see machines.example.toml.
# MACHINES_FILE=/etc/candygoogy/machines.toml
# --- Optional -------------------------------------------------------------------------
# Where ssh records each machine's host key. Default: ssh's own ~/.ssh/known_hosts.
# The systemd unit and the Docker image set it to the bot's state directory.
# SSH_KNOWN_HOSTS=/var/lib/candygoogy-bot/known_hosts
# Time zone for clock times like "22:30" and everything the bot shows (read by
# Python itself, not checked by the bot). Default: the host's zone; /about shows it.
# TZ=America/New_York
# When the daily summary is sent (HH:MM, in the time zone above), or off.
# DIGEST_TIME=08:00
# When the weekly report is sent (a weekday and HH:MM), or off.
# WEEKLY_REPORT=sun 20:00
# /homelab: the disks to watch, comma-separated. / is the system disk; any other
# path is a mount that must stay mounted. Default: /
# HOMELAB_DISKS=/,/srv/data
# Where your backup job writes its YYYYMMDD-HHMMSS snapshot folders. Unset: no
# backup checks.
# BACKUP_DIR=/srv/backups
# Hours without a completed backup before /homelab warns. Default: 26
# BACKUP_MAX_AGE_HOURS=26
# Alert when the host's CPU reaches this temperature, in whole °C from 40 to
# 110. /homelab shows the temperature either way, if the host has a sensor.
# Unset: no temperature alert.
# HOMELAB_TEMP_ALERT_C=85
# Where /homelab asks Docker for its containers: unix:///<socket> or
# tcp://<host>:<port>. Default: unix:///var/run/docker.sock
# DOCKER_HOST=unix:///run/docker-proxy/docker.sock
# Where the internet check connects, comma-separated host:port ([IPv6]:port), 1-5.
# Default: 1.1.1.1:443,9.9.9.9:443
# INTERNET_CHECK_TARGETS=1.1.1.1:443,9.9.9.9:443
# --- Containers (the Docker image sets these; rarely set by hand) -------------------
# 1 when the bot runs in a container: services, updates and reboots belong to
# the host, so they aren't checked. Default: 0
# CANDYGOOGY_IN_CONTAINER=1
# Where the host's / is mounted in the container (read-only), for accurate
# disks, mount checks and "reboot required". Unset: the container's own /.
# HOMELAB_HOST_ROOT=/host
# The commit the image was built from, shown by /about: 7-40 of 0-9 a-f.
# CANDYGOOGY_COMMIT=0123456789abcdef0123456789abcdef01234567
# --- Docker Compose (read by docker-compose.yml, not by the bot) ---------------------
# Which published image to run: ghcr.io/candygoogy/candygoogy-bot:<tag>.
# Default: 1 (the latest 1.x release). Pin it with an exact version, or a
# version and its digest: 1.1.0@sha256:<digest>.
# CANDYGOOGY_TAG=1.1.0