Backrest-Summary-Reporter/.env.example at master · estes-sj/Backrest-Summary-Reporter · GitHub

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
88
89
90
91
92
93
####################################
# Database Configuration
####################################

DB_USERNAME=your_db_username                       # Username used to connect to the PostgreSQL database
DB_PASSWORD=your_secure_db_password                # Password for the PostgreSQL user

####################################
# Authentication
####################################

AUTH_KEY=your_random_authentication_key            # Secret key used to authenticate requests to internal endpoints (keep this secure)

####################################
# Notification Settings
####################################

SMTP_HOST=smtp.yourprovider.com                              # SMTP server hostname (e.g. smtp.gmail.com)
SMTP_PORT=587                                                # SMTP port (commonly 587 for TLS or 465 for SSL)
SMTP_USERNAME=your_email@example.com                         # SMTP username (usually your email address)
SMTP_PASSWORD=your_email_app_password                        # SMTP password or app-specific password (never use your main email password)
EMAIL_FROM=Your App Name <your_email@example.com>            # Email address and display name emails will be sent from
EMAIL_TO=receiver_email@example.com                          # Comma-separated list of recipient email addresses

# EMAIL_FREQUENCY, STATS_INTERVAL, and NUM_RETAINED_REPORTS are optional, used to control when and what gets included in email reports

EMAIL_FREQUENCY=0 0 0 * * *                                  # Cron schedule UTC format (e.g., every day at midnight UTC); default is every day at midnight UTC
STATS_INTERVAL=24                                            # Interval (in hours) of backup data to include in the email (e.g., 24 = last 24 hours); default is 24 hours
NUM_RETAINED_REPORTS=10                                      # Number of retained reports stored; oldest ones are deleted first when in excess; default is 10

HEALTHCHECK_PING_URL=https://hc-ping.com/ping/ping-key/slug  # Optional healthcheck URL

SEND_STARTUP_EMAIL=False                                     # Optional email when the container is started. Set to `TRUE` or `1` to enable.

####################################
# Rclone Mount Configuration (If Using an Rclone-Mounter)
####################################

RCLONE_REMOTE=google_drive:             # Your rclone remote name (must end with a colon)
RCLONE_TARGET=/mnt-rclone/google_drive  # The path inside the container where the remote is mounted

####################################
# Storage Monitoring Configuration
####################################

# Any number of storage paths can be configured using the numbered pattern.
# These are inside-the-container paths where backup archives are located.
# The nicknames will be shown in the email summary.

# If a STORAGE_PATH_N is provided but its corresponding STORAGE_NICK_N is blank,
# the STORAGE_PATH_N will be used.

STORAGE_PATH_1=/mnt/opt
STORAGE_NICK_1=sam-fedserver01-opt

STORAGE_PATH_2=/mnt/mnt
STORAGE_NICK_2=External Drive 01

# Uncomment and populate additional entries as needed:
# STORAGE_PATH_3=/mnt/another/path
# STORAGE_NICK_3=Another Storage

# STORAGE_PATH_4=
# STORAGE_NICK_4=

# STORAGE_PATH_5=
# STORAGE_NICK_5=

# STORAGE_PATH_6=
# STORAGE_NICK_6=

# STORAGE_PATH_7=
# STORAGE_NICK_7=

# STORAGE_PATH_8=
# STORAGE_NICK_8=

# STORAGE_PATH_9=
# STORAGE_NICK_9=

###########################################
# (Optional) Server Info and Service URLs
###########################################

SERVER_NAME=Your Server Name                       # Human-readable name of the server/environment used in email reports
BACKREST_URL=https://backrest.your-domain.com/     # URL to Backrest backup management UI/API used in email reports
PGADMIN_URL=https://pg.your-domain.com/            # URL to pgAdmin database management interface used in email reports

###########################################
# Timezone Configuration
###########################################

TZ=America/New_York                                # Timezone for the application (e.g., UTC, America/New_York)