Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

194 lines
9.0 KiB

  1. # SOME DESCRIPTIVE TITLE.
  2. # Copyright (C) 2018-2024, Slavi Pantaleev, Aine Etke, MDAD community
  3. # members
  4. # This file is distributed under the same license as the
  5. # matrix-docker-ansible-deploy package.
  6. # FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
  7. #
  8. #, fuzzy
  9. msgid ""
  10. msgstr ""
  11. "Project-Id-Version: matrix-docker-ansible-deploy \n"
  12. "Report-Msgid-Bugs-To: \n"
  13. "POT-Creation-Date: 2025-01-27 09:54+0200\n"
  14. "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
  15. "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
  16. "Language: jp\n"
  17. "Language-Team: jp <LL@li.org>\n"
  18. "MIME-Version: 1.0\n"
  19. "Content-Type: text/plain; charset=utf-8\n"
  20. "Content-Transfer-Encoding: 8bit\n"
  21. "Generated-By: Babel 2.16.0\n"
  22. #: ../../../docs/configuring-playbook-backup-borg.md:1
  23. msgid "Setting up BorgBackup (optional)"
  24. msgstr ""
  25. #: ../../../docs/configuring-playbook-backup-borg.md:3
  26. msgid "The playbook can install and configure [BorgBackup](https://www.borgbackup.org/) (short: Borg) with [borgmatic](https://torsion.org/borgmatic/) for you."
  27. msgstr ""
  28. #: ../../../docs/configuring-playbook-backup-borg.md:5
  29. 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."
  30. msgstr ""
  31. #: ../../../docs/configuring-playbook-backup-borg.md:7
  32. msgid "Prerequisites"
  33. msgstr ""
  34. #: ../../../docs/configuring-playbook-backup-borg.md:9
  35. msgid "Set up a remote server for storing backups"
  36. msgstr ""
  37. #: ../../../docs/configuring-playbook-backup-borg.md:11
  38. 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)."
  39. msgstr ""
  40. #: ../../../docs/configuring-playbook-backup-borg.md:13
  41. msgid "Check the Postgres version"
  42. msgstr ""
  43. #: ../../../docs/configuring-playbook-backup-borg.md:15
  44. 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."
  45. msgstr ""
  46. #: ../../../docs/configuring-playbook-backup-borg.md:17
  47. 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)."
  48. msgstr ""
  49. #: ../../../docs/configuring-playbook-backup-borg.md:19
  50. 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."
  51. msgstr ""
  52. #: ../../../docs/configuring-playbook-backup-borg.md:21
  53. msgid "Create a new SSH key"
  54. msgstr ""
  55. #: ../../../docs/configuring-playbook-backup-borg.md:23
  56. msgid "Run the command below on any machine to create a new SSH key:"
  57. msgstr ""
  58. #: ../../../docs/configuring-playbook-backup-borg.md:29
  59. msgid "You don't need to place the key in the `.ssh` folder."
  60. msgstr ""
  61. #: ../../../docs/configuring-playbook-backup-borg.md:31
  62. msgid "Add the public key"
  63. msgstr ""
  64. #: ../../../docs/configuring-playbook-backup-borg.md:33
  65. msgid "Next, add the **public** part of this SSH key (the `matrix-borg-backup.pub` file) to your BorgBackup provider/server."
  66. msgstr ""
  67. #: ../../../docs/configuring-playbook-backup-borg.md:35
  68. 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:"
  69. msgstr ""
  70. #: ../../../docs/configuring-playbook-backup-borg.md:45
  71. 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."
  72. msgstr ""
  73. #: ../../../docs/configuring-playbook-backup-borg.md:47
  74. msgid "Adjusting the playbook configuration"
  75. msgstr ""
  76. #: ../../../docs/configuring-playbook-backup-borg.md:49
  77. msgid "To enable BorgBackup, add the following configuration to your `vars.yml` file (adapt to your needs):"
  78. msgstr ""
  79. #: ../../../docs/configuring-playbook-backup-borg.md:76
  80. 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."
  81. msgstr ""
  82. #: ../../../docs/configuring-playbook-backup-borg.md:78
  83. msgid "Set backup archive name (optional)"
  84. msgstr ""
  85. #: ../../../docs/configuring-playbook-backup-borg.md:80
  86. 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):"
  87. msgstr ""
  88. #: ../../../docs/configuring-playbook-backup-borg.md:86
  89. msgid "Configure retention policy (optional)"
  90. msgstr ""
  91. #: ../../../docs/configuring-playbook-backup-borg.md:88
  92. 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):"
  93. msgstr ""
  94. #: ../../../docs/configuring-playbook-backup-borg.md:98
  95. msgid "Edit the backup schedule (optional)"
  96. msgstr ""
  97. #: ../../../docs/configuring-playbook-backup-borg.md:100
  98. 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."
  99. msgstr ""
  100. #: ../../../docs/configuring-playbook-backup-borg.md:102
  101. msgid "To edit the schedule, add the following configuration to your `vars.yml` file (adapt to your needs):"
  102. msgstr ""
  103. #: ../../../docs/configuring-playbook-backup-borg.md:108
  104. 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."
  105. msgstr ""
  106. #: ../../../docs/configuring-playbook-backup-borg.md:110
  107. msgid "Set include and/or exclude directories (optional)"
  108. msgstr ""
  109. #: ../../../docs/configuring-playbook-backup-borg.md:112
  110. 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."
  111. msgstr ""
  112. #: ../../../docs/configuring-playbook-backup-borg.md:114
  113. msgid "You might also want to exclude certain directories or file patterns from the backup using the `backup_borg_location_exclude_patterns` variable."
  114. msgstr ""
  115. #: ../../../docs/configuring-playbook-backup-borg.md:116
  116. msgid "Extending the configuration"
  117. msgstr ""
  118. #: ../../../docs/configuring-playbook-backup-borg.md:118
  119. msgid "There are some additional things you may wish to configure about the component."
  120. msgstr ""
  121. #: ../../../docs/configuring-playbook-backup-borg.md:120
  122. msgid "Take a look at:"
  123. msgstr ""
  124. #: ../../../docs/configuring-playbook-backup-borg.md:122
  125. 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"
  126. msgstr ""
  127. #: ../../../docs/configuring-playbook-backup-borg.md:124
  128. msgid "Installing"
  129. msgstr ""
  130. #: ../../../docs/configuring-playbook-backup-borg.md:126
  131. msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
  132. msgstr ""
  133. #: ../../../docs/configuring-playbook-backup-borg.md:133
  134. msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
  135. msgstr ""
  136. #: ../../../docs/configuring-playbook-backup-borg.md:135
  137. 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."
  138. msgstr ""
  139. #: ../../../docs/configuring-playbook-backup-borg.md:137
  140. msgid "Manually start a backup"
  141. msgstr ""
  142. #: ../../../docs/configuring-playbook-backup-borg.md:139
  143. 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."
  144. msgstr ""
  145. #: ../../../docs/configuring-playbook-backup-borg.md:141
  146. msgid "If you want to run it immediately, log in to the server with SSH and run `systemctl start matrix-backup-borg`."
  147. msgstr ""
  148. #: ../../../docs/configuring-playbook-backup-borg.md:143
  149. 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."
  150. msgstr ""