overmind
/
matrix-docker-ansible-deploy
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy
1
0
Fork 0
Code Issues 0 Releases 0 Wiki Activity
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.
8820 Commits
5 Branches
101 MiB
 
 
 
Tree: c51e771d1a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'c51e771d1a'
${ noResults }
matrix-docker-ansible-deploy/i18n/locales/jp/LC_MESSAGES/docs/configuring-playbook-synaps...

382 lines
14 KiB
Raw Blame History 

  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: 2024-12-16 12:05+0900\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. 

  23. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:1

  24. msgid ""

  25. "Storing Synapse media files on Amazon S3 with synapse-s3-storage-provider"

  26. " (optional)"

  27. msgstr ""

  28. 

  29. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:3

  30. msgid ""

  31. "If you'd like to store Synapse's content repository (`media_store`) files"

  32. " on Amazon S3 (or other S3-compatible service), you can use the "

  33. "[synapse-s3-storage-provider](https://github.com/matrix-org/synapse-s3"

  34. "-storage-provider) media provider module for Synapse."

  35. msgstr ""

  36. 

  37. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:5

  38. msgid ""

  39. "An alternative (which has worse performance) is to use [Goofys to mount "

  40. "the S3 store to the local filesystem](configuring-playbook-s3-goofys.md)."

  41. msgstr ""

  42. 

  43. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:7

  44. msgid "How it works?"

  45. msgstr ""

  46. 

  47. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:9

  48. msgid ""

  49. "Summarized writings here are inspired by [this "

  50. "article](https://quentin.dufour.io/blog/2021-09-14/matrix-"

  51. "synapse-s3-storage/)."

  52. msgstr ""

  53. 

  54. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:11

  55. msgid "The way media storage providers in Synapse work has some caveats:"

  56. msgstr ""

  57. 

  58. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:13

  59. msgid ""

  60. "Synapse still continues to use locally-stored files (for creating "

  61. "thumbnails, serving files, etc)"

  62. msgstr ""

  63. 

  64. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:14

  65. msgid ""

  66. "the media storage provider is just an extra storage mechanism (in "

  67. "addition to the local filesystem)"

  68. msgstr ""

  69. 

  70. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:15

  71. msgid ""

  72. "all files are stored locally at first, and then copied to the media "

  73. "storage provider (either synchronously or asynchronously)"

  74. msgstr ""

  75. 

  76. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:16

  77. msgid ""

  78. "if a file is not available on the local filesystem, it's pulled from a "

  79. "media storage provider"

  80. msgstr ""

  81. 

  82. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:18

  83. msgid ""

  84. "You may be thinking **if all files are stored locally as well, what's the"

  85. " point**?"

  86. msgstr ""

  87. 

  88. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:20

  89. msgid ""

  90. "You can run some scripts to delete the local files once in a while (which"

  91. " we do automatically by default - see [Periodically cleaning up the local"

  92. " filesystem](#periodically-cleaning-up-the-local-filesystem)), thus "

  93. "freeing up local disk space. If these files are needed in the future (for"

  94. " serving them to users, etc.), Synapse will pull them from the media "

  95. "storage provider on demand."

  96. msgstr ""

  97. 

  98. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:22

  99. msgid ""

  100. "While you will need some local disk space around, it's only to "

  101. "accommodate usage, etc., and won't grow as large as your S3 store."

  102. msgstr ""

  103. 

  104. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:24

  105. msgid "Installing"

  106. msgstr ""

  107. 

  108. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:26

  109. msgid ""

  110. "After [creating the S3 bucket and configuring it](configuring-"

  111. "playbook-s3.md#bucket-creation-and-security-configuration), you can "

  112. "proceed to configure `s3-storage-provider` in your configuration file "

  113. "(`inventory/host_vars/matrix.example.com/vars.yml`):"

  114. msgstr ""

  115. 

  116. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:50

  117. msgid ""

  118. "If you have existing files in Synapse's media repository "

  119. "(`/matrix/synapse/media-store/..`):"

  120. msgstr ""

  121. 

  122. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:52

  123. msgid "new files will start being stored both locally and on the S3 store"

  124. msgstr ""

  125. 

  126. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:53

  127. msgid ""

  128. "the existing files will remain on the local filesystem only until "

  129. "[migrating them to the S3 store](#migrating-your-existing-media-files-to-"

  130. "the-s3-store)"

  131. msgstr ""

  132. 

  133. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:54

  134. msgid ""

  135. "at some point (and periodically in the future), you can delete local "

  136. "files which have been uploaded to the S3 store already"

  137. msgstr ""

  138. 

  139. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:56

  140. msgid ""

  141. "Regardless of whether you need to [Migrate your existing files to the S3 "

  142. "store](#migrating-your-existing-media-files-to-the-s3-store) or not, make"

  143. " sure you've familiarized yourself with [How it works?](#how-it-works) "

  144. "above and [Periodically cleaning up the local filesystem](#periodically-"

  145. "cleaning-up-the-local-filesystem) below."

  146. msgstr ""

  147. 

  148. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:58

  149. msgid "Migrating your existing media files to the S3 store"

  150. msgstr ""

  151. 

  152. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:60

  153. msgid "Migrating your existing data can happen in multiple ways:"

  154. msgstr ""

  155. 

  156. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:62

  157. msgid ""

  158. "[using the `s3_media_upload` script from `synapse-s3-storage-provider"

  159. "`](#using-the-s3_media_upload-script-from-synapse-s3-storage-provider) "

  160. "(very slow when dealing with lots of data)"

  161. msgstr ""

  162. 

  163. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:63

  164. msgid ""

  165. "[using another tool in combination with `s3_media_upload`](#using-"

  166. "another-tool-in-combination-with-s3_media_upload) (quicker when dealing "

  167. "with lots of data)"

  168. msgstr ""

  169. 

  170. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:65

  171. msgid "Using the `s3_media_upload` script from `synapse-s3-storage-provider`"

  172. msgstr ""

  173. 

  174. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:67

  175. msgid ""

  176. "Instead of using `s3_media_upload` directly, which is very slow and "

  177. "painful for an initial data migration, we recommend [using another tool "

  178. "in combination with `s3_media_upload`](#using-another-tool-in-"

  179. "combination-with-s3_media_upload)."

  180. msgstr ""

  181. 

  182. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:69

  183. msgid ""

  184. "To copy your existing files, SSH into the server and run "

  185. "`/matrix/synapse/ext/s3-storage-provider/bin/shell`."

  186. msgstr ""

  187. 

  188. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:71

  189. msgid ""

  190. "This launches a Synapse container, which has access to the local media "

  191. "store, Postgres database, S3 store and has some convenient environment "

  192. "variables configured for you to use (`MEDIA_PATH`, `BUCKET`, `ENDPOINT`, "

  193. "`UPDATE_DB_DAYS`, etc)."

  194. msgstr ""

  195. 

  196. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:73

  197. msgid ""

  198. "Then use the following commands (`$` values come from environment "

  199. "variables - they're **not placeholders** that you need to substitute):"

  200. msgstr ""

  201. 

  202. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:75

  203. msgid ""

  204. "`s3_media_upload update-db $UPDATE_DB_DURATION` - create a local SQLite "

  205. "database (`cache.db`) with a list of media repository files (from the "

  206. "`synapse` Postgres database) eligible for operating on"

  207. msgstr ""

  208. 

  209. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:76

  210. msgid ""

  211. "`$UPDATE_DB_DURATION` is influenced by the "

  212. "`matrix_synapse_ext_synapse_s3_storage_provider_update_db_day_count` "

  213. "variable (defaults to `0`)"

  214. msgstr ""

  215. 

  216. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:77

  217. msgid ""

  218. "`$UPDATE_DB_DURATION` defaults to `0d` (0 days), which means **include "

  219. "files which haven't been accessed for more than 0 days** (that is, **all "

  220. "files will be included**)."

  221. msgstr ""

  222. 

  223. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:78

  224. msgid ""

  225. "`s3_media_upload check-deleted $MEDIA_PATH` - check whether files in the "

  226. "local cache still exist in the local media repository directory"

  227. msgstr ""

  228. 

  229. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:79

  230. msgid ""

  231. "`s3_media_upload upload $MEDIA_PATH $BUCKET --delete --storage-class "

  232. "$STORAGE_CLASS --endpoint-url $ENDPOINT` - uploads locally-stored files "

  233. "to S3 and deletes them from the local media repository directory"

  234. msgstr ""

  235. 

  236. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:81

  237. msgid "The `s3_media_upload upload` command may take a lot of time to complete."

  238. msgstr ""

  239. 

  240. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:83

  241. msgid ""

  242. "Instead of running the above commands manually in the shell, you can also"

  243. " run the `/matrix/synapse/ext/s3-storage-provider/bin/migrate` script "

  244. "which will run the same commands automatically. We demonstrate how to do "

  245. "it manually, because:"

  246. msgstr ""

  247. 

  248. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:85

  249. msgid ""

  250. "it's what the upstream project demonstrates and it teaches you how to use"

  251. " the `s3_media_upload` tool"

  252. msgstr ""

  253. 

  254. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:86

  255. msgid ""

  256. "allows you to check and verify the output of each command, to catch "

  257. "mistakes"

  258. msgstr ""

  259. 

  260. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:87

  261. msgid "includes progress bars and detailed output for each command"

  262. msgstr ""

  263. 

  264. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:88

  265. msgid ""

  266. "allows you to easily interrupt slow-running commands, etc. (the "

  267. "`/matrix/synapse/ext/s3-storage-provider/bin/migrate` starts a container "

  268. "without interactive TTY support, so `Ctrl+C` may not work and you and "

  269. "require killing via `docker kill ..`)"

  270. msgstr ""

  271. 

  272. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:90

  273. msgid "Using another tool in combination with `s3_media_upload`"

  274. msgstr ""

  275. 

  276. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:92

  277. msgid "To migrate your existing local data to S3, we recommend to:"

  278. msgstr ""

  279. 

  280. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:94

  281. msgid ""

  282. "**first** use another tool ([`aws s3`](#copying-data-to-amazon-s3) or "

  283. "[`b2 sync`](#copying-data-to-backblaze-b2), etc.) to copy the local files"

  284. " to the S3 bucket"

  285. msgstr ""

  286. 

  287. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:96

  288. msgid ""

  289. "**only then** [use the `s3_media_upload` tool to finish the migration"

  290. "](#using-the-s3_media_upload-script-from-synapse-s3-storage-provider) "

  291. "(this checks to ensure all files are uploaded and then deletes the local "

  292. "files)"

  293. msgstr ""

  294. 

  295. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:98

  296. msgid "Copying data to Amazon S3"

  297. msgstr ""

  298. 

  299. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:100

  300. msgid "To copy to AWS S3, start a container on the Matrix server like this:"

  301. msgstr ""

  302. 

  303. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:112

  304. msgid "Copying data to an S3 alternative using the aws-s3 tool"

  305. msgstr ""

  306. 

  307. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:114

  308. msgid ""

  309. "To copy to a provider other than AWS S3 (e.g. Wasabi, Digital Ocean "

  310. "Spaces, etc.), you can use the command for [Copying data to Amazon S3"

  311. "](#copying-data-to-amazon-s3) with an added `--endpoint-url=$ENDPOINT` "

  312. "argument."

  313. msgstr ""

  314. 

  315. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:116

  316. msgid ""

  317. "Add this argument to the command **as-is** (`$ENDPOINT` is an environment"

  318. " variable corresponding to "

  319. "`matrix_synapse_ext_synapse_s3_storage_provider_config_endpoint_url`, so "

  320. "you don't need to touch it). Make sure to add the argument **before** the"

  321. " final quote (`'`) of the command."

  322. msgstr ""

  323. 

  324. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:118

  325. msgid "Copying data to Backblaze B2"

  326. msgstr ""

  327. 

  328. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:120

  329. msgid ""

  330. "You can copy files to Backblaze B2 either by following the [Copying data "

  331. "to an S3 alternative using the aws-s3 tool](#copying-data-to-an-s3"

  332. "-alternative-using-the-aws-s3-tool) or by using the B2-specific [b2 "

  333. "command-line "

  334. "tool](https://www.backblaze.com/b2/docs/quick_command_line.html) as "

  335. "described below."

  336. msgstr ""

  337. 

  338. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:122

  339. msgid ""

  340. "To copy the data using the `b2` tool, start a container on the Matrix "

  341. "server like this:"

  342. msgstr ""

  343. 

  344. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:136

  345. msgid "Periodically cleaning up the local filesystem"

  346. msgstr ""

  347. 

  348. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:138

  349. msgid ""

  350. "As described in [How it works?](#how-it-works) above, when new media is "

  351. "uploaded to the Synapse homeserver, it's first stored locally and then "

  352. "also stored on the remote S3 storage."

  353. msgstr ""

  354. 

  355. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:140

  356. msgid ""

  357. "By default, we periodically ensure that all local files are uploaded to "

  358. "S3 and are then removed from the local filesystem. This is done "

  359. "automatically using:"

  360. msgstr ""

  361. 

  362. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:142

  363. msgid "the `/matrix/synapse/ext/s3-storage-provider/bin/migrate` script"

  364. msgstr ""

  365. 

  366. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:143

  367. msgid ""

  368. ".. invoked via the `matrix-synapse-s3-storage-provider-migrate.service` "

  369. "service"

  370. msgstr ""

  371. 

  372. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:144

  373. msgid ""

  374. ".. triggered by the `matrix-synapse-s3-storage-provider-migrate.timer` "

  375. "timer, every day at 05:00"

  376. msgstr ""

  377. 

  378. #: ../../../docs/configuring-playbook-synapse-s3-storage-provider.md:146

  379. msgid "So.. you don't need to perform any maintenance yourself."

  380. msgstr ""