overmind
/
matrix-docker-ansible-deploy
zrcadlo https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Rozštěpit 0
Zdrojový kód Úkoly 0 Vydání 0 Wiki Aktivita
Matrix Docker Ansible eploy
Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
10427 Revize
11 Větve
1.3 GiB
 
 
Strom: 90d3cf78b3
Větve Značky
${ item.name }
Vytvořit větev ${ searchTerm }
z „90d3cf78b3“
${ noResults }
matrix-docker-ansible-deploy/i18n/translation-templates/docs/configuring-playbook-backup...

190 řádky
9.0 KiB
Surový Blame Historie 

  1. # SOME DESCRIPTIVE TITLE.

  2. # Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members

  3. # This file is distributed under the same license as the matrix-docker-ansible-deploy package.

  4. # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.

  5. #

  6. #, fuzzy

  7. msgid ""

  8. msgstr ""

  9. "Project-Id-Version: matrix-docker-ansible-deploy \n"

  10. "Report-Msgid-Bugs-To: \n"

  11. "POT-Creation-Date: 2025-01-27 09:54+0200\n"

  12. "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"

  13. "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"

  14. "Language-Team: LANGUAGE <LL@li.org>\n"

  15. "MIME-Version: 1.0\n"

  16. "Content-Type: text/plain; charset=UTF-8\n"

  17. "Content-Transfer-Encoding: 8bit\n"

  18. 

  19. #: ../../../docs/configuring-playbook-backup-borg.md:1

  20. msgid "Setting up BorgBackup (optional)"

  21. msgstr ""

  22. 

  23. #: ../../../docs/configuring-playbook-backup-borg.md:3

  24. msgid "The playbook can install and configure [BorgBackup](https://www.borgbackup.org/) (short: Borg) with [borgmatic](https://torsion.org/borgmatic/) for you."

  25. msgstr ""

  26. 

  27. #: ../../../docs/configuring-playbook-backup-borg.md:5

  28. msgid "BorgBackup is a deduplicating backup program with optional compression and encryption. That means your daily incremental backups can be stored in a fraction of the space and is safe whether you store it at home or on a cloud service."

  29. msgstr ""

  30. 

  31. #: ../../../docs/configuring-playbook-backup-borg.md:7

  32. msgid "Prerequisites"

  33. msgstr ""

  34. 

  35. #: ../../../docs/configuring-playbook-backup-borg.md:9

  36. msgid "Set up a remote server for storing backups"

  37. msgstr ""

  38. 

  39. #: ../../../docs/configuring-playbook-backup-borg.md:11

  40. msgid "You will need a remote server where BorgBackup will store the backups. There are hosted, BorgBackup compatible solutions available, such as [BorgBase](https://www.borgbase.com)."

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-backup-borg.md:13

  44. msgid "Check the Postgres version"

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-backup-borg.md:15

  48. msgid "By default, if you're using the integrated Postgres database server (as opposed to [an external Postgres server](configuring-playbook-external-postgres.md)), backups with BorgBackup will also include dumps of your Postgres database."

  49. msgstr ""

  50. 

  51. #: ../../../docs/configuring-playbook-backup-borg.md:17

  52. msgid "Unless you disable the Postgres-backup support, make sure that the Postgres version of your homeserver's database is compatible with borgmatic. You can check the compatible versions [here](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg/blob/main/defaults/main.yml)."

  53. msgstr ""

  54. 

  55. #: ../../../docs/configuring-playbook-backup-borg.md:19

  56. msgid "An alternative solution for backing up the Postgres database is [postgres backup](configuring-playbook-postgres-backup.md). If you decide to go with another solution, you can disable Postgres-backup support for BorgBackup using the `backup_borg_postgresql_enabled` variable."

  57. msgstr ""

  58. 

  59. #: ../../../docs/configuring-playbook-backup-borg.md:21

  60. msgid "Create a new SSH key"

  61. msgstr ""

  62. 

  63. #: ../../../docs/configuring-playbook-backup-borg.md:23

  64. msgid "Run the command below on any machine to create a new SSH key:"

  65. msgstr ""

  66. 

  67. #: ../../../docs/configuring-playbook-backup-borg.md:29

  68. msgid "You don't need to place the key in the `.ssh` folder."

  69. msgstr ""

  70. 

  71. #: ../../../docs/configuring-playbook-backup-borg.md:31

  72. msgid "Add the public key"

  73. msgstr ""

  74. 

  75. #: ../../../docs/configuring-playbook-backup-borg.md:33

  76. msgid "Next, add the **public** part of this SSH key (the `matrix-borg-backup.pub` file) to your BorgBackup provider/server."

  77. msgstr ""

  78. 

  79. #: ../../../docs/configuring-playbook-backup-borg.md:35

  80. msgid "If you are using a hosted solution, follow their instructions. If you have your own server, copy the key to it with the command like below:"

  81. msgstr ""

  82. 

  83. #: ../../../docs/configuring-playbook-backup-borg.md:45

  84. msgid "The **private** key needs to be added to `backup_borg_ssh_key_private` on your `inventory/host_vars/matrix.example.com/vars.yml` file as below."

  85. msgstr ""

  86. 

  87. #: ../../../docs/configuring-playbook-backup-borg.md:47

  88. msgid "Adjusting the playbook configuration"

  89. msgstr ""

  90. 

  91. #: ../../../docs/configuring-playbook-backup-borg.md:49

  92. msgid "To enable BorgBackup, add the following configuration to your `vars.yml` file (adapt to your needs):"

  93. msgstr ""

  94. 

  95. #: ../../../docs/configuring-playbook-backup-borg.md:76

  96. msgid "**Note**: `REPO` will be initialized on backup start, for example: `matrix`. See [Remote repositories](https://borgbackup.readthedocs.io/en/stable/usage/general.html#repository-urls) for the syntax."

  97. msgstr ""

  98. 

  99. #: ../../../docs/configuring-playbook-backup-borg.md:78

  100. msgid "Set backup archive name (optional)"

  101. msgstr ""

  102. 

  103. #: ../../../docs/configuring-playbook-backup-borg.md:80

  104. msgid "You can specify the backup archive name format. To set it, add the following configuration to your `vars.yml` file (adapt to your needs):"

  105. msgstr ""

  106. 

  107. #: ../../../docs/configuring-playbook-backup-borg.md:86

  108. msgid "Configure retention policy (optional)"

  109. msgstr ""

  110. 

  111. #: ../../../docs/configuring-playbook-backup-borg.md:88

  112. msgid "It is also possible to configure a retention strategy. To configure it, add the following configuration to your `vars.yml` file (adapt to your needs):"

  113. msgstr ""

  114. 

  115. #: ../../../docs/configuring-playbook-backup-borg.md:98

  116. msgid "Edit the backup schedule (optional)"

  117. msgstr ""

  118. 

  119. #: ../../../docs/configuring-playbook-backup-borg.md:100

  120. msgid "By default the backup will run 4 a.m. every day based on the `backup_borg_schedule` variable. It is defined in the format of systemd timer calendar."

  121. msgstr ""

  122. 

  123. #: ../../../docs/configuring-playbook-backup-borg.md:102

  124. msgid "To edit the schedule, add the following configuration to your `vars.yml` file (adapt to your needs):"

  125. msgstr ""

  126. 

  127. #: ../../../docs/configuring-playbook-backup-borg.md:108

  128. msgid "**Note**: the actual job may run with a delay. See `backup_borg_schedule_randomized_delay_sec` [here](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg/blob/f5d5b473d48c6504be10b3d946255ef5c186c2a6/defaults/main.yml#L50) for its default value."

  129. msgstr ""

  130. 

  131. #: ../../../docs/configuring-playbook-backup-borg.md:110

  132. msgid "Set include and/or exclude directories (optional)"

  133. msgstr ""

  134. 

  135. #: ../../../docs/configuring-playbook-backup-borg.md:112

  136. msgid "`backup_borg_location_source_directories` defines the list of directories to back up. It's set to `{{ matrix_base_data_path }}` by default, which is the base directory for every service's data, such as Synapse, Postgres and the bridges."

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-backup-borg.md:114

  140. msgid "You might also want to exclude certain directories or file patterns from the backup using the `backup_borg_location_exclude_patterns` variable."

  141. msgstr ""

  142. 

  143. #: ../../../docs/configuring-playbook-backup-borg.md:116

  144. msgid "Extending the configuration"

  145. msgstr ""

  146. 

  147. #: ../../../docs/configuring-playbook-backup-borg.md:118

  148. msgid "There are some additional things you may wish to configure about the component."

  149. msgstr ""

  150. 

  151. #: ../../../docs/configuring-playbook-backup-borg.md:120

  152. msgid "Take a look at:"

  153. msgstr ""

  154. 

  155. #: ../../../docs/configuring-playbook-backup-borg.md:122

  156. msgid "[backup_borg role](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg)'s [`defaults/main.yml`](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg/blob/main/defaults/main.yml) for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `backup_borg_configuration_extension_yaml` variable"

  157. msgstr ""

  158. 

  159. #: ../../../docs/configuring-playbook-backup-borg.md:124

  160. msgid "Installing"

  161. msgstr ""

  162. 

  163. #: ../../../docs/configuring-playbook-backup-borg.md:126

  164. msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"

  165. msgstr ""

  166. 

  167. #: ../../../docs/configuring-playbook-backup-borg.md:133

  168. msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"

  169. msgstr ""

  170. 

  171. #: ../../../docs/configuring-playbook-backup-borg.md:135

  172. msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too."

  173. msgstr ""

  174. 

  175. #: ../../../docs/configuring-playbook-backup-borg.md:137

  176. msgid "Manually start a backup"

  177. msgstr ""

  178. 

  179. #: ../../../docs/configuring-playbook-backup-borg.md:139

  180. msgid "Sometimes it can be helpful to run the backup as you'd like, avoiding to wait until 4 a.m., like when you test your configuration."

  181. msgstr ""

  182. 

  183. #: ../../../docs/configuring-playbook-backup-borg.md:141

  184. msgid "If you want to run it immediately, log in to the server with SSH and run `systemctl start matrix-backup-borg`."

  185. msgstr ""

  186. 

  187. #: ../../../docs/configuring-playbook-backup-borg.md:143

  188. msgid "This will not return until the backup is done, so it can possibly take a long time. Consider using [tmux](https://en.wikipedia.org/wiki/Tmux) if your SSH connection is unstable."

  189. msgstr ""