More inclusive language.
This commit is contained in:
parent
f2f6fb537a
commit
065be1d9d4
7 changed files with 18 additions and 18 deletions
|
@ -7,8 +7,8 @@ permalink: security-policy/index.html
|
||||||
|
|
||||||
While we want to hear about security vulnerabilities in all versions of
|
While we want to hear about security vulnerabilities in all versions of
|
||||||
borgmatic, security fixes are only made to the most recently released version.
|
borgmatic, security fixes are only made to the most recently released version.
|
||||||
It's simply not practical for our small volunteer effort to maintain multiple
|
It's not practical for our small volunteer effort to maintain multiple release
|
||||||
release branches and put out separate security patches for each.
|
branches and put out separate security patches for each.
|
||||||
|
|
||||||
## Reporting a vulnerability
|
## Reporting a vulnerability
|
||||||
|
|
||||||
|
|
|
@ -17,8 +17,8 @@ def resolve_archive_name(
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, an archive name, a storage config dict, a local Borg
|
Given a local or remote repository path, an archive name, a storage config dict, a local Borg
|
||||||
path, and a remote Borg path, simply return the archive name. But if the archive name is
|
path, and a remote Borg path, return the archive name. But if the archive name is "latest",
|
||||||
"latest", then instead introspect the repository for the latest archive and return its name.
|
then instead introspect the repository for the latest archive and return its name.
|
||||||
|
|
||||||
Raise ValueError if "latest" is given but there are no archives in the repository.
|
Raise ValueError if "latest" is given but there are no archives in the repository.
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -260,7 +260,7 @@ def merge_source_configuration_into_destination(destination_config, source_confi
|
||||||
)
|
)
|
||||||
continue
|
continue
|
||||||
|
|
||||||
# This is some sort of scalar. Simply set it into the destination.
|
# This is some sort of scalar. Set it into the destination.
|
||||||
destination_config[field_name] = source_config[field_name]
|
destination_config[field_name] = source_config[field_name]
|
||||||
|
|
||||||
return destination_config
|
return destination_config
|
||||||
|
|
|
@ -60,7 +60,7 @@ properties:
|
||||||
or port. If systemd service is used, then add local
|
or port. If systemd service is used, then add local
|
||||||
repository paths in the systemd service file to the
|
repository paths in the systemd service file to the
|
||||||
ReadWritePaths list. Prior to borgmatic 1.7.10, repositories
|
ReadWritePaths list. Prior to borgmatic 1.7.10, repositories
|
||||||
was just a list of plain path strings.
|
was a list of plain path strings.
|
||||||
example:
|
example:
|
||||||
- path: ssh://user@backupserver/./sourcehostname.borg
|
- path: ssh://user@backupserver/./sourcehostname.borg
|
||||||
label: backupserver
|
label: backupserver
|
||||||
|
@ -1216,7 +1216,7 @@ properties:
|
||||||
type: string
|
type: string
|
||||||
description: |
|
description: |
|
||||||
Healthchecks ping URL or UUID to notify when a
|
Healthchecks ping URL or UUID to notify when a
|
||||||
backup begins, ends, errors or just to send logs.
|
backup begins, ends, errors, or to send only logs.
|
||||||
example: https://hc-ping.com/your-uuid-here
|
example: https://hc-ping.com/your-uuid-here
|
||||||
verify_tls:
|
verify_tls:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
|
|
@ -139,8 +139,8 @@ hooks:
|
||||||
### Containers
|
### Containers
|
||||||
|
|
||||||
If your database is running within a container and borgmatic is too, no
|
If your database is running within a container and borgmatic is too, no
|
||||||
problem—simply configure borgmatic to connect to the container's name on its
|
problem—configure borgmatic to connect to the container's name on its exposed
|
||||||
exposed port. For instance:
|
port. For instance:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
hooks:
|
hooks:
|
||||||
|
@ -179,7 +179,7 @@ hooks:
|
||||||
password: trustsome1
|
password: trustsome1
|
||||||
```
|
```
|
||||||
|
|
||||||
Of course, alter the ports in these examples to suit your particular database
|
You can alter the ports in these examples to suit your particular database
|
||||||
system.
|
system.
|
||||||
|
|
||||||
|
|
||||||
|
@ -397,9 +397,9 @@ dumps with any database system.
|
||||||
With PostgreSQL and MySQL/MariaDB, if you're getting authentication errors
|
With PostgreSQL and MySQL/MariaDB, if you're getting authentication errors
|
||||||
when borgmatic tries to connect to your database, a natural reaction is to
|
when borgmatic tries to connect to your database, a natural reaction is to
|
||||||
increase your borgmatic verbosity with `--verbosity 2` and go looking in the
|
increase your borgmatic verbosity with `--verbosity 2` and go looking in the
|
||||||
logs. You'll notice however that your database password does not show up in
|
logs. You'll notice though that your database password does not show up in the
|
||||||
the logs. This is likely not the cause of the authentication problem unless
|
logs. This is likely not the cause of the authentication problem unless you
|
||||||
you mistyped your password, however; borgmatic passes your password to the
|
mistyped your password, however; borgmatic passes your password to the
|
||||||
database via an environment variable that does not appear in the logs.
|
database via an environment variable that does not appear in the logs.
|
||||||
|
|
||||||
The cause of an authentication error is often on the database side—in the
|
The cause of an authentication error is often on the database side—in the
|
||||||
|
|
|
@ -169,7 +169,7 @@ brackets. For instance, the default log format is: `[{asctime}] {levelname}:
|
||||||
{message}`. This means each log message is recorded as the log time (in square
|
{message}`. This means each log message is recorded as the log time (in square
|
||||||
brackets), a logging level name, a colon, and the actual log message.
|
brackets), a logging level name, a colon, and the actual log message.
|
||||||
|
|
||||||
So if you just want each log message to get logged *without* a timestamp or a
|
So if you only want each log message to get logged *without* a timestamp or a
|
||||||
logging level name:
|
logging level name:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
|
@ -86,8 +86,8 @@ uses the `archive_name_format` option to automatically limit which archives
|
||||||
get used for actions operating on multiple archives. This prevents, for
|
get used for actions operating on multiple archives. This prevents, for
|
||||||
instance, duplicate archives from showing up in `rlist` or `info` results—even
|
instance, duplicate archives from showing up in `rlist` or `info` results—even
|
||||||
if the same repository appears in multiple borgmatic configuration files. To
|
if the same repository appears in multiple borgmatic configuration files. To
|
||||||
take advantage of this feature, simply use a different `archive_name_format`
|
take advantage of this feature, use a different `archive_name_format` in each
|
||||||
in each configuration file.
|
configuration file.
|
||||||
|
|
||||||
Under the hood, borgmatic accomplishes this by substituting globs for certain
|
Under the hood, borgmatic accomplishes this by substituting globs for certain
|
||||||
ephemeral data placeholders in your `archive_name_format`—and using the result
|
ephemeral data placeholders in your `archive_name_format`—and using the result
|
||||||
|
@ -108,8 +108,8 @@ archives used for actions like `rlist`, `info`, `prune`, `check`, etc.
|
||||||
|
|
||||||
The end result is that when borgmatic runs the actions for a particular
|
The end result is that when borgmatic runs the actions for a particular
|
||||||
application-specific configuration file, it only operates on the archives
|
application-specific configuration file, it only operates on the archives
|
||||||
created for that application. Of course, this doesn't apply to actions like
|
created for that application. But this doesn't apply to actions like `compact`
|
||||||
`compact` that operate on an entire repository.
|
that operate on an entire repository.
|
||||||
|
|
||||||
If this behavior isn't quite smart enough for your needs, you can use the
|
If this behavior isn't quite smart enough for your needs, you can use the
|
||||||
`match_archives` option to override the pattern that borgmatic uses for
|
`match_archives` option to override the pattern that borgmatic uses for
|
||||||
|
|
Loading…
Reference in a new issue