@tmlmobilidade/backupd 20260406.1442.3 → 20260407.1655.56
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/config.example.yaml +106 -106
- package/package.json +1 -1
package/config.example.yaml
CHANGED
|
@@ -1,106 +1,106 @@
|
|
|
1
|
-
# This is an example configuration file for backupd.
|
|
2
|
-
# It is not used by the application, but it is a template for the configuration file needed to run the backupd service
|
|
3
|
-
|
|
4
|
-
# The configuration file is a YAML file, which is a human-readable data serialization format.
|
|
5
|
-
# It is used to configure the backupd service.
|
|
6
|
-
|
|
7
|
-
# The Storage Configuration
|
|
8
|
-
storage:
|
|
9
|
-
# The type of storage service to use. Options: "aws" (AWS) | "oci" (Oracle Cloud Infrastructure Object Storage)
|
|
10
|
-
type: STORAGE_TYPE
|
|
11
|
-
|
|
12
|
-
# The AWS configuration
|
|
13
|
-
aws_config:
|
|
14
|
-
aws_access_key_id: YOUR_AWS_ACCESS_KEY_ID
|
|
15
|
-
aws_secret_access_key: YOUR_AWS_SECRET_ACCESS_KEY
|
|
16
|
-
bucket_name: YOUR_BUCKET_NAME
|
|
17
|
-
region: YOUR_REGION
|
|
18
|
-
|
|
19
|
-
# The Oracle Cloud Infrastructure Object Storage configuration
|
|
20
|
-
oci_config:
|
|
21
|
-
user: OCI_USER
|
|
22
|
-
fingerprint: OCI_FINGERPRINT
|
|
23
|
-
tenancy: OCI_TENANCY
|
|
24
|
-
region: OCI_REGION
|
|
25
|
-
private_key: OCI_PRIVATE_KEY # The private key of the user in PEM format
|
|
26
|
-
namespace: OCI_NAMESPACE
|
|
27
|
-
bucket_name: OCI_BUCKET_NAME
|
|
28
|
-
|
|
29
|
-
# The Cloudflare R2 configuration
|
|
30
|
-
r2_config:
|
|
31
|
-
account_id: YOUR_ACCOUNT_ID
|
|
32
|
-
access_key_id: YOUR_ACCESS_KEY_ID
|
|
33
|
-
secret_access_key: YOUR_SECRET_ACCESS_KEY
|
|
34
|
-
bucket_name: YOUR_BUCKET_NAME
|
|
35
|
-
endpoint: YOUR_ENDPOINT # https://<account_id>.r2.cloudflarestorage.com
|
|
36
|
-
|
|
37
|
-
# The Database Configuration
|
|
38
|
-
database:
|
|
39
|
-
# The type of database service to use. Options: "mongodb" (MongoDB) | "postgres" (PostgreSQL)
|
|
40
|
-
type: DATABASE_TYPE
|
|
41
|
-
|
|
42
|
-
# The MongoDB configuration (required if type is mongodb)
|
|
43
|
-
mongodb_config:
|
|
44
|
-
uri: YOUR_MONGODB_URI
|
|
45
|
-
options: # (Optional) The options to pass to the MongoDB client.
|
|
46
|
-
# The time in milliseconds to attempt a connection before timing out.
|
|
47
|
-
connectTimeoutMS: 10000
|
|
48
|
-
# Whether to use direct connection to the MongoDB server.
|
|
49
|
-
directConnection: true
|
|
50
|
-
# The maximum number of connections in the connection pool.
|
|
51
|
-
maxPoolSize: 10
|
|
52
|
-
# The minimum number of connections in the connection pool.
|
|
53
|
-
minPoolSize: 5
|
|
54
|
-
# The read preference to use. Options: "primary" | "primaryPreferred" | "secondary" | "secondaryPreferred" | "nearest"
|
|
55
|
-
readPreference: YOUR_READ_PREFERENCE
|
|
56
|
-
# The time in milliseconds to wait for a server to respond to a request before timing out.
|
|
57
|
-
serverSelectionTimeoutMS: 10000
|
|
58
|
-
# (Optional) The MongoDB dump options.
|
|
59
|
-
dump_options:
|
|
60
|
-
# (Optional) The database name to dump.
|
|
61
|
-
database: YOUR_DATABASE_NAME
|
|
62
|
-
# (Optional) The collections to exclude from the dump.
|
|
63
|
-
exclude_collections:
|
|
64
|
-
- YOUR_COLLECTION_NAME
|
|
65
|
-
- YOUR_COLLECTION_NAME
|
|
66
|
-
|
|
67
|
-
# The PostgreSQL configuration (required if type is postgres)
|
|
68
|
-
postgres_config:
|
|
69
|
-
uri: YOUR_POSTGRES_URI
|
|
70
|
-
options: # (Optional) The options to pass to the PostgreSQL client.
|
|
71
|
-
# The maximum number of connections in the connection pool.
|
|
72
|
-
max: 10
|
|
73
|
-
# The minimum number of connections in the connection pool.
|
|
74
|
-
min: 5
|
|
75
|
-
|
|
76
|
-
# The Backup Configuration
|
|
77
|
-
backup:
|
|
78
|
-
# The interval between backups in minutes.
|
|
79
|
-
interval: 360 # 6 hour
|
|
80
|
-
# Backup destination directory.
|
|
81
|
-
destination: PATH_TO_BACKUP_DESTINATION_DIRECTORY
|
|
82
|
-
# The remote destination directory.
|
|
83
|
-
remote_destination: PATH_TO_REMOTE_DESTINATION_DIRECTORY
|
|
84
|
-
# The maximum number of backups to keep. (If undefined or 0, no backups will be deleted.)
|
|
85
|
-
max_remote_backups: 10
|
|
86
|
-
# The maximum number of backup files to keep in the storage. (If set to 0, no backups will be stored in the device storage.)
|
|
87
|
-
max_local_backups: 10
|
|
88
|
-
|
|
89
|
-
# The Email Configuration (if not set, no email will be sent)
|
|
90
|
-
email:
|
|
91
|
-
# Whether to send the backup success report.
|
|
92
|
-
send_success: true
|
|
93
|
-
# Whether to send the backup failure report.
|
|
94
|
-
send_failure: true
|
|
95
|
-
# The mail options.
|
|
96
|
-
mail_options:
|
|
97
|
-
from: FROM_EMAIL_ADDRESS
|
|
98
|
-
to: TO_EMAIL_ADDRESS
|
|
99
|
-
subject: BACKUP_REPORT_SUBJECT
|
|
100
|
-
# The SMTP server configuration.
|
|
101
|
-
smtp:
|
|
102
|
-
host: YOUR_SMTP_HOST
|
|
103
|
-
port: YOUR_SMTP_PORT
|
|
104
|
-
auth:
|
|
105
|
-
user: YOUR_SMTP_USER
|
|
106
|
-
pass: YOUR_SMTP_PASSWORD
|
|
1
|
+
# This is an example configuration file for backupd.
|
|
2
|
+
# It is not used by the application, but it is a template for the configuration file needed to run the backupd service
|
|
3
|
+
|
|
4
|
+
# The configuration file is a YAML file, which is a human-readable data serialization format.
|
|
5
|
+
# It is used to configure the backupd service.
|
|
6
|
+
|
|
7
|
+
# The Storage Configuration
|
|
8
|
+
storage:
|
|
9
|
+
# The type of storage service to use. Options: "aws" (AWS) | "oci" (Oracle Cloud Infrastructure Object Storage)
|
|
10
|
+
type: STORAGE_TYPE
|
|
11
|
+
|
|
12
|
+
# The AWS configuration
|
|
13
|
+
aws_config:
|
|
14
|
+
aws_access_key_id: YOUR_AWS_ACCESS_KEY_ID
|
|
15
|
+
aws_secret_access_key: YOUR_AWS_SECRET_ACCESS_KEY
|
|
16
|
+
bucket_name: YOUR_BUCKET_NAME
|
|
17
|
+
region: YOUR_REGION
|
|
18
|
+
|
|
19
|
+
# The Oracle Cloud Infrastructure Object Storage configuration
|
|
20
|
+
oci_config:
|
|
21
|
+
user: OCI_USER
|
|
22
|
+
fingerprint: OCI_FINGERPRINT
|
|
23
|
+
tenancy: OCI_TENANCY
|
|
24
|
+
region: OCI_REGION
|
|
25
|
+
private_key: OCI_PRIVATE_KEY # The private key of the user in PEM format
|
|
26
|
+
namespace: OCI_NAMESPACE
|
|
27
|
+
bucket_name: OCI_BUCKET_NAME
|
|
28
|
+
|
|
29
|
+
# The Cloudflare R2 configuration
|
|
30
|
+
r2_config:
|
|
31
|
+
account_id: YOUR_ACCOUNT_ID
|
|
32
|
+
access_key_id: YOUR_ACCESS_KEY_ID
|
|
33
|
+
secret_access_key: YOUR_SECRET_ACCESS_KEY
|
|
34
|
+
bucket_name: YOUR_BUCKET_NAME
|
|
35
|
+
endpoint: YOUR_ENDPOINT # https://<account_id>.r2.cloudflarestorage.com
|
|
36
|
+
|
|
37
|
+
# The Database Configuration
|
|
38
|
+
database:
|
|
39
|
+
# The type of database service to use. Options: "mongodb" (MongoDB) | "postgres" (PostgreSQL)
|
|
40
|
+
type: DATABASE_TYPE
|
|
41
|
+
|
|
42
|
+
# The MongoDB configuration (required if type is mongodb)
|
|
43
|
+
mongodb_config:
|
|
44
|
+
uri: YOUR_MONGODB_URI
|
|
45
|
+
options: # (Optional) The options to pass to the MongoDB client.
|
|
46
|
+
# The time in milliseconds to attempt a connection before timing out.
|
|
47
|
+
connectTimeoutMS: 10000
|
|
48
|
+
# Whether to use direct connection to the MongoDB server.
|
|
49
|
+
directConnection: true
|
|
50
|
+
# The maximum number of connections in the connection pool.
|
|
51
|
+
maxPoolSize: 10
|
|
52
|
+
# The minimum number of connections in the connection pool.
|
|
53
|
+
minPoolSize: 5
|
|
54
|
+
# The read preference to use. Options: "primary" | "primaryPreferred" | "secondary" | "secondaryPreferred" | "nearest"
|
|
55
|
+
readPreference: YOUR_READ_PREFERENCE
|
|
56
|
+
# The time in milliseconds to wait for a server to respond to a request before timing out.
|
|
57
|
+
serverSelectionTimeoutMS: 10000
|
|
58
|
+
# (Optional) The MongoDB dump options.
|
|
59
|
+
dump_options:
|
|
60
|
+
# (Optional) The database name to dump.
|
|
61
|
+
database: YOUR_DATABASE_NAME
|
|
62
|
+
# (Optional) The collections to exclude from the dump.
|
|
63
|
+
exclude_collections:
|
|
64
|
+
- YOUR_COLLECTION_NAME
|
|
65
|
+
- YOUR_COLLECTION_NAME
|
|
66
|
+
|
|
67
|
+
# The PostgreSQL configuration (required if type is postgres)
|
|
68
|
+
postgres_config:
|
|
69
|
+
uri: YOUR_POSTGRES_URI
|
|
70
|
+
options: # (Optional) The options to pass to the PostgreSQL client.
|
|
71
|
+
# The maximum number of connections in the connection pool.
|
|
72
|
+
max: 10
|
|
73
|
+
# The minimum number of connections in the connection pool.
|
|
74
|
+
min: 5
|
|
75
|
+
|
|
76
|
+
# The Backup Configuration
|
|
77
|
+
backup:
|
|
78
|
+
# The interval between backups in minutes.
|
|
79
|
+
interval: 360 # 6 hour
|
|
80
|
+
# Backup destination directory.
|
|
81
|
+
destination: PATH_TO_BACKUP_DESTINATION_DIRECTORY
|
|
82
|
+
# The remote destination directory.
|
|
83
|
+
remote_destination: PATH_TO_REMOTE_DESTINATION_DIRECTORY
|
|
84
|
+
# The maximum number of backups to keep. (If undefined or 0, no backups will be deleted.)
|
|
85
|
+
max_remote_backups: 10
|
|
86
|
+
# The maximum number of backup files to keep in the storage. (If set to 0, no backups will be stored in the device storage.)
|
|
87
|
+
max_local_backups: 10
|
|
88
|
+
|
|
89
|
+
# The Email Configuration (if not set, no email will be sent)
|
|
90
|
+
email:
|
|
91
|
+
# Whether to send the backup success report.
|
|
92
|
+
send_success: true
|
|
93
|
+
# Whether to send the backup failure report.
|
|
94
|
+
send_failure: true
|
|
95
|
+
# The mail options.
|
|
96
|
+
mail_options:
|
|
97
|
+
from: FROM_EMAIL_ADDRESS
|
|
98
|
+
to: TO_EMAIL_ADDRESS
|
|
99
|
+
subject: BACKUP_REPORT_SUBJECT
|
|
100
|
+
# The SMTP server configuration.
|
|
101
|
+
smtp:
|
|
102
|
+
host: YOUR_SMTP_HOST
|
|
103
|
+
port: YOUR_SMTP_PORT
|
|
104
|
+
auth:
|
|
105
|
+
user: YOUR_SMTP_USER
|
|
106
|
+
pass: YOUR_SMTP_PASSWORD
|