mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2025-12-14 03:41:36 +01:00
Compare commits
719 Commits
element-ca
...
renovate/m
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b83af55dcb | ||
|
|
aec4185135 | ||
|
|
fd612f99fd | ||
|
|
ddc5e094a3 | ||
|
|
c14d1bd1f4 | ||
|
|
fe9f70517e | ||
|
|
59ab28cab2 | ||
|
|
904a98d56c | ||
|
|
f36983bfdb | ||
|
|
88dcfbdaa7 | ||
|
|
d5580ea322 | ||
|
|
95884479c3 | ||
|
|
64fc64921c | ||
|
|
4238ec6e86 | ||
|
|
940dcb0162 | ||
|
|
98663a8386 | ||
|
|
bbfe345758 | ||
|
|
c7ed2deb22 | ||
|
|
1bc70935a0 | ||
|
|
472bf1c58c | ||
|
|
717c9bfd7d | ||
|
|
325b22a302 | ||
|
|
f8f7406c51 | ||
|
|
caa2e338bc | ||
|
|
585d606856 | ||
|
|
cf97144ed8 | ||
|
|
d5709e4596 | ||
|
|
1838840f65 | ||
|
|
0041bd01c3 | ||
|
|
aea799260f | ||
|
|
1ee83861c3 | ||
|
|
db793428a1 | ||
|
|
f31be1a725 | ||
|
|
a451f1fcb1 | ||
|
|
64d890300b | ||
|
|
7e0815c5ea | ||
|
|
fb0a1bd489 | ||
|
|
bab3a47c50 | ||
|
|
a88c394ae0 | ||
|
|
eda41e89c1 | ||
|
|
d1b480de65 | ||
|
|
2821774fca | ||
|
|
77a173f8b2 | ||
|
|
ebdb2cc827 | ||
|
|
9b7767f451 | ||
|
|
201d3ea087 | ||
|
|
bf3f4a9059 | ||
|
|
cbf8a2e7e9 | ||
|
|
ddf0fe7167 | ||
|
|
07423d3dd4 | ||
|
|
430f350733 | ||
|
|
889970314a | ||
|
|
1f2f7e468e | ||
|
|
6865a59e88 | ||
|
|
e128c761ba | ||
|
|
4caf38e682 | ||
|
|
2eadddcde9 | ||
|
|
6cc837600a | ||
|
|
7181131967 | ||
|
|
a116620238 | ||
|
|
b464f3cc55 | ||
|
|
fb2d7481dc | ||
|
|
388e79ea5a | ||
|
|
0ab40bbd9c | ||
|
|
9582f6a565 | ||
|
|
4b2919b538 | ||
|
|
d05c83d0d5 | ||
|
|
97a1562942 | ||
|
|
346dfbbc07 | ||
|
|
7520469644 | ||
|
|
8405bbdb94 | ||
|
|
dfa38bec2c | ||
|
|
4e3dd04b17 | ||
|
|
ff884f5b4b | ||
|
|
4b93bbde98 | ||
|
|
46f00c89cc | ||
|
|
f3020a8ce6 | ||
|
|
1e3e722f8f | ||
|
|
f276b204a7 | ||
|
|
45ed9cc226 | ||
|
|
99d68c4e51 | ||
|
|
fe34e6c61d | ||
|
|
42e6c8d989 | ||
|
|
86f9cdfe2c | ||
|
|
56629103c6 | ||
|
|
4b19196a75 | ||
|
|
c8c6a83ecc | ||
|
|
272c03892c | ||
|
|
7f6c23f91d | ||
|
|
934e560b0d | ||
|
|
77d2b43fb5 | ||
|
|
20104ad5a9 | ||
|
|
cb769f0939 | ||
|
|
1ccdbfd2b5 | ||
|
|
386d94a8f6 | ||
|
|
fb1824e66d | ||
|
|
8979fdef79 | ||
|
|
ee976242e5 | ||
|
|
1861faf31d | ||
|
|
26f15e0803 | ||
|
|
bf99fa9bb2 | ||
|
|
3eced43292 | ||
|
|
096b85bd96 | ||
|
|
69a3d1f69d | ||
|
|
3c587f25af | ||
|
|
32eeab7c42 | ||
|
|
4f6293ecb8 | ||
|
|
2b7a0453eb | ||
|
|
4d465a9d92 | ||
|
|
d3858ed079 | ||
|
|
0579e14d6b | ||
|
|
fba4ee598a | ||
|
|
d9d671d8d9 | ||
|
|
bac0463bc8 | ||
|
|
dd2ce83fc2 | ||
|
|
a406a57f01 | ||
|
|
7862fd7cdd | ||
|
|
37c02af0a6 | ||
|
|
80ff36ad06 | ||
|
|
f068f42c6b | ||
|
|
1dab0ae510 | ||
|
|
7fbc55040a | ||
|
|
506bf4d9ae | ||
|
|
87427b331a | ||
|
|
3d5e3e4014 | ||
|
|
7191c7a3be | ||
|
|
b108c8a151 | ||
|
|
710fe6cb6d | ||
|
|
9d04962330 | ||
|
|
5b4e1b1a74 | ||
|
|
1235ea886d | ||
|
|
afbf4df32d | ||
|
|
c1bc2be7ec | ||
|
|
32dd3c328b | ||
|
|
eb410d5df9 | ||
|
|
b6e1cdb638 | ||
|
|
ca5e66ac2e | ||
|
|
bbcc94980b | ||
|
|
f547e19dcc | ||
|
|
f92740929e | ||
|
|
14d982c1ea | ||
|
|
8a838c1621 | ||
|
|
3ff7e2a614 | ||
|
|
58d14d6bdb | ||
|
|
e60db3019d | ||
|
|
0f09fbdd81 | ||
|
|
5caae3b515 | ||
|
|
e6f7cff994 | ||
|
|
93e45e6173 | ||
|
|
f541425a7f | ||
|
|
2fc071981e | ||
|
|
81584bdc9c | ||
|
|
6185c1e8cd | ||
|
|
c5d9e384aa | ||
|
|
5282227247 | ||
|
|
df6df6cbad | ||
|
|
f75ddd0a80 | ||
|
|
4c5804fc82 | ||
|
|
08acb5ea34 | ||
|
|
c7a3315af3 | ||
|
|
b5ffb9e72f | ||
|
|
92beb4ae51 | ||
|
|
b25dd4c829 | ||
|
|
e24bcb73dc | ||
|
|
d2287ef2ef | ||
|
|
16cf98e5e2 | ||
|
|
d43f03bbca | ||
|
|
544d25e8c3 | ||
|
|
31f1d40a9f | ||
|
|
dd70df545a | ||
|
|
b2024fa7c1 | ||
|
|
a254f69e56 | ||
|
|
ae7847719d | ||
|
|
2fea3c3e4a | ||
|
|
b50d9352c3 | ||
|
|
6190fe0ca2 | ||
|
|
3ff32ec07a | ||
|
|
e9406589e6 | ||
|
|
376fcdafc2 | ||
|
|
bff95835ef | ||
|
|
d908d003c8 | ||
|
|
31f222823b | ||
|
|
6a3c0423e0 | ||
|
|
d755b959d6 | ||
|
|
8fd2b75756 | ||
|
|
9fb28c9fd7 | ||
|
|
ec5efe8c4e | ||
|
|
ec3f25e8ad | ||
|
|
2719f5e806 | ||
|
|
489bf39322 | ||
|
|
525d4bc997 | ||
|
|
8511d4dfc4 | ||
|
|
1c4738b89a | ||
|
|
7caa583743 | ||
|
|
f048a0f9a5 | ||
|
|
b54eadb9e0 | ||
|
|
2b0ea94a72 | ||
|
|
ad9c01fd5b | ||
|
|
ed9bb75a52 | ||
|
|
2d05db52c7 | ||
|
|
f53a3bb365 | ||
|
|
9791f8a120 | ||
|
|
4145b811a3 | ||
|
|
6e4f781995 | ||
|
|
958b0de4f1 | ||
|
|
1bd6e8d064 | ||
|
|
01d548d4a7 | ||
|
|
3a5e6d5f2e | ||
|
|
feb7953132 | ||
|
|
951b27ed7f | ||
|
|
b7f03aa4b2 | ||
|
|
4e21bbe064 | ||
|
|
58688bf538 | ||
|
|
14c32cad77 | ||
|
|
afa003fadd | ||
|
|
03607e8dcd | ||
|
|
edad6a17bd | ||
|
|
dbae258970 | ||
|
|
647652852b | ||
|
|
c704be1f68 | ||
|
|
ba19f37cb2 | ||
|
|
7261a50892 | ||
|
|
32f9c34aeb | ||
|
|
37a0967258 | ||
|
|
4c17617397 | ||
|
|
625d246d73 | ||
|
|
931056a1dc | ||
|
|
677b1ea55b | ||
|
|
3bf56e931d | ||
|
|
db54063a0c | ||
|
|
8857f78a4d | ||
|
|
1b8c153c4a | ||
|
|
704eae3040 | ||
|
|
1eaa399c65 | ||
|
|
dccfbcbdf5 | ||
|
|
cb6ae3de76 | ||
|
|
3467baf62f | ||
|
|
895f149a34 | ||
|
|
42aa749f14 | ||
|
|
91372da03c | ||
|
|
04773517dd | ||
|
|
a0858df60f | ||
|
|
344f9bf7af | ||
|
|
796b5597f4 | ||
|
|
29d80b2243 | ||
|
|
65d41bd84d | ||
|
|
85504350af | ||
|
|
495a4e5312 | ||
|
|
6fd1119cdd | ||
|
|
31333460dc | ||
|
|
b71968cf64 | ||
|
|
90d3cf78b3 | ||
|
|
70fd18079e | ||
|
|
3819cc7b13 | ||
|
|
2607714887 | ||
|
|
4cc7d8456b | ||
|
|
2997f23e20 | ||
|
|
6e5cf9f3be | ||
|
|
238cc68889 | ||
|
|
2591223b20 | ||
|
|
ca69a97d08 | ||
|
|
3c3cc2bf7d | ||
|
|
3fee130331 | ||
|
|
2ea4384840 | ||
|
|
66729311db | ||
|
|
06263ddf61 | ||
|
|
9f6305db4d | ||
|
|
1d6bf63ca5 | ||
|
|
25e7cac28d | ||
|
|
ba4153da97 | ||
|
|
130d756dcb | ||
|
|
beaf0ba16e | ||
|
|
c2e606095c | ||
|
|
84bde915c7 | ||
|
|
910cdf8a0a | ||
|
|
d8eed6bfd3 | ||
|
|
38b40242c4 | ||
|
|
f12d6a901c | ||
|
|
c67c7d6f46 | ||
|
|
a6f0f40296 | ||
|
|
f65656175f | ||
|
|
24c2de23d5 | ||
|
|
deb19fb67c | ||
|
|
4d15ebcffa | ||
|
|
2a2ef828c3 | ||
|
|
40813784c1 | ||
|
|
071b5789f2 | ||
|
|
d2f38f04a6 | ||
|
|
840ad0171f | ||
|
|
051d77e541 | ||
|
|
facdde367f | ||
|
|
a008665ad5 | ||
|
|
aa58c5cfd6 | ||
|
|
a444d45f1e | ||
|
|
a22d2cc2bf | ||
|
|
cab01be63c | ||
|
|
f5b1ba57eb | ||
|
|
beb8e6d5f9 | ||
|
|
14b65ed7ed | ||
|
|
841e2f7c4e | ||
|
|
3ea0a10947 | ||
|
|
fedb5a8cb0 | ||
|
|
60ab080147 | ||
|
|
3daf14d695 | ||
|
|
39efe79417 | ||
|
|
46a416e678 | ||
|
|
48c08f62fb | ||
|
|
b85f7c61dd | ||
|
|
41043ffb1f | ||
|
|
62cef9375e | ||
|
|
ab6f091f5f | ||
|
|
9357eebbf1 | ||
|
|
cd6e9843e1 | ||
|
|
9354fa253e | ||
|
|
de212a2211 | ||
|
|
ac063d0629 | ||
|
|
814d3acc42 | ||
|
|
28deb25810 | ||
|
|
b62b5c3659 | ||
|
|
153fd1f68f | ||
|
|
21766eba94 | ||
|
|
c6b66d93b7 | ||
|
|
5951437e15 | ||
|
|
2253fc4d45 | ||
|
|
eb8bc55dfe | ||
|
|
83165d77fa | ||
|
|
1efc2fb7ba | ||
|
|
945c4b503c | ||
|
|
824d18626d | ||
|
|
8e01a51f00 | ||
|
|
0f50f24c1b | ||
|
|
7f0c9aaf55 | ||
|
|
992f974a65 | ||
|
|
6e89e181ec | ||
|
|
f136c2e5f1 | ||
|
|
5deead45cd | ||
|
|
2252697119 | ||
|
|
831a288ffc | ||
|
|
ec8a7a4934 | ||
|
|
1c09eda631 | ||
|
|
dd5994cfb4 | ||
|
|
8ff8e435c0 | ||
|
|
13cc78a9ac | ||
|
|
bb32475f27 | ||
|
|
daba4cb225 | ||
|
|
3462196eb3 | ||
|
|
0f00cddcda | ||
|
|
b2c9468ac2 | ||
|
|
06ab77fdcc | ||
|
|
0ebefac8d3 | ||
|
|
5ec3257e3c | ||
|
|
ddf161aa74 | ||
|
|
6ba22f5db7 | ||
|
|
c2bd2ba6fc | ||
|
|
6006d1e4d8 | ||
|
|
9bcfbc13fb | ||
|
|
b6f2255d49 | ||
|
|
2190e7a5ea | ||
|
|
bb322ad692 | ||
|
|
dd3399aa44 | ||
|
|
c84a4ee28c | ||
|
|
662c477a65 | ||
|
|
bb98127754 | ||
|
|
2c859b2868 | ||
|
|
fccd7442d6 | ||
|
|
5711a8bda3 | ||
|
|
6bd758ec5a | ||
|
|
50abe5b92f | ||
|
|
567cd9b669 | ||
|
|
e057dd93cc | ||
|
|
92ad39bf51 | ||
|
|
67b078f061 | ||
|
|
5b148e0d60 | ||
|
|
c4968592d9 | ||
|
|
03b78f90b5 | ||
|
|
a8a410546c | ||
|
|
865345a08f | ||
|
|
a8134ae198 | ||
|
|
9dd2305bae | ||
|
|
36687c4747 | ||
|
|
20729fcdfb | ||
|
|
72d082d6f5 | ||
|
|
eef4036c6e | ||
|
|
ff79d9d8e8 | ||
|
|
370f01c0bf | ||
|
|
6658c690cb | ||
|
|
e0dbd0581f | ||
|
|
b129ab77cd | ||
|
|
be161ae6e1 | ||
|
|
5d7e80d6c6 | ||
|
|
17b738b40e | ||
|
|
851cfd8bee | ||
|
|
b24b13564a | ||
|
|
c38c606b8e | ||
|
|
d3fcd7a97a | ||
|
|
d720a6a7a5 | ||
|
|
8c84fb245c | ||
|
|
d69b5b5beb | ||
|
|
389118760f | ||
|
|
593fbd74de | ||
|
|
8bde2035f7 | ||
|
|
e5d4400ccc | ||
|
|
e395857a14 | ||
|
|
8762cc0d7d | ||
|
|
9cb695a971 | ||
|
|
f324c01e78 | ||
|
|
65de112d87 | ||
|
|
e343b69510 | ||
|
|
9706f9eb97 | ||
|
|
6f2e7e7a57 | ||
|
|
ce8a9b1653 | ||
|
|
75b0aeabee | ||
|
|
dca53824ef | ||
|
|
1761615bf8 | ||
|
|
2f429411f3 | ||
|
|
a01b111495 | ||
|
|
5d5289576e | ||
|
|
d2419fccf3 | ||
|
|
cbbf20004c | ||
|
|
5de4b5c657 | ||
|
|
e8c7091c3f | ||
|
|
84b0879606 | ||
|
|
0d56aa126c | ||
|
|
d4c168daa9 | ||
|
|
e7d4bd4e28 | ||
|
|
0728f9ca36 | ||
|
|
c1f9032f04 | ||
|
|
abbcb0bc22 | ||
|
|
11028761a1 | ||
|
|
24d6d4b94b | ||
|
|
350cd2031a | ||
|
|
95f239c4a6 | ||
|
|
7f1fa52dd3 | ||
|
|
9d31b44040 | ||
|
|
d876da4186 | ||
|
|
4ef78bdb7f | ||
|
|
c085b540f2 | ||
|
|
9d98c5056e | ||
|
|
da9b82439b | ||
|
|
997e6ca611 | ||
|
|
3a11a32f9e | ||
|
|
570c4121b7 | ||
|
|
90813b3739 | ||
|
|
f2524902af | ||
|
|
2ee0826079 | ||
|
|
51ab9ed9ff | ||
|
|
5651206e77 | ||
|
|
a09760492b | ||
|
|
a1f6ee4dc9 | ||
|
|
6da6b466da | ||
|
|
c7989af64f | ||
|
|
28870d2867 | ||
|
|
8c89f577ad | ||
|
|
e2cb95f145 | ||
|
|
d4d293f9a4 | ||
|
|
d70bccbda4 | ||
|
|
16212150a3 | ||
|
|
69184bc4a3 | ||
|
|
514a947386 | ||
|
|
8ab525d609 | ||
|
|
8be4927770 | ||
|
|
7261be5537 | ||
|
|
7eff95f38d | ||
|
|
abc74a6b96 | ||
|
|
c6871d187f | ||
|
|
7cf0fe52d4 | ||
|
|
70686595d5 | ||
|
|
2ad2fd8b57 | ||
|
|
eb067b7536 | ||
|
|
c1d5d38cf6 | ||
|
|
b5af7f7a32 | ||
|
|
a04a72d4e5 | ||
|
|
b8029111c9 | ||
|
|
6a98f47f73 | ||
|
|
8ecee76f62 | ||
|
|
30156f1ac0 | ||
|
|
aa527d2b99 | ||
|
|
f3a819c5f1 | ||
|
|
9b3d2637ad | ||
|
|
cffda7277b | ||
|
|
eff5dd0527 | ||
|
|
05202d0032 | ||
|
|
49d32b15c6 | ||
|
|
f0f1d6ca67 | ||
|
|
bc55e358bf | ||
|
|
9e205d50ac | ||
|
|
348324d347 | ||
|
|
63a3915d86 | ||
|
|
a770681b18 | ||
|
|
7fcb253c23 | ||
|
|
56e01ad456 | ||
|
|
bd6be256b7 | ||
|
|
fb0ccc391e | ||
|
|
e6413534be | ||
|
|
2d1b1cfdde | ||
|
|
54ef63e0c2 | ||
|
|
06e14a6b70 | ||
|
|
9726cb24be | ||
|
|
a41ec6e8de | ||
|
|
c399c6ff10 | ||
|
|
9e31a254d8 | ||
|
|
1ccb6c822a | ||
|
|
1813c856e6 | ||
|
|
f4306be183 | ||
|
|
78a3bf42f3 | ||
|
|
5142b2ee90 | ||
|
|
f08bc17273 | ||
|
|
3997244190 | ||
|
|
c04dfe2384 | ||
|
|
d1796978ca | ||
|
|
1b2b6ddaa3 | ||
|
|
e813309311 | ||
|
|
8eb5bbf2c1 | ||
|
|
4632628b74 | ||
|
|
bdec7c646d | ||
|
|
25498851a0 | ||
|
|
613f685f54 | ||
|
|
5987bc5b5e | ||
|
|
d2164d7a48 | ||
|
|
9adfd8fc0d | ||
|
|
24d1875d38 | ||
|
|
c0269b71b8 | ||
|
|
4e8aa53e27 | ||
|
|
31a7f4367c | ||
|
|
1a6a75bdab | ||
|
|
29607f442d | ||
|
|
f8142a0c37 | ||
|
|
b13ba5b909 | ||
|
|
018f3f4408 | ||
|
|
39d13a826a | ||
|
|
34878abd67 | ||
|
|
acf244ea26 | ||
|
|
133ba64375 | ||
|
|
bebaac886e | ||
|
|
b8ebe57558 | ||
|
|
93fffee6a4 | ||
|
|
3be0449c35 | ||
|
|
91817e8335 | ||
|
|
772c248733 | ||
|
|
185f9b5765 | ||
|
|
9289859673 | ||
|
|
279de764c8 | ||
|
|
cb2586f8b4 | ||
|
|
b046292c10 | ||
|
|
8f0ac84721 | ||
|
|
aada2d255f | ||
|
|
3b425908da | ||
|
|
3092037a7e | ||
|
|
048b8eb918 | ||
|
|
779eb0fc9a | ||
|
|
6a1ebe6e91 | ||
|
|
30875764c5 | ||
|
|
15ed07d970 | ||
|
|
13d22af9db | ||
|
|
5742800329 | ||
|
|
3508c87aee | ||
|
|
868ee4d688 | ||
|
|
eb9af8fe32 | ||
|
|
27c0fa55f4 | ||
|
|
e76b50a0b7 | ||
|
|
db8bee548d | ||
|
|
adef970239 | ||
|
|
20e98fbb33 | ||
|
|
5dcdf8e9e2 | ||
|
|
7aca61c5dd | ||
|
|
5def3b176f | ||
|
|
01c8b55c6f | ||
|
|
9b8dab89df | ||
|
|
5701ce5054 | ||
|
|
cabedeae73 | ||
|
|
3edad9d8d4 | ||
|
|
2935d6a1a4 | ||
|
|
0941953889 | ||
|
|
f9f5182919 | ||
|
|
25c20f16d4 | ||
|
|
95f6347974 | ||
|
|
c9dfb1c877 | ||
|
|
3653f9f89b | ||
|
|
0152758f5d | ||
|
|
05caaab302 | ||
|
|
17e14a4b89 | ||
|
|
cb7db82fe9 | ||
|
|
f4e13a380d | ||
|
|
312b4826f0 | ||
|
|
a2ddbb8169 | ||
|
|
2c9aa1af9c | ||
|
|
1dc404dc5f | ||
|
|
2087c13a4e | ||
|
|
1c335da420 | ||
|
|
3ef1726a40 | ||
|
|
d3172f0f32 | ||
|
|
c97bb125c6 | ||
|
|
f36c776bc3 | ||
|
|
e16a644fa2 | ||
|
|
777882b40f | ||
|
|
8c9b95d68c | ||
|
|
429bbc1c7d | ||
|
|
5d0b0c98ae | ||
|
|
571b14eaf8 | ||
|
|
d5d7adf4b5 | ||
|
|
3c08f008bc | ||
|
|
e818bbb373 | ||
|
|
0bd29b938a | ||
|
|
a3c13c5786 | ||
|
|
b9121e7105 | ||
|
|
978d24aa32 | ||
|
|
1fdb3dd990 | ||
|
|
31effafc08 | ||
|
|
ecb7ccf8cc | ||
|
|
14d4a58583 | ||
|
|
fa35c3802d | ||
|
|
ef5be1d138 | ||
|
|
37a35c039e | ||
|
|
477bd98b15 | ||
|
|
eb67e08d98 | ||
|
|
757527bbd2 | ||
|
|
b3cd3910a9 | ||
|
|
89599d464a | ||
|
|
8e5de2dc31 | ||
|
|
0c8137220d | ||
|
|
90dcdf5261 | ||
|
|
3cb67f23ee | ||
|
|
09ae8750d8 | ||
|
|
34b2dd3dd0 | ||
|
|
9adc5be572 | ||
|
|
15e453039c | ||
|
|
7afaba64f0 | ||
|
|
96f4670887 | ||
|
|
3d25bd70f8 | ||
|
|
1fa2a2a615 | ||
|
|
94d5182f4d | ||
|
|
14be193d20 | ||
|
|
4e0f031ebd | ||
|
|
360ee544a9 | ||
|
|
465df3a949 | ||
|
|
ae87a3bb19 | ||
|
|
19ccd491fb | ||
|
|
95ef383ef7 | ||
|
|
43cb86ac8a | ||
|
|
d1329edf71 | ||
|
|
025909e05b | ||
|
|
9f83f52ea9 | ||
|
|
0b4b21660c | ||
|
|
381b987e99 | ||
|
|
026f4b3282 | ||
|
|
4599fd7159 | ||
|
|
47ca615931 | ||
|
|
99221c35d8 | ||
|
|
cfc02b542d | ||
|
|
9a1f7165c2 | ||
|
|
f6725a9bfe | ||
|
|
882b528c96 | ||
|
|
ae58880f0c | ||
|
|
a638565580 | ||
|
|
0a6be12878 | ||
|
|
20133def86 | ||
|
|
03672a3a52 | ||
|
|
63c2e831a8 | ||
|
|
0a6490ad46 | ||
|
|
7fb0bff47d | ||
|
|
37a7af52ab | ||
|
|
32ca5bf55c | ||
|
|
81b371e690 | ||
|
|
51e961ce9f | ||
|
|
3ee7deb2d7 | ||
|
|
9fc5cdab33 | ||
|
|
a59383fcc7 | ||
|
|
14aef55573 | ||
|
|
ffde4fcb80 | ||
|
|
71ce8f792d | ||
|
|
9476be0592 | ||
|
|
feaa656fde | ||
|
|
186d3dbd71 | ||
|
|
bcd50c8e08 | ||
|
|
1c39a67c0a | ||
|
|
5ea613a3f6 | ||
|
|
f0c48392fe | ||
|
|
3e1bc3ce59 | ||
|
|
46e587ee29 | ||
|
|
fd32960687 | ||
|
|
bd405c410a | ||
|
|
6383b1b37a | ||
|
|
41ac053912 | ||
|
|
98e4f369b7 | ||
|
|
dd2f8d1150 | ||
|
|
8a4eb88f0d | ||
|
|
74b8f78a7f | ||
|
|
2b50a0e6a0 | ||
|
|
202be672a4 | ||
|
|
57ea240060 | ||
|
|
b719c3c11a | ||
|
|
909bf8729e | ||
|
|
38c9f47bb0 | ||
|
|
69d6111354 | ||
|
|
80ac45e069 | ||
|
|
efb3072bc8 | ||
|
|
5c120397ab | ||
|
|
3f19344e9d | ||
|
|
f32633826a | ||
|
|
85d82eb1e4 | ||
|
|
5eb247b5bf | ||
|
|
6915c7de12 | ||
|
|
de10cb2239 | ||
|
|
d48867c07e | ||
|
|
ef156614ec | ||
|
|
c4da60c4e4 | ||
|
|
0d30d315e3 | ||
|
|
1317e5632a | ||
|
|
6ed5db1464 | ||
|
|
b35289cae8 | ||
|
|
222f877261 | ||
|
|
00cb1e5c0c | ||
|
|
e02dd74e3a | ||
|
|
08b68e93dc | ||
|
|
60b291f197 | ||
|
|
8378e6f164 | ||
|
|
40dd8f7785 | ||
|
|
761e6d4cd6 | ||
|
|
7cb33c5519 |
2
.codespellrc
Normal file
2
.codespellrc
Normal file
@@ -0,0 +1,2 @@
|
||||
[codespell]
|
||||
ignore-words-list = aNULL,brose,doub,Udo,re-use,re-used,registr,shema
|
||||
11
.github/renovate.json
vendored
11
.github/renovate.json
vendored
@@ -9,8 +9,8 @@
|
||||
"customManagers": [
|
||||
{
|
||||
"customType": "regex",
|
||||
"fileMatch": [
|
||||
"defaults/main.yml$"
|
||||
"managerFilePatterns": [
|
||||
"/defaults/main.yml$/"
|
||||
],
|
||||
"matchStrings": [
|
||||
"# renovate: datasource=(?<datasource>[a-z-.]+?) depName=(?<depName>[^\\s]+?)(?: (?:lookupName|packageName)=(?<packageName>[^\\s]+?))?(?: versioning=(?<versioning>[a-z-0-9]+?))?\\s+[A-Za-z0-9_]+?(?:_version|_tag)\\s*:\\s*[\"']?(?<currentValue>.+?)[\"']?\\s"
|
||||
@@ -20,13 +20,14 @@
|
||||
"packageRules": [
|
||||
{
|
||||
"ignoreUnstable": false,
|
||||
"versioning": "loose",
|
||||
"matchSourceUrls": [
|
||||
"https://github.com/devture/com.devture.ansible.role{/,}**",
|
||||
"https://github.com/mother-of-all-self-hosting{/,}**"
|
||||
]
|
||||
}
|
||||
],
|
||||
"ignoreDeps": [
|
||||
"ghcr.io/matrixgpt/matrix-chatgpt-bot"
|
||||
]
|
||||
"pre-commit": {
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
|
||||
2
.github/workflows/close-stale-issues.yml
vendored
2
.github/workflows/close-stale-issues.yml
vendored
@@ -19,7 +19,7 @@ jobs:
|
||||
if: github.repository == 'spantaleev/matrix-docker-ansible-deploy'
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/stale@v9
|
||||
- uses: actions/stale@v10
|
||||
with:
|
||||
######################################################################
|
||||
# Issues/PRs
|
||||
|
||||
24
.github/workflows/matrix.yml
vendored
24
.github/workflows/matrix.yml
vendored
@@ -7,9 +7,7 @@
|
||||
---
|
||||
name: Matrix CI
|
||||
|
||||
on: # yamllint disable-line rule:truthy
|
||||
push:
|
||||
pull_request:
|
||||
on: [push, pull_request] # yamllint disable-line rule:truthy
|
||||
|
||||
jobs:
|
||||
yamllint:
|
||||
@@ -17,7 +15,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
- name: Run yamllint
|
||||
uses: frenck/action-yamllint@v1.5.0
|
||||
ansible-lint:
|
||||
@@ -25,8 +23,20 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Run ansible-lint
|
||||
uses: ansible-community/ansible-lint-action@v6.17.0
|
||||
uses: ansible/ansible-lint@v25.12.0
|
||||
with:
|
||||
path: roles/custom
|
||||
args: "roles/custom"
|
||||
setup_python: "true"
|
||||
working_directory: ""
|
||||
requirements_file: requirements.yml
|
||||
precommit:
|
||||
name: Run pre-commit
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v6
|
||||
- name: Run pre-commit
|
||||
uses: pre-commit/action@v3.0.1
|
||||
|
||||
20
.github/workflows/reuse.yml
vendored
20
.github/workflows/reuse.yml
vendored
@@ -1,20 +0,0 @@
|
||||
# SPDX-FileCopyrightText: 2022 Free Software Foundation Europe e.V. <https://fsfe.org>
|
||||
#
|
||||
# SPDX-License-Identifier: CC0-1.0
|
||||
---
|
||||
name: REUSE Compliance Check
|
||||
|
||||
on: [push, pull_request] # yamllint disable-line rule:truthy
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
reuse-compliance-check:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: REUSE Compliance Check
|
||||
uses: fsfe/reuse-action@v5
|
||||
26
.pre-commit-config.yaml
Normal file
26
.pre-commit-config.yaml
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
default_install_hook_types: [pre-push]
|
||||
|
||||
exclude: "LICENSES/"
|
||||
|
||||
# See: https://pre-commit.com/hooks.html
|
||||
repos:
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v6.0.0
|
||||
hooks:
|
||||
# - id: check-executables-have-shebangs
|
||||
- id: check-added-large-files
|
||||
- id: check-case-conflict
|
||||
- id: check-json
|
||||
- id: check-toml
|
||||
- id: trailing-whitespace
|
||||
- id: end-of-file-fixer
|
||||
- repo: https://github.com/codespell-project/codespell
|
||||
rev: v2.4.1
|
||||
hooks:
|
||||
- id: codespell
|
||||
args: ["--skip=*.po,*.pot,i18n/"]
|
||||
- repo: https://github.com/fsfe/reuse-tool # https://reuse.software/dev/#pre-commit-hook
|
||||
rev: v6.2.0
|
||||
hooks:
|
||||
- id: reuse
|
||||
133
CHANGELOG.md
133
CHANGELOG.md
@@ -1,3 +1,114 @@
|
||||
# 2025-12-09
|
||||
|
||||
## Traefik Cert Dumper upgrade
|
||||
|
||||
The variable `traefik_certs_dumper_ssl_dir_path` was renamed to `traefik_certs_dumper_ssl_path`. Users who use [their own webserver with Traefik](docs/configuring-playbook-own-webserver.md) may need to adjust their configuration.
|
||||
|
||||
The variable `traefik_certs_dumper_dumped_certificates_dir_path` was renamed to `traefik_certs_dumper_dumped_certificates_path`. Users who use [SRV Server Delegation](docs/howto-srv-server-delegation.md) may need to adjust their configuration.
|
||||
|
||||
# 2025-11-23
|
||||
|
||||
## Matrix.to support
|
||||
|
||||
The playbook now supports [Matrix.to](https://github.com/matrix-org/matrix.to) — a simple URL redirection service which powers [matrix.to](https://matrix.to).
|
||||
|
||||
To learn more, see our [Setting up Matrix.to](docs/configuring-playbook-matrixto.md) documentation page.
|
||||
|
||||
# 2025-11-09
|
||||
|
||||
## matrix-appservice-webhooks has been removed from the playbook
|
||||
|
||||
[matrix-appservice-webhooks](./docs/configuring-playbook-bridge-appservice-webhooks.md) has been removed from the playbook, as it has been deprecated since more than several years.
|
||||
|
||||
The playbook will let you know if you're using any `matrix_appservice_webhooks_*` variables. You'll need to remove them from `vars.yml` and potentially [uninstall the bridge manually](./docs/configuring-playbook-bridge-appservice-webhooks.md#uninstalling-the-bridge-manually).
|
||||
|
||||
## mautrix-facebook and mautrix-instagram have been removed from the playbook
|
||||
|
||||
[mautrix-facebook](./docs/configuring-playbook-bridge-mautrix-facebook.md) and [mautrix-instagram](./docs/configuring-playbook-bridge-mautrix-instagram.md) have been removed from the playbook, as they have been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge, integrated to the playbook at [2024-02-19](#2024-02-19).
|
||||
|
||||
The playbook will let you know if you're using any variables for those bridges:
|
||||
|
||||
- `matrix_mautrix_facebook_*`
|
||||
- `matrix_mautrix_instagram_*`
|
||||
|
||||
You'll need to remove them from `vars.yml` and potentially uninstall them manually. Consult pages below for details:
|
||||
|
||||
- [Instruction for mautrix-facebook](./docs/configuring-playbook-bridge-mautrix-facebook.md#uninstalling-the-bridge-manually)
|
||||
- [Instruction for mautrix-instagram](./docs/configuring-playbook-bridge-mautrix-instagram.md#uninstalling-the-bridge-manually)
|
||||
|
||||
# 2025-11-08
|
||||
|
||||
## MatrixZulipBridge support
|
||||
|
||||
Thanks to [Suguru Hirahara](https://github.com/luixxiul), the playbook now supports the [GearKite/MatrixZulipBridge](https://github.com/GearKite/MatrixZulipBridg) bridge for bridging Matrix to [Zulip](https://zulip.com/).
|
||||
|
||||
To learn more, see our [Setting up Zulip bridging](docs/configuring-playbook-bridge-zulip.md) documentation page.
|
||||
|
||||
# 2025-11-07
|
||||
|
||||
## The matrix-chatgpt-bot has been removed from the playbook
|
||||
|
||||
The [matrix-bot-chatgpt](./docs/configuring-playbook-bot-chatgpt.md) has been removed from the playbook, as it has been deprecated since September 2024.
|
||||
|
||||
The playbook will let you know if you're using any `matrix_bot_chatgpt_*` variables. You'll need to remove them from `vars.yml` and potentially [uninstall the bot manually](./docs/configuring-playbook-bot-chatgpt.md#uninstalling-matrix-chatgpt-bot-manually).
|
||||
|
||||
# 2025-11-05
|
||||
|
||||
## The MX Puppet bridges for Discord, Instagram, Slack, and Twitter have been removed from the playbook
|
||||
|
||||
The MX Puppet bridges for Discord, Instagram, Slack, and Twitter have been removed from the playbook, as they have been unmaintained for more than several years and do not support important features like authenticated media. See [this issue](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3867) for the context.
|
||||
|
||||
The playbook will let you know if you're using any variables for those bridges:
|
||||
|
||||
- `matrix_mx_puppet_discord_*`
|
||||
- `matrix_mx_puppet_instagram_*`
|
||||
- `matrix_mx_puppet_slack_*`
|
||||
- `matrix_mx_puppet_twitter_*`
|
||||
|
||||
You'll need to remove them from `vars.yml` and potentially uninstall them manually. Consult pages below for details:
|
||||
|
||||
- [Instruction for MX Puppet Discord bridge](./docs/configuring-playbook-bridge-mx-puppet-discord.md#uninstalling-the-bridge-manually)
|
||||
- [Instruction for MX Puppet Instagram bridge](./docs/configuring-playbook-bridge-mx-puppet-instagram.md#uninstalling-the-bridge-manually)
|
||||
- [Instruction for MX Puppet Slack bridge](./docs/configuring-playbook-bridge-mx-puppet-slack.md#uninstalling-the-bridge-manually)
|
||||
- [Instruction for MX Puppet Twitter bridge](./docs/configuring-playbook-bridge-mx-puppet-twitter.md#uninstalling-the-bridge-manually)
|
||||
|
||||
# 2025-11-04
|
||||
|
||||
## The Go Skype bridge has been removed from the playbook
|
||||
|
||||
The [go-skype-bridge](./docs/configuring-playbook-bridge-go-skype-bridge.md) has been removed from the playbook, as Skype has been discontinued since the May 2025.
|
||||
|
||||
The playbook will let you know if you're using any `matrix_go_skype_bridge_*` variables. You'll need to remove them from `vars.yml` and potentially [uninstall the bridge manually](./docs/configuring-playbook-bridge-go-skype-bridge.md#uninstalling-the-bridge-manually).
|
||||
|
||||
# 2025-10-02
|
||||
|
||||
## Element Admin support
|
||||
|
||||
The playbook now supports [Element Admin](./docs/configuring-playbook-element-admin.md) - a new web-based administration panel for Synapse and [Matrix Authentication Service](./docs/configuring-playbook-matrix-authentication-service.md).
|
||||
|
||||
Deployments based on Matrix Authentication Service may find it useful to run both Synapse Admin and Element Admin at the same time.
|
||||
|
||||
Deployments that don't rely on Matrix Authentication Service are unlikely to find anything useful in Element Admin right now (it's too basic in its current form).
|
||||
|
||||
|
||||
# 2025-04-26
|
||||
|
||||
## Continuwuity support
|
||||
|
||||
Thanks to [Virkkunen](https://github.com/Virkkunen), we now have optional experimental [Continuwuity](./docs/configuring-playbook-continuwuity.md) homeserver support.
|
||||
|
||||
Continuwuity is a fork of [conduwuit](./docs/configuring-playbook-conduwuit.md), which the playbook also supports. It appears that conduwuit has been abandoned and various forks (like Continuwuity, [Tuwunel](https://github.com/matrix-construct/tuwunel) and possibly others) are continuing in its path.
|
||||
|
||||
Existing installations do **not** need to be updated. **Synapse is still the default homeserver implementation** installed by the playbook.
|
||||
|
||||
People that used to run conduwuit, may wish to:
|
||||
|
||||
- either [migrate from conduwuit to Continuwuity](./docs/configuring-playbook-continuwuity.md#migrating-from-conduwuit)
|
||||
- or wait for some of the other forks to progress and for support for them to get added to the playbook
|
||||
|
||||
**The homeserver implementation of an existing server cannot be changed** (e.g. from Synapse/Conduit/Dendrite to Continuwuity) without data loss.
|
||||
|
||||
|
||||
# 2025-04-09
|
||||
|
||||
## Element Call frontend installation is now optional
|
||||
@@ -138,7 +249,7 @@ To **completely eliminate the problem** of DDoS amplification attacks done throu
|
||||
|
||||
The playbook now **only exposes the Coturn STUN port (`3478`) over TCP by default**.
|
||||
|
||||
💡 Users may wish to further remove the (now unnnecessary) firewall rule allowing access to `3478/udp`.
|
||||
💡 Users may wish to further remove the (now unnecessary) firewall rule allowing access to `3478/udp`.
|
||||
|
||||
If you'd like the Coturn STUN port to be exposed over UDP like before, you can revert to the previous behavior by using the following configuration in your `vars.yml` file:
|
||||
|
||||
@@ -152,7 +263,7 @@ matrix_coturn_container_stun_plain_host_bind_port_udp: "3478"
|
||||
|
||||
# 2025-02-17
|
||||
|
||||
## FluffyChat Web suport
|
||||
## FluffyChat Web support
|
||||
|
||||
Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook now supports [FluffyChat Web](https://github.com/krille-chan/fluffychat) as an additional Matrix client you can self-host.
|
||||
|
||||
@@ -174,7 +285,7 @@ The playbook will let you know if you're using any `matrix_mautrix_hangouts_*` v
|
||||
|
||||
## Redis and KeyDB are no longer part of the playbook
|
||||
|
||||
**TLDR**: The playbook now exclusively uses Valkey as its Redis-compatible memorystore implementation, removing support for Redis and KeyDB. Most users are unaffected by this change unless they explicitly configured Redis or KeyDB variables. Only users that were explicitly definining `redis_*` or `keydb_*` variables will need to update their configuration to use `valkey_*` variables instead.
|
||||
**TLDR**: The playbook now exclusively uses Valkey as its Redis-compatible memorystore implementation, removing support for Redis and KeyDB. Most users are unaffected by this change unless they explicitly configured Redis or KeyDB variables. Only users that were explicitly defining `redis_*` or `keydb_*` variables will need to update their configuration to use `valkey_*` variables instead.
|
||||
|
||||
The playbook has gone through several iterations of memorystore implementations:
|
||||
|
||||
@@ -727,7 +838,7 @@ For people building commercial products on top of Synapse, they may have to eith
|
||||
|
||||
We're no lawyers and this changelog entry does not aim to give you the best legal advice, so please research on your own!
|
||||
|
||||
If you'd like to continue using the old Apache-2.0-licensed Synapse (for a while longer anyway), the playbook makes it possible by intruducing a new Ansible variable. You can do it like this:
|
||||
If you'd like to continue using the old Apache-2.0-licensed Synapse (for a while longer anyway), the playbook makes it possible by introducing a new Ansible variable. You can do it like this:
|
||||
|
||||
```yaml
|
||||
# Switch the organization that Synapse container images (or source code for self-building) are pulled from.
|
||||
@@ -810,7 +921,7 @@ Despite these downsides (which the playbook manages automatically), we believe i
|
||||
|
||||
People running the default Traefik setup do not need to do anything to make Traefik take on this extra job. Your Traefik configuration will be updated automatically.
|
||||
|
||||
**People runnning their own Traefik reverse-proxy need to do [minor adjustments](#people-managing-their-own-traefik-instance-need-to-do-minor-changes)**, as described in the section below.
|
||||
**People running their own Traefik reverse-proxy need to do [minor adjustments](#people-managing-their-own-traefik-instance-need-to-do-minor-changes)**, as described in the section below.
|
||||
|
||||
You may disable Traefik acting as an intermediary by explicitly setting `matrix_playbook_public_matrix_federation_api_traefik_entrypoint_enabled` to `false`. Services would then be configured to talk to the homeserver directly, giving you a slight performance boost and a "simpler" Traefik setup. However, such a configuration is less tested and will cause troubles, especially if you enable more services (like `matrix-media-repo`, etc.) in the future. As such, it's not recommended.
|
||||
|
||||
@@ -2796,7 +2907,7 @@ See our [Migrating to Element Web](docs/configuring-playbook-riot-web.md#migrati
|
||||
|
||||
## Steam bridging support via mx-puppet-steam
|
||||
|
||||
Thanks to [Hugues Morisset](https://github.com/izissise)'s efforts, the playbook now supports bridging to [Steam](https://steamapp.com/) via the [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) bridge. See our [Setting up MX Puppet Steam bridging](docs/configuring-playbook-bridge-mx-puppet-steam.md) documentation page for getting started.
|
||||
Thanks to [Hugues Morisset](https://github.com/izissise)'s efforts, the playbook now supports bridging to [Steam](https://steamapp.com/) via the [mx-puppet-steam](https://codeberg.org/icewind/mx-puppet-steam) bridge. See our [Setting up MX Puppet Steam bridging](docs/configuring-playbook-bridge-mx-puppet-steam.md) documentation page for getting started.
|
||||
|
||||
|
||||
# 2020-07-01
|
||||
@@ -2833,7 +2944,7 @@ As always, re-running the playbook is enough to get the updated bits.
|
||||
|
||||
## SMS bridging requires db reset
|
||||
|
||||
The current version of [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) needs you to delete the database to work as expected. Just remove `/matrix/matrix-sms-bridge/database/*`. It also adds a new requried var `matrix_sms_bridge_default_region`.
|
||||
The current version of [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) needs you to delete the database to work as expected. Just remove `/matrix/matrix-sms-bridge/database/*`. It also adds a new required var `matrix_sms_bridge_default_region`.
|
||||
|
||||
To reuse your existing rooms, invite `@smsbot:yourServer` to the room or write a message. You are also able to use automated room creation with telephonenumers by writing `sms send -t 01749292923 "Hello World"` in a room with `@smsbot:yourServer`. See [the docs](https://github.com/benkuly/matrix-sms-bridge) for more information.
|
||||
|
||||
@@ -2865,7 +2976,7 @@ Until the issue gets fixed, we're making User Directory search not go to ma1sd b
|
||||
|
||||
This upgrades matrix-appservice-irc from 0.14.1 to 0.16.0. Upstream
|
||||
made a change to how you define manual mappings. If you added a
|
||||
`mapping` to your configuration, you will need to update it accoring
|
||||
`mapping` to your configuration, you will need to update it according
|
||||
to the [upstream
|
||||
instructions](https://github.com/matrix-org/matrix-appservice-irc/blob/master/CHANGELOG.md#0150-2020-02-05). If you did not include `mappings` in your configuration for IRC, no
|
||||
change is necessary. `mappings` is not part of the default
|
||||
@@ -3028,7 +3139,7 @@ As per this [advisory blog post](https://matrix.org/blog/2019/11/09/avoiding-unw
|
||||
|
||||
Our general goal is to favor privacy and security when running personal (family & friends) and corporate homeservers. Both of these likely benefit from having a more secure default of **not showing the room directory without authentication** and **not publishing the room directory over federation**.
|
||||
|
||||
As with anything else, these new defaults can be overriden by changing the `matrix_synapse_allow_public_rooms_without_auth` and `matrix_synapse_allow_public_rooms_over_federation` variables, respectively.
|
||||
As with anything else, these new defaults can be overridden by changing the `matrix_synapse_allow_public_rooms_without_auth` and `matrix_synapse_allow_public_rooms_over_federation` variables, respectively.
|
||||
|
||||
|
||||
# 2019-10-05
|
||||
@@ -3582,7 +3693,7 @@ The following changes had to be done:
|
||||
|
||||
- glue variables had to be introduced to the playbook, so it can wire together the various components. Those glue vars are stored in the [`group_vars/matrix-servers`](group_vars/matrix-servers) file. When overriding variables for a given component (role), you need to be aware of both the role defaults (`role/ROLE/defaults/main.yml`) and the role's corresponding section in the [`group_vars/matrix-servers`](group_vars/matrix-servers) file.
|
||||
|
||||
- `matrix_postgres_use_external` has been superceeded by the more consistently named `matrix_postgres_enabled` variable and a few other `matrix_synapse_database_` variables. See the [Using an external PostgreSQL server (optional)](docs/configuring-playbook-external-postgres.md) documentation page for an up-to-date replacement.
|
||||
- `matrix_postgres_use_external` has been superseded by the more consistently named `matrix_postgres_enabled` variable and a few other `matrix_synapse_database_` variables. See the [Using an external PostgreSQL server (optional)](docs/configuring-playbook-external-postgres.md) documentation page for an up-to-date replacement.
|
||||
|
||||
- Postgres tools (`matrix-postgres-cli` and `matrix-make-user-admin`) are no longer installed if you're not enabling the `matrix-postgres` role (`matrix_postgres_enabled: false`)
|
||||
|
||||
@@ -3771,7 +3882,7 @@ matrix_riot_web_integrations_jitsi_widget_url: "https://dimension.t2bot.io/widge
|
||||
|
||||
There's now a new `matrix_nginx_proxy_ssl_protocols` playbook variable, which controls the SSL protocols used to serve Riot and Synapse. Its default value is `TLSv1.1 TLSv1.2`. This playbook previously used `TLSv1 TLSv1.1 TLSv1.2` to serve Riot and Synapse.
|
||||
|
||||
You may wish to reenable TLSv1 if you need to access Riot in older browsers.
|
||||
You may wish to re-enable TLSv1 if you need to access Riot in older browsers.
|
||||
|
||||
Note: Currently the dockerized nginx doesn't support TLSv1.3. See https://github.com/nginxinc/docker-nginx/issues/190 for more details.
|
||||
|
||||
|
||||
13
README.md
13
README.md
@@ -1,4 +1,4 @@
|
||||
[](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com) [](https://liberapay.com/s.pantaleev/donate) [](https://api.reuse.software/info/github.com/spantaleev/matrix-docker-ansible-deploy)
|
||||
[](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com) [](https://liberapay.com/s.pantaleev/donate) [](https://api.reuse.software/info/github.com/spantaleev/matrix-docker-ansible-deploy)
|
||||
|
||||
# Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker
|
||||
|
||||
@@ -53,6 +53,7 @@ The homeserver is the backbone of your Matrix system. Choose one from the follow
|
||||
| [Synapse](https://github.com/element-hq/synapse) | ✅ | Storing your data and managing your presence in the [Matrix](http://matrix.org/) network | [Link](docs/configuring-playbook-synapse.md) |
|
||||
| [Conduit](https://conduit.rs) | ❌ | Storing your data and managing your presence in the [Matrix](http://matrix.org/) network. Conduit is a lightweight open-source server implementation of the Matrix Specification with a focus on easy setup and low system requirements | [Link](docs/configuring-playbook-conduit.md) |
|
||||
| [conduwuit](https://conduwuit.puppyirl.gay/) | ❌ | Storing your data and managing your presence in the [Matrix](http://matrix.org/) network. conduwuit is a fork of Conduit. | [Link](docs/configuring-playbook-conduwuit.md) |
|
||||
| [continuwuity](https://continuwuity.org) | ❌ | Storing your data and managing your presence in the [Matrix](http://matrix.org/) network. continuwuity is a continuation of conduwuit. | [Link](docs/configuring-playbook-continuwuity.md) |
|
||||
| [Dendrite](https://github.com/element-hq/dendrite) | ❌ | Storing your data and managing your presence in the [Matrix](http://matrix.org/) network. Dendrite is a second-generation Matrix homeserver written in Go, an alternative to Synapse. | [Link](docs/configuring-playbook-dendrite.md) |
|
||||
|
||||
### Clients
|
||||
@@ -131,15 +132,12 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
||||
| [matrix-appservice-slack](https://github.com/matrix-org/matrix-appservice-slack) | ❌ | Bridge to [Slack](https://slack.com/) | [Link](docs/configuring-playbook-bridge-appservice-slack.md) |
|
||||
| [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) | ❌ | Bridge for generic webhooks and multiple project management services, such as GitHub, GitLab, Figma, and Jira in particular | [Link](docs/configuring-playbook-bridge-hookshot.md) |
|
||||
| [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) | ❌ | Bridge to SMS | [Link](docs/configuring-playbook-bridge-matrix-bridge-sms.md) |
|
||||
| [matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge) | ❌ | Bridge to [Steam](https://steampowered.com/) | [Link](docs/configuring-playbook-bridge-steam.md) |
|
||||
| [matrix-wechat](https://github.com/duo/matrix-wechat) | ❌ | Bridge to [WeChat](https://www.wechat.com/) | [Link](docs/configuring-playbook-bridge-wechat.md) |
|
||||
| [MatrixZulipBridge](https://github.com/GearKite/MatrixZulipBridge) | ❌ | Puppeting appservice bridge for [Zulip](https://zulip.com/) | [Link](docs/configuring-playbook-bridge-zulip.md) |
|
||||
| [Heisenbridge](https://github.com/hifi/heisenbridge) | ❌ | Bouncer-style bridge to [IRC](https://wikipedia.org/wiki/Internet_Relay_Chat) | [Link](docs/configuring-playbook-bridge-heisenbridge.md) |
|
||||
| [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) | ❌ | Bridge to [Skype](https://www.skype.com) | [Link](docs/configuring-playbook-bridge-go-skype-bridge.md) |
|
||||
| [mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack) | ❌ | Bridge to [Slack](https://slack.com) | [Link](docs/configuring-playbook-bridge-mx-puppet-slack.md) |
|
||||
| [mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram) | ❌ | Bridge for Instagram-DMs ([Instagram](https://www.instagram.com/)) | [Link](docs/configuring-playbook-bridge-mx-puppet-instagram.md) |
|
||||
| [mx-puppet-twitter](https://github.com/Sorunome/mx-puppet-twitter) | ❌ | Bridge for Twitter-DMs ([Twitter](https://twitter.com/)) | [Link](docs/configuring-playbook-bridge-mx-puppet-twitter.md) |
|
||||
| [mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord) | ❌ | Bridge to [Discord](https://discordapp.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-discord.md) |
|
||||
| [mx-puppet-groupme](https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme) | ❌ | Bridge to [GroupMe](https://groupme.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-groupme.md) |
|
||||
| [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) | ❌ | Bridge to [Steam](https://steamapp.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-steam.md) |
|
||||
| [mx-puppet-steam](https://codeberg.org/icewind/mx-puppet-steam) | ❌ | Bridge to [Steam](https://steamapp.com/) | [Link](docs/configuring-playbook-bridge-mx-puppet-steam.md) |
|
||||
| [Postmoogle](https://github.com/etkecc/postmoogle) | ❌ | Email to Matrix bridge | [Link](docs/configuring-playbook-bridge-postmoogle.md) |
|
||||
|
||||
### Bots
|
||||
@@ -181,6 +179,7 @@ Various services that don't fit any other categories.
|
||||
| [synapse_auto_accept_invite](https://github.com/matrix-org/synapse-auto-accept-invite) | ❌ | Synapse module to automatically accept invites | [Link](docs/configuring-playbook-synapse-auto-accept-invite.md) |
|
||||
| [synapse_auto_compressor](https://github.com/matrix-org/rust-synapse-compress-state/#automated-tool-synapse_auto_compressor) | ❌ | Cli tool that automatically compresses `state_groups` database table in background | [Link](docs/configuring-playbook-synapse-auto-compressor.md) |
|
||||
| [Matrix Corporal](https://github.com/devture/matrix-corporal) (advanced) | ❌ | Reconciliator and gateway for a managed Matrix server | [Link](docs/configuring-playbook-matrix-corporal.md) |
|
||||
| [Matrix.to](https://github.com/matrix-org/matrix.to) | ❌ | Simple URL redirection service for the Matrix ecosystem | [Link](docs/configuring-playbook-matrixto.md) |
|
||||
| [Etherpad](https://etherpad.org) | ❌ | Open source collaborative text editor | [Link](docs/configuring-playbook-etherpad.md) |
|
||||
| [Jitsi](https://jitsi.org/) | ❌ | Open source video-conferencing platform | [Link](docs/configuring-playbook-jitsi.md) |
|
||||
| [Cactus Comments](https://cactus.chat) | ❌ | Federated comment system built on Matrix | [Link](docs/configuring-playbook-cactus-comments.md) |
|
||||
|
||||
@@ -13,10 +13,12 @@ path = [
|
||||
"i18n/PUBLISHED_LANGUAGES",
|
||||
"i18n/requirements.txt",
|
||||
"roles/custom/**/*.repo",
|
||||
".codespellrc",
|
||||
".editorconfig",
|
||||
".envrc",
|
||||
".gitattributes",
|
||||
".gitignore",
|
||||
".pre-commit-config.yaml",
|
||||
".yamllint",
|
||||
"ansible.cfg",
|
||||
"flake.lock",
|
||||
|
||||
@@ -11,7 +11,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
2023 is probably [the year of AI](https://journal.everypixel.com/2023-the-year-of-ai), with millions of people jumping aboard [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/chatgpt) train. matrix-docker-ansible-deploy is no stranger to this and 2023 began with a PR from [bertybuttface](https://github.com/bertybuttface) who added support for [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#chatgpt-support)). While OpenAI's chat GPT website was frequently overloaded in the past, their API was up which made using this bot both convenient and more reliable.
|
||||
|
||||
AI aside, with the playbook's focus being containers, we're **doubling down on being "container native"** and becoming more interoperable for people hosting other containers on the Matrix server. In [2022](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/YEAR-IN-REVIEW.md#2022), we've announced a few sibling Ansible playbooks, their use of [Traefik](https://doc.traefik.io/traefik/) and the possiblity of matrix-docker-ansible-deploy also switching to this reverse-proxy. This prediction materialized quickly. The **largest change** in the playbook in 2023 happened way back in February - matrix-docker-ansible-deploy [starting the switch from nginx to Traefik](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#backward-compatibility-reverse-proxy-configuration-changes-and-initial-traefik-support) and then quickly [making Treafik the default reverse-proxy](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#traefik-is-the-default-reverse-proxy-now). As noted in the changelog entries, we envisioned a quick and complete elimination of `matrix-nginx-proxy`, but at the end of 2023, it hasn't happened yet. The playbook is already using Traefik as the front-most reverse-proxy, but nginx (via `matrix-nginx-proxy`) is still around - it has taken a step back and is only used internally for new setups. Work got to a stall due to:
|
||||
AI aside, with the playbook's focus being containers, we're **doubling down on being "container native"** and becoming more interoperable for people hosting other containers on the Matrix server. In [2022](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/YEAR-IN-REVIEW.md#2022), we've announced a few sibling Ansible playbooks, their use of [Traefik](https://doc.traefik.io/traefik/) and the possibility of matrix-docker-ansible-deploy also switching to this reverse-proxy. This prediction materialized quickly. The **largest change** in the playbook in 2023 happened way back in February - matrix-docker-ansible-deploy [starting the switch from nginx to Traefik](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#backward-compatibility-reverse-proxy-configuration-changes-and-initial-traefik-support) and then quickly [making Treafik the default reverse-proxy](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#traefik-is-the-default-reverse-proxy-now). As noted in the changelog entries, we envisioned a quick and complete elimination of `matrix-nginx-proxy`, but at the end of 2023, it hasn't happened yet. The playbook is already using Traefik as the front-most reverse-proxy, but nginx (via `matrix-nginx-proxy`) is still around - it has taken a step back and is only used internally for new setups. Work got to a stall due to:
|
||||
|
||||
* complexity: untangling the overly large and messy `matrix-nginx-proxy` component is difficult
|
||||
* the current setup became "good enough" because nginx has become an internal implementation detail for those who have migrated to Traefik. Traefik is already the default public reverse-proxy and gives better possibilities to people wishing to run other web-exposed containers on their Matrix server via [Docker Compose](https://docs.docker.com/compose/), other Ansible playbooks like [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) (more about this one, below) or any other way.
|
||||
|
||||
@@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# Table of Contents
|
||||
|
||||
## ⬇️ Installaton guides <!-- NOTE: the 🚀 emoji is used by "Getting started" on README.md -->
|
||||
## ⬇️ Installation guides <!-- NOTE: the 🚀 emoji is used by "Getting started" on README.md -->
|
||||
|
||||
There are two installation guides available for beginners and advanced users.
|
||||
|
||||
|
||||
@@ -20,10 +20,13 @@ To manually check which version of Ansible you're on, run: `ansible --version`.
|
||||
|
||||
For the **best experience**, we recommend getting the **latest version of Ansible available**.
|
||||
|
||||
We're not sure what's the minimum version of Ansible that can run this playbook successfully. The lowest version that we've confirmed (on 2022-11-26) to be working fine is: `ansible-core` (`2.11.7`) combined with `ansible` (`4.10.0`).
|
||||
We're not sure what's the minimum version of Ansible that can run this playbook successfully. The lowest version that we suspect (on 2025-09-03) to be working fine is: `ansible-core` (`2.15.1`).
|
||||
|
||||
If your distro ships with an Ansible version older than this, you may run into issues. Consider [Upgrading Ansible](#upgrading-ansible) or [using Ansible via Docker](#using-ansible-via-docker).
|
||||
|
||||
> [!WARNING]
|
||||
> One reason for the version requirement being as such is that the playbook by default installs Docker for you using [this Docker role](https://github.com/geerlingguy/ansible-role-docker) which [has a hard requirement on Ansible v2.15.1](https://github.com/geerlingguy/ansible-role-docker/commit/7f44a1d9ad8132819ea9852918bca5dab8757cd0). If you install Docker yourself another way, you can tell the playbook to skip running this role (by adding `matrix_playbook_docker_installation_enabled: false` to your `vars.yml` configuration). It may then be possible to get the playbook running on an older version of Ansible. Still, this is a complication and your mileage may vary. We recommend [upgrading Ansible](#upgrading-ansible) instead of going into uncharted territory.
|
||||
|
||||
## Upgrading Ansible
|
||||
|
||||
Depending on your distribution, you may be able to upgrade Ansible in a few different ways:
|
||||
@@ -71,7 +74,7 @@ docker run \
|
||||
-w /work \
|
||||
--mount type=bind,src=`pwd`,dst=/work \
|
||||
--entrypoint=/bin/sh \
|
||||
ghcr.io/devture/ansible:11.1.0-r0-0
|
||||
ghcr.io/devture/ansible:11.6.0-r0-0
|
||||
```
|
||||
|
||||
Once you execute the above command, you'll be dropped into a `/work` directory inside a Docker container. The `/work` directory contains the playbook's code.
|
||||
@@ -90,9 +93,9 @@ docker run \
|
||||
--rm \
|
||||
-w /work \
|
||||
--mount type=bind,src=`pwd`,dst=/work \
|
||||
--mount type=bind,src$HOME/.ssh/id_ed25519,dst=/root/.ssh/id_ed25519,ro \
|
||||
--mount type=bind,src=$HOME/.ssh/id_ed25519,dst=/root/.ssh/id_ed25519,ro \
|
||||
--entrypoint=/bin/sh \
|
||||
ghcr.io/devture/ansible:11.1.0-r0-0
|
||||
ghcr.io/devture/ansible:11.6.0-r0-0
|
||||
```
|
||||
|
||||
The above command tries to mount an SSH key (`$HOME/.ssh/id_ed25519`) into the container (at `/root/.ssh/id_ed25519`). If your SSH key is at a different path (not in `$HOME/.ssh/id_ed25519`), adjust that part.
|
||||
@@ -117,7 +120,7 @@ Then, to be asked for the password whenever running an `ansible-playbook` comman
|
||||
|
||||
#### Resolve directory ownership issues
|
||||
|
||||
Because you're `root` in the container running Ansible and this likely differs fom the owner (your regular user account) of the playbook directory outside of the container, certain playbook features which use `git` locally may report warnings such as:
|
||||
Because you're `root` in the container running Ansible and this likely differs from the owner (your regular user account) of the playbook directory outside of the container, certain playbook features which use `git` locally may report warnings such as:
|
||||
|
||||
> fatal: unsafe repository ('/work' is owned by someone else)
|
||||
> To add an exception for this directory, call:
|
||||
|
||||
@@ -95,13 +95,13 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
|
||||
## Usage
|
||||
|
||||
If you made it through all the steps above and your main control room was joined by a user called `@draupnir-main:example.com` you have succesfully installed Draupnir for All and can now start using it.
|
||||
If you made it through all the steps above and your main control room was joined by a user called `@draupnir-main:example.com` you have successfully installed Draupnir for All and can now start using it.
|
||||
|
||||
The installation of Draupnir for all in this playbook is very much Alpha quality. Usage-wise, Draupnir for all is almost identical to Draupnir bot mode.
|
||||
|
||||
### Granting Users the ability to use D4A
|
||||
|
||||
Draupnir for all includes several security measures like that it only allows users that are on its allow list to ask for a bot. To add a user to this list we have 2 primary options. Using the chat to tell Draupnir to do this for us or if you want to automatically do it by sending `m.policy.rule.user` events that target the subject you want to allow provisioning for with the `org.matrix.mjolnir.allow` recomendation. Using the chat is recomended.
|
||||
Draupnir for all includes several security measures like that it only allows users that are on its allow list to ask for a bot. To add a user to this list we have 2 primary options. Using the chat to tell Draupnir to do this for us or if you want to automatically do it by sending `m.policy.rule.user` events that target the subject you want to allow provisioning for with the `org.matrix.mjolnir.allow` recommendation. Using the chat is recommended.
|
||||
|
||||
The bot requires a powerlevel of 50 in the management room to control who is allowed to use the bot. The bot does currently not say anything if this is true or false. (This is considered a bug and is documented in issue [#297](https://github.com/the-draupnir-project/Draupnir/issues/297))
|
||||
|
||||
|
||||
@@ -242,7 +242,7 @@ matrix_bot_baibot_config_agents_static_definitions_openai_config_api_key: "YOUR_
|
||||
# matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_prompt: "{{ matrix_bot_baibot_config_agents_static_definitions_prompt }}"
|
||||
|
||||
# If you'd like to use another text-generation agent, uncomment and adjust:
|
||||
# matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_model_id: gpt-4o
|
||||
# matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_model_id: gpt-4.1
|
||||
```
|
||||
|
||||
Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/openai`.
|
||||
|
||||
@@ -1,98 +1,25 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 - 2024 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2023 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2019 - 2025 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2022 Dennis Ciba
|
||||
SPDX-FileCopyrightText: 2022 Nikita Chernyi
|
||||
SPDX-FileCopyrightText: 2023 - 2024 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up matrix-bot-chatgpt (optional, unmaintained)
|
||||
# Setting up matrix-chatgpt-bot (optional, removed)
|
||||
|
||||
**Note**: [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) is now an archived (**unmaintained**) project. Talking to ChatGPT (and many other LLM providers) can happen via the much more featureful [baibot](https://github.com/etkecc/baibot), which can be [installed using this playbook](configuring-playbook-bot-baibot.md). Consider using that bot instead of this one.
|
||||
🪦 The playbook used to be able to install and configure [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot), but no longer includes this component.
|
||||
|
||||
The playbook can install and configure [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) for you.
|
||||
While not a 1:1 replacement, the bot's author suggests taking a look at [baibot](https://github.com/etkecc/baibot) as a replacement, which can also be [installed using this playbook](configuring-playbook-bot-baibot.md).
|
||||
|
||||
Talk to [ChatGPT](https://openai.com/blog/chatgpt/) via your favourite Matrix client!
|
||||
## Uninstalling matrix-chatgpt-bot manually
|
||||
|
||||
See the project's [documentation](https://github.com/matrixgpt/matrix-chatgpt-bot/blob/main/README.md) to learn what it does and why it might be useful to you.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
### Obtain an OpenAI API key
|
||||
|
||||
To use the bot, you'd need to obtain an API key from [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys).
|
||||
|
||||
### Register the bot account
|
||||
|
||||
The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot.
|
||||
|
||||
Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`.
|
||||
|
||||
You can use the playbook to [register a new user](registering-users.md):
|
||||
If you still have the matrix-chatgpt-bot component installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:
|
||||
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.chatgpt password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user
|
||||
systemctl disable --now matrix-bot-chatgpt.service
|
||||
|
||||
rm -rf /matrix/chatgpt
|
||||
```
|
||||
|
||||
### Obtain an access token and create encryption keys
|
||||
|
||||
The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md).
|
||||
|
||||
> [!WARNING]
|
||||
> Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.
|
||||
|
||||
To make sure the bot can read encrypted messages, it will need an encryption key, just like any other new user. While obtaining the access token, follow the prompts to setup a backup key. More information can be found in the [Element documentation](https://element.io/help#encryption6).
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `API_KEY_HERE` with the API key retrieved [here](#obtain-an-openai-api-key) and `ACCESS_TOKEN_HERE` with the access token created [here](#obtain-an-access-token-and-create-encryption-keys), respectively.
|
||||
|
||||
```yaml
|
||||
matrix_bot_chatgpt_enabled: true
|
||||
|
||||
matrix_bot_chatgpt_openai_api_key: 'API_KEY_HERE'
|
||||
|
||||
# Uncomment and adjust this part if you'd like to use a username different than the default
|
||||
# matrix_bot_chatgpt_matrix_bot_username_localpart: 'bot.chatgpt'
|
||||
|
||||
matrix_bot_chatgpt_matrix_access_token: 'ACCESS_TOKEN_HERE'
|
||||
|
||||
# Configuring the system promt used, needed if the bot is used for special tasks.
|
||||
# More information: https://github.com/mustvlad/ChatGPT-System-Prompts
|
||||
matrix_bot_chatgpt_matrix_bot_prompt_prefix: 'Instructions:\nYou are ChatGPT, a large language model trained by OpenAI.'
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the bot.
|
||||
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-bot-chatgpt/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
|
||||
```
|
||||
|
||||
**Notes**:
|
||||
|
||||
- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.
|
||||
|
||||
- The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`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.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.chatgpt:example.com` where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
After the bot joins the room, you can send a message to it. When you do so, use the prefix if you configured it or mention the bot.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-chatgpt`.
|
||||
|
||||
@@ -145,6 +145,20 @@ The bot can intercept the report API endpoint of the client-server API, which re
|
||||
matrix_bot_draupnir_config_web_abuseReporting: true
|
||||
```
|
||||
|
||||
### Enabling synapse-http-antispam support
|
||||
|
||||
Certain protections in Draupnir require the [synapse-http-antispam](https://github.com/maunium/synapse-http-antispam) module and a Synapse homeserver plus homeserver admin status to function. This module can be enabled in the playbook via setting `matrix_bot_draupnir_config_web_synapseHTTPAntispam_enabled` to `true` and making sure that Draupnir admin API access is enabled.
|
||||
|
||||
```yaml
|
||||
# Enables the integration between Draupnir and synapse-http-antispam module.
|
||||
matrix_bot_draupnir_config_web_synapseHTTPAntispam_enabled: true
|
||||
|
||||
# Enables draupnir to access Synapse admin APIs. This is required for the module functionality to take full effect.
|
||||
matrix_bot_draupnir_admin_api_enabled: true
|
||||
```
|
||||
|
||||
These protections need to be manually activated and consulting the [enabling protections](#enabling-built-in-protections) guide can be helpful or consulting upstream documentation.
|
||||
|
||||
<!--
|
||||
NOTE: this is unsupported by the playbook due to the admin API being inaccessible from containers currently.
|
||||
|
||||
@@ -228,9 +242,12 @@ For Draupnir to do its job, you need to [give it permissions](https://the-draupn
|
||||
|
||||
We recommend **subscribing to a public [policy list](https://the-draupnir-project.github.io/draupnir-documentation/concepts/policy-lists)** using the [watch command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-policy-lists#using-draupnirs-watch-command-to-subscribe-to-policy-rooms).
|
||||
|
||||
Polcy lists are maintained in Matrix rooms. A popular policy list is maintained in the public `#community-moderation-effort-bl:neko.dev` room.
|
||||
Policy lists are maintained in Matrix rooms. Popular ones maintained in the public are:
|
||||
|
||||
You can tell Draupnir to subscribe to it by sending the following command to the Management Room: `!draupnir watch #community-moderation-effort-bl:neko.dev`
|
||||
- `#community-moderation-effort-bl:neko.dev`
|
||||
- `#huginn-muninn-active-threats:feline.support`
|
||||
|
||||
You can tell Draupnir to subscribe to each of these by sending the following command to the Management Room: `!draupnir watch POLICY_LIST_ADDRESS_HERE` (e.g. `!draupnir watch #community-moderation-effort-bl:neko.dev`)
|
||||
|
||||
#### Creating your own policy lists and rules
|
||||
|
||||
@@ -245,7 +262,7 @@ The simplest and most useful entity to target is `user`. Below are a few example
|
||||
To create rules, you run commands in the Management Room (**not** in the policy list room).
|
||||
|
||||
- (ban a single user on a given homeserver): `!draupnir ban @charles:example.com my-bans Rude to others`
|
||||
- (ban all users on a given homeserver by using a [wildcard](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#wildcards)): `!draupnir ban @*:example.org my-bans Spam server - all users are fake`
|
||||
- (ban all users on a given homeserver by using a [wildcard](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#wildcards)): `!draupnir ban @*:example.org my-bans Spam server, all users are fake`
|
||||
|
||||
As a result of running these commands, you may observe:
|
||||
|
||||
@@ -256,14 +273,14 @@ You can undo bans with the [unban command](https://the-draupnir-project.github.i
|
||||
|
||||
### Enabling built-in protections
|
||||
|
||||
You can also **turn on various built-in [protections](https://the-draupnir-project.github.io/draupnir-documentation/protections)** like `JoinWaveShortCircuit` ("If X amount of users join in Y time, set the room to invite-only").
|
||||
You can also **turn on various built-in [protections](https://the-draupnir-project.github.io/draupnir-documentation/protections)** like `JoinWaveShortCircuitProtection` ("If X amount of users join in Y time, set the room to invite-only").
|
||||
|
||||
To **see which protections are available and which are enabled**, send a `!draupnir protections` command to the Management Room.
|
||||
|
||||
To **see the configuration options for a given protection**, send a `!draupnir protections show PROTECTION_NAME` (e.g. `!draupnir protections show JoinWaveShortCircuit`).
|
||||
To [**see the configuration options for a given protection**](https://the-draupnir-project.github.io/draupnir-documentation/protections/configuring-protections#displaying-the-protection-settings), send a `!draupnir protections show PROTECTION_NAME` (e.g. `!draupnir protections show JoinWaveShortCircuitProtection`).
|
||||
|
||||
To **set a specific option for a given protection**, send a command like this: `!draupnir config set PROTECTION_NAME.OPTION VALUE` (e.g. `!draupnir config set JoinWaveShortCircuit.timescaleMinutes 30`).
|
||||
To [**set a specific option for a given protection**](https://the-draupnir-project.github.io/draupnir-documentation/protections/configuring-protections#changing-protection-settings), send a command like this: `!draupnir protections config set PROTECTION_NAME OPTION VALUE` (e.g. `!draupnir protections config set JoinWaveShortCircuitProtection timescaleMinutes 30`).
|
||||
|
||||
To **enable a given protection**, send a command like this: `!draupnir enable PROTECTION_NAME` (e.g. `!draupnir enable JoinWaveShortCircuit`).
|
||||
To [**enable a given protection**](https://the-draupnir-project.github.io/draupnir-documentation/protections/block-invitations-on-server-protection#enabling-the-protection), send a command like this: `!draupnir protections enable PROTECTION_NAME` (e.g. `!draupnir protections enable JoinWaveShortCircuitProtection`).
|
||||
|
||||
To **disable a given protection**, send a command like this: `!draupnir disable PROTECTION_NAME` (e.g. `!draupnir disable JoinWaveShortCircuit`).
|
||||
To **disable a given protection**, send a command like this: `!draupnir protections disable PROTECTION_NAME` (e.g. `!draupnir protections disable JoinWaveShortCircuitProtection`).
|
||||
|
||||
@@ -37,6 +37,10 @@ matrix_synapse_enable_registration: true
|
||||
|
||||
# Restrict registration to users with a token
|
||||
matrix_synapse_registration_requires_token: true
|
||||
|
||||
# Set an optional command prefix for the bot. This can be any arbitrary string, including whitespace.
|
||||
# Example: "!regbot "
|
||||
matrix_bot_matrix_registration_bot_bot_prefix: ""
|
||||
```
|
||||
|
||||
The bot account will be created automatically.
|
||||
@@ -77,7 +81,7 @@ Send `help` to the bot to see the available commands.
|
||||
|
||||
You can also refer to the upstream [Usage documentation](https://github.com/moan0s/matrix-registration-bot#supported-commands).
|
||||
|
||||
If you have any questions, or if you need help setting it up, read the [troublshooting guide](https://github.com/moan0s/matrix-registration-bot/blob/main/docs/troubleshooting.md) or join [#matrix-registration-bot:hyteck.de](https://matrix.to/#/#matrix-registration-bot:hyteck.de).
|
||||
If you have any questions, or if you need help setting it up, read the [troubleshooting guide](https://github.com/moan0s/matrix-registration-bot/blob/main/docs/troubleshooting.md) or join [#matrix-registration-bot:hyteck.de](https://matrix.to/#/#matrix-registration-bot:hyteck.de).
|
||||
|
||||
To clean the cache (session & encryption data) after you changed the bot's username, changed the login method from access_token to password etc… you can use:
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# Setting up Appservice Discord bridging (optional)
|
||||
|
||||
**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) and [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridges supported by the playbook.
|
||||
**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridge supported by the playbook.
|
||||
- For using as a Bot we are recommend the Appservice Discord bridge (the one being discussed here), because it supports plumbing.
|
||||
- For personal use we recommend the [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridge, because it is the most fully-featured and stable of the 3 Discord bridges supported by the playbook.
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
# Setting up Appservice Slack bridging (optional)
|
||||
|
||||
**Notes**:
|
||||
- Bridging to [Slack](https://slack.com) can also happen via the [mx-puppet-slack](configuring-playbook-bridge-mx-puppet-slack.md) and [mautrix-slack](configuring-playbook-bridge-mautrix-slack.md) bridges supported by the playbook.
|
||||
- Bridging to [Slack](https://slack.com) can also happen via the [mautrix-slack](configuring-playbook-bridge-mautrix-slack.md) bridge supported by the playbook.
|
||||
- Currently (as of November, 2024) **this component is not available for new installation unless you have already created a classic Slack application** (which the bridge makes use of in order to enable bridging between Slack and Matrix), because the creation of classic Slack applications has been discontinued since June 4 2024. The author of the bridge claims [here](https://github.com/matrix-org/matrix-appservice-slack/issues/789#issuecomment-2172947787) that he plans to support the modern Slack application and until then "the best (and only) option for new installations is to use the webhook bridging".
|
||||
|
||||
The playbook can install and configure [matrix-appservice-slack](https://github.com/matrix-org/matrix-appservice-slack) for you.
|
||||
|
||||
@@ -1,113 +1,30 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2019 - 2025 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2019 Eduardo Beltrame
|
||||
SPDX-FileCopyrightText: 2020 - 2023 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2020 Björn Marten
|
||||
SPDX-FileCopyrightText: 2020 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2020 iLyas Bakouch
|
||||
SPDX-FileCopyrightText: 2020 Tulir Asokan
|
||||
SPDX-FileCopyrightText: 2022 Dennis Ciba
|
||||
SPDX-FileCopyrightText: 2022 Kim Brose
|
||||
SPDX-FileCopyrightText: 2022 Vladimir Panteleev
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up Appservice Webhooks bridging (optional, deprecated)
|
||||
# Setting up Appservice Webhooks bridging (optional, removed)
|
||||
|
||||
**Note**: This bridge has been deprecated. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be [installed using this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bridge instead of this one.
|
||||
🪦 The playbook used to be able to install and configure [matrix-appservice-webhooks](https://github.com/turt2live/matrix-appservice-webhooks), but no longer includes this component, as it has been deprecated since more than several years.
|
||||
|
||||
The playbook can install and configure [matrix-appservice-webhooks](https://github.com/turt2live/matrix-appservice-webhooks) for you. This bridge provides support for Slack-compatible webhooks.
|
||||
You may wish to use [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) instead.
|
||||
|
||||
See the project's [documentation](https://github.com/turt2live/matrix-appservice-webhooks/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||
## Uninstalling the bridge manually
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_appservice_webhooks_enabled: true
|
||||
matrix_appservice_webhooks_api_secret: '<your_secret>'
|
||||
|
||||
# As of Synapse 1.90.0, uncomment to enable the backwards compatibility (https://matrix-org.github.io/synapse/latest/upgrade#upgrading-to-v1900) that this bridge needs.
|
||||
# Note: This deprecated method is considered insecure.
|
||||
#
|
||||
# matrix_synapse_configuration_extension_yaml: |
|
||||
# use_appservice_legacy_authorization: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the bridge.
|
||||
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-bridge-appservice-webhooks/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
- `roles/custom/matrix-bridge-appservice-webhooks/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_webhooks_configuration_extension_yaml` variable
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
```
|
||||
|
||||
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`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.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bridge, you need to invite the bridge bot user to your room in either way.
|
||||
|
||||
- Send `/invite @_webhook:example.com` (**Note**: Make sure you have administration permissions in your room)
|
||||
- Add the bridge bot to a private channel (personal channels imply you being an administrator)
|
||||
|
||||
You then need to send a message to the bridge bot to receive a private message including the webhook link:
|
||||
|
||||
```
|
||||
!webhook
|
||||
```
|
||||
|
||||
The JSON body for posting messages will have to look like this:
|
||||
|
||||
```json
|
||||
{
|
||||
"text": "Hello world!",
|
||||
"format": "plain",
|
||||
"displayName": "My Cool Webhook",
|
||||
"avatar_url": "http://i.imgur.com/IDOBtEJ.png"
|
||||
}
|
||||
```
|
||||
|
||||
You can test this via curl like so:
|
||||
If you still have matrix-appservice-webhooks installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:
|
||||
|
||||
```sh
|
||||
curl --header "Content-Type: application/json" \
|
||||
--data '{
|
||||
"text": "Hello world!",
|
||||
"format": "plain",
|
||||
"displayName": "My Cool Webhook",
|
||||
"avatar_url": "http://i.imgur.com/IDOBtEJ.png"
|
||||
}' \
|
||||
<the webhook link you've gotten from the bridge bot>
|
||||
```
|
||||
|
||||
### Setting Webhooks with Dimension integration manager
|
||||
|
||||
If you're using the [Dimension integration manager](configuring-playbook-dimension.md), you can configure the Webhooks bridge with it.
|
||||
|
||||
To configure it, open the Dimension integration manager, and go to "Settings" and "Bridges", then select edit action for "Webhook Bridge".
|
||||
|
||||
On the UI, press "Add self-hosted Bridge" button and populate "Provisioning URL" and "Shared Secret" values from `/matrix/appservice-webhooks/config/config.yaml` file's homeserver URL value and provisioning secret value, respectively.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-appservice-webhooks`.
|
||||
|
||||
### Increase logging verbosity
|
||||
|
||||
The default logging level for this component is `info`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
|
||||
|
||||
```yaml
|
||||
# Valid values: info, verbose
|
||||
matrix_appservice_webhooks_log_level: 'verbose'
|
||||
systemctl disable --now matrix-appservice-webhooks.service
|
||||
|
||||
rm -rf /matrix/appservice-webhooks
|
||||
```
|
||||
|
||||
@@ -1,68 +1,26 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2019 - 2025 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2019 Eduardo Beltrame
|
||||
SPDX-FileCopyrightText: 2021 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2022 Dennis Ciba
|
||||
SPDX-FileCopyrightText: 2022 Vladimir Panteleev
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up Go Skype Bridge bridging (optional)
|
||||
# Setting up Go Skype Bridge bridging (optional, removed)
|
||||
|
||||
The playbook can install and configure [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) for you, for bridging to [Skype](https://www.skype.com/). This bridge was created based on [mautrix-whatsapp](https://github.com/mautrix/whatsapp) and can be configured in a similar way to it.
|
||||
🪦 The playbook used to be able to install and configure [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge), but no longer includes this component, as Skype has been discontinued since May 2025.
|
||||
|
||||
See the project's [documentation](https://github.com/kelaresg/go-skype-bridge/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||
## Uninstalling the bridge manually
|
||||
|
||||
## Prerequisite (optional)
|
||||
If you still have the Go Skype bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:
|
||||
|
||||
### Enable Shared Secret Auth
|
||||
|
||||
If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook.
|
||||
|
||||
See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting.
|
||||
|
||||
**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_go_skype_bridge_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the bridge.
|
||||
|
||||
See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc.
|
||||
|
||||
**Note**: when following the guide to configure the bridge, make sure to replace `_mautrix_SERVICENAME_` in the variable names with `_go_skype_bridge_`.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
```
|
||||
|
||||
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`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.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bridge, you need to start a chat with `@skypebridgebot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-go-skype-bridge`.
|
||||
|
||||
### Increase logging verbosity
|
||||
|
||||
The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
|
||||
|
||||
```yaml
|
||||
# Valid values: fatal, error, warn, info, debug
|
||||
matrix_go_skype_bridge_log_level: 'info'
|
||||
systemctl disable --now matrix-go-skype-bridge.service
|
||||
|
||||
rm -rf /matrix/go-skype-bridge
|
||||
|
||||
/matrix/postgres/bin/cli-non-interactive 'DROP DATABASE matrix_go_skype_bridge;'
|
||||
```
|
||||
|
||||
@@ -16,8 +16,6 @@ Hookshot can bridge [Webhooks](https://en.wikipedia.org/wiki/Webhook) from softw
|
||||
|
||||
See the project's [documentation](https://matrix-org.github.io/matrix-hookshot/latest/hookshot.html) to learn what it does and why it might be useful to you.
|
||||
|
||||
**Note**: the playbook also supports [matrix-appservice-webhooks](configuring-playbook-bridge-appservice-webhooks.md), which however was deprecated by its author.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
### Download GitHub app private key (optional)
|
||||
@@ -35,7 +33,7 @@ matrix_hookshot_enabled: true
|
||||
|
||||
# Uncomment to enable end-to-bridge encryption.
|
||||
# See: https://matrix-org.github.io/matrix-hookshot/latest/advanced/encryption.html
|
||||
# matrix_hookshot_experimental_encryption_enabled: true
|
||||
# matrix_hookshot_encryption_enabled: true
|
||||
|
||||
# Uncomment and paste the contents of GitHub app private key to enable GitHub bridge.
|
||||
# Alternatively, you can use one of the other methods explained below on the "Manage GitHub Private Key with aux role" section.
|
||||
@@ -103,7 +101,6 @@ Unless indicated otherwise, the following endpoints are reachable on your `matri
|
||||
| github oauth | `/hookshot/webhooks/oauth` | `matrix_hookshot_github_oauth_endpoint` | GitHub "Callback URL" |
|
||||
| jira oauth | `/hookshot/webhooks/jira/oauth` | `matrix_hookshot_jira_oauth_endpoint` | Jira OAuth |
|
||||
| figma endpoint | `/hookshot/webhooks/figma/webhook` | `matrix_hookshot_figma_endpoint` | Figma |
|
||||
| provisioning | `/hookshot/v1/` | `matrix_hookshot_provisioning_endpoint` | Dimension [provisioning](#provisioning-api) |
|
||||
| appservice | `/hookshot/_matrix/app/` | `matrix_hookshot_appservice_endpoint` | Matrix server |
|
||||
| widgets | `/hookshot/widgetapi/` | `matrix_hookshot_widgets_endpoint` | Widgets |
|
||||
|
||||
@@ -126,20 +123,12 @@ aux_file_definitions:
|
||||
- dest: "{{ matrix_hookshot_base_path }}/{{ matrix_hookshot_github_private_key_file }}"
|
||||
content: "{{ lookup('file', '/path/to/your-github-private-key.pem') }}"
|
||||
mode: '0400'
|
||||
owner: "{{ matrix_user_username }}"
|
||||
group: "{{ matrix_user_groupname }}"
|
||||
owner: "{{ matrix_user_name }}"
|
||||
group: "{{ matrix_group_name }}"
|
||||
```
|
||||
|
||||
For more information, see the documentation in the [default configuration of the aux role](https://github.com/mother-of-all-self-hosting/ansible-role-aux/blob/main/defaults/main.yml).
|
||||
|
||||
### Provisioning API
|
||||
|
||||
The provisioning API will be enabled automatically if you set `matrix_dimension_enabled: true` and provided a `matrix_hookshot_provisioning_secret`, unless you override it either way. To use hookshot with Dimension, you will need to enter as "Provisioning URL": `http://matrix-hookshot:9002`, which is made up of the variables `matrix_hookshot_container_url` and `matrix_hookshot_provisioning_port`.
|
||||
|
||||
### Collision with matrix-appservice-webhooks
|
||||
|
||||
If you are also running [matrix-appservice-webhooks](configuring-playbook-bridge-appservice-webhooks.md), it reserves its namespace by the default setting `matrix_appservice_webhooks_user_prefix: '_webhook_'`. You should take care if you modify its or hookshot's prefix that they do not collide with each other's namespace (default `matrix_hookshot_generic_userIdPrefix: '_webhooks_'`).
|
||||
|
||||
### Enable metrics
|
||||
|
||||
The playbook can enable and configure the metrics of the service for you.
|
||||
@@ -172,7 +161,7 @@ To `matrix_hookshot_container_labels_metrics_middleware_basic_auth_users`, set t
|
||||
|
||||
#### Enable Grafana (optional)
|
||||
|
||||
Probably you wish to enable Grafana along with Prometheus for generating graphs of the metics.
|
||||
Probably you wish to enable Grafana along with Prometheus for generating graphs of the metrics.
|
||||
|
||||
To enable Grafana, see [this section](configuring-playbook-prometheus-grafana.md#adjusting-the-playbook-configuration-grafana) for instructions.
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@ To enable the bridge, add the following configuration to your `inventory/host_va
|
||||
matrix_mautrix_SERVICENAME_enabled: true
|
||||
```
|
||||
|
||||
**Note**: for bridging to Meta's Messenger or Instagram, you would need to add `meta` with an underscore symbol (`_`) or hyphen (`-`) based on the context as prefix to each `SERVICENAME`; add `_` to variables (as in `matrix_mautrix_meta_messenger_configuration_extension_yaml` for example) and `-` to paths of the configuration files (as in `roles/custom/matrix-bridge-mautrix-meta-messenger/templates/config.yaml.j2`), respectively. **`matrix_mautrix_facebook_*` and `matrix_mautrix_instagram_*` variables belong to the deprecated components and do not control the new bridge** ([mautrix-meta](https://github.com/mautrix/meta)), which can be [installed using this playbook](configuring-playbook-bridge-mautrix-meta-messenger.md).
|
||||
**Note**: for bridging to Meta's Messenger or Instagram, you would need to add `meta` with an underscore symbol (`_`) or hyphen (`-`) based on the context as prefix to each `SERVICENAME`; add `_` to variables (as in `matrix_mautrix_meta_messenger_configuration_extension_yaml` for example) and `-` to paths of the configuration files (as in `roles/custom/matrix-bridge-mautrix-meta-messenger/templates/config.yaml.j2`), respectively.
|
||||
|
||||
There are some additional things you may wish to configure about the bridge before you continue. Each bridge may have additional requirements besides `_enabled: true`. For example, the mautrix-telegram bridge (our documentation page about it is [here](configuring-playbook-bridge-mautrix-telegram.md)) requires the `matrix_mautrix_telegram_api_id` and `matrix_mautrix_telegram_api_hash` variables to be defined. Refer to each bridge's individual documentation page for details about enabling bridges.
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>
|
||||
|
||||
**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) and [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md) bridges supported by the playbook.
|
||||
**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md) bridge supported by the playbook.
|
||||
- For using as a Bot we recommend the [Appservice Discord](configuring-playbook-bridge-appservice-discord.md), because it supports plumbing.
|
||||
- For personal use with a discord account we recommend the `mautrix-discord` bridge (the one being discussed here), because it is the most fully-featured and stable of the 3 Discord bridges supported by the playbook.
|
||||
|
||||
@@ -26,7 +26,7 @@ See the project's [documentation](https://docs.mau.fi/bridges/go/discord/index.h
|
||||
|
||||
There are 2 ways to login to discord using this bridge, either by [scanning a QR code](#method-1-login-using-qr-code-recommended) using the Discord mobile app **or** by using a [Discord token](#method-2-login-using-discord-token-not-recommended).
|
||||
|
||||
If this is a dealbreaker for you, consider using one of the other Discord bridges supported by the playbook: [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) or [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md). These come with their own complexity and limitations, however, so we recommend that you proceed with this one if possible.
|
||||
If this is a dealbreaker for you, consider using [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md). This comes with its own complexity and limitations, however, so we recommend that you proceed with this one if possible.
|
||||
|
||||
### Enable Appservice Double Puppet or Shared Secret Auth (optional)
|
||||
|
||||
|
||||
@@ -1,100 +1,32 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2019 - 2024 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2019 - 2025 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2019 Eduardo Beltrame
|
||||
SPDX-FileCopyrightText: 2019 Hugues Morisset
|
||||
SPDX-FileCopyrightText: 2020 Tulir Asokan
|
||||
SPDX-FileCopyrightText: 2021 - 2022 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2021 Aaron Raimist
|
||||
SPDX-FileCopyrightText: 2022 Dennis Ciba
|
||||
SPDX-FileCopyrightText: 2022 László Várady
|
||||
SPDX-FileCopyrightText: 2024 Suguru Hirahara
|
||||
SPDX-FileCopyrightText: 2022 Vladimir Panteleev
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up Mautrix Facebook bridging (optional, deprecated)
|
||||
# Setting up Mautrix Facebook bridging (optional, removed)
|
||||
|
||||
<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>
|
||||
🪦 The playbook used to be able to install and configure [mautrix-facebook](https://github.com/mautrix/facebook), but no longer includes this component, as it has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge.
|
||||
|
||||
**Note**: This bridge has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge, which can be [installed using this playbook](configuring-playbook-bridge-mautrix-meta-messenger.md). Consider using that bridge instead of this one.
|
||||
The mautrix-meta bridge can be [installed using this playbook](configuring-playbook-bridge-mautrix-meta-messenger.md).
|
||||
|
||||
The playbook can install and configure [mautrix-facebook](https://github.com/mautrix/facebook) for you.
|
||||
## Uninstalling the bridge manually
|
||||
|
||||
See the project's [documentation](https://github.com/mautrix/facebook/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||
|
||||
## Prerequisite (optional)
|
||||
|
||||
### Enable Shared Secret Auth
|
||||
|
||||
If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook.
|
||||
|
||||
See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting.
|
||||
|
||||
**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_facebook_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the bridge.
|
||||
|
||||
See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
```
|
||||
|
||||
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`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.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bridge, you need to start a chat with `@facebookbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
You then need to send `login YOUR_FACEBOOK_EMAIL_ADDRESS` to the bridge bot to enable bridging for your Facebook Messenger account.
|
||||
|
||||
If you run into trouble, check the [Troubleshooting](#troubleshooting) section below.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-mautrix-facebook`.
|
||||
|
||||
### Increase logging verbosity
|
||||
|
||||
The default logging level for this component is `WARNING`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_facebook_logging_level: DEBUG
|
||||
```
|
||||
|
||||
### Facebook rejecting login attempts and forcing you to change password
|
||||
|
||||
If your Matrix server is in a wildly different location than where you usually use your Facebook account from, the bridge's login attempts may be outright rejected by Facebook. Along with that, Facebook may even force you to change the account's password.
|
||||
|
||||
If you happen to run into this problem while [setting up bridging](#usage), try to first get a successful session up by logging in to Facebook through the Matrix server's IP address.
|
||||
|
||||
The easiest way to do this may be to use [sshuttle](https://sshuttle.readthedocs.io/) to proxy your traffic through the Matrix server.
|
||||
|
||||
Example command for proxying your traffic through the Matrix server:
|
||||
If you still have the bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:
|
||||
|
||||
```sh
|
||||
sshuttle -r root@matrix.example.com:22 0/0
|
||||
systemctl disable --now matrix-mautrix-facebook.service
|
||||
|
||||
rm -rf /matrix/mautrix-facebook
|
||||
|
||||
/matrix/postgres/bin/cli-non-interactive 'DROP DATABASE matrix_mautrix_facebook;'
|
||||
```
|
||||
|
||||
Once connected, you should be able to verify that you're browsing the web through the Matrix server's IP by checking [icanhazip](https://icanhazip.com/).
|
||||
|
||||
Then proceed to log in to [Facebook/Messenger](https://www.facebook.com/).
|
||||
|
||||
Once logged in, proceed to [set up bridging](#usage).
|
||||
|
||||
If that doesn't work, enable 2FA (see: [Facebook help page on enabling 2FA](https://www.facebook.com/help/148233965247823)) and try to login again with a new password, and entering the 2FA code when prompted, it may take more then one try, in between attempts, check facebook.com to see if they are requiring another password change
|
||||
|
||||
@@ -1,63 +1,33 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2019 - 2025 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2019 Eduardo Beltrame
|
||||
SPDX-FileCopyrightText: 2019 Hugues Morisset
|
||||
SPDX-FileCopyrightText: 2020 Tulir Asokan
|
||||
SPDX-FileCopyrightText: 2021 - 2022 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2021 Aaron Raimist
|
||||
SPDX-FileCopyrightText: 2021 Marcus Proest
|
||||
SPDX-FileCopyrightText: 2022 - 2024 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2022 Dennis Ciba
|
||||
SPDX-FileCopyrightText: 2022 László Várady
|
||||
SPDX-FileCopyrightText: 2022 Vladimir Panteleev
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up Mautrix Instagram bridging (optional, deprecated)
|
||||
# Setting up Mautrix Instagram bridging (optional, removed)
|
||||
|
||||
<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>
|
||||
🪦 The playbook used to be able to install and configure [mautrix-instagram](https://github.com/mautrix/instagram), but no longer includes this component, as it has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge.
|
||||
|
||||
**Note**: This bridge has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge, which can be [installed using this playbook](configuring-playbook-bridge-mautrix-meta-instagram.md). Consider using that bridge instead of this one.
|
||||
The mautrix-meta bridge can be [installed using this playbook](configuring-playbook-bridge-mautrix-meta-messenger.md).
|
||||
|
||||
The playbook can install and configure [mautrix-instagram](https://github.com/mautrix/instagram) for you.
|
||||
## Uninstalling the bridge manually
|
||||
|
||||
See the project's [documentation](https://github.com/mautrix/instagram/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||
If you still have the bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_instagram_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the bridge.
|
||||
|
||||
See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
```
|
||||
|
||||
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`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.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bridge, you need to start a chat with `@instagrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
You then need to send `login YOUR_INSTAGRAM_EMAIL_ADDRESS YOUR_INSTAGRAM_PASSWORD` to the bridge bot to enable bridging for your instagram/Messenger account.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-mautrix-instagram`.
|
||||
|
||||
### Increase logging verbosity
|
||||
|
||||
The default logging level for this component is `WARNING`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_instagram_logging_level: DEBUG
|
||||
systemctl disable --now matrix-mautrix-instagram.service
|
||||
|
||||
rm -rf /matrix/mautrix-instagram
|
||||
|
||||
/matrix/postgres/bin/cli-non-interactive 'DROP DATABASE matrix_mautrix_instagram;'
|
||||
```
|
||||
|
||||
@@ -11,7 +11,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>
|
||||
|
||||
**Note**: bridging to [Slack](https://slack.com/) can also happen via the [mx-puppet-slack](configuring-playbook-bridge-mx-puppet-slack.md) and [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) bridges supported by the playbook.
|
||||
**Note**: bridging to [Slack](https://slack.com/) can also happen via the [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) bridge supported by the playbook.
|
||||
- For using as a Bot we recommend the [Appservice Slack](configuring-playbook-bridge-appservice-slack.md), because it supports plumbing. Note that it is not available for new installation unless you have already created a classic Slack application, because the creation of classic Slack applications, which this bridge makes use of, has been discontinued.
|
||||
- For personal use with a slack account we recommend the `mautrix-slack` bridge (the one being discussed here), because it is the most fully-featured and stable of the 3 Slack bridges supported by the playbook.
|
||||
|
||||
@@ -45,8 +45,7 @@ matrix_mautrix_slack_enabled: true
|
||||
|
||||
There are some additional things you may wish to configure about the bridge.
|
||||
|
||||
<!-- NOTE: relay mode is not supported for this bridge -->
|
||||
See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc.
|
||||
See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [relay mode](configuring-playbook-bridge-mautrix-bridges.md#enable-relay-mode-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc.
|
||||
|
||||
## Installing
|
||||
|
||||
|
||||
@@ -11,8 +11,6 @@ SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>
|
||||
|
||||
**Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md) bridge supported by the playbook.
|
||||
|
||||
The playbook can install and configure [mautrix-twitter](https://github.com/mautrix/twitter) for you.
|
||||
|
||||
See the project's [documentation](https://github.com/mautrix/twitter/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||
|
||||
@@ -70,7 +70,7 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju
|
||||
|
||||
## Usage
|
||||
|
||||
Follow the [mautrix-imessage documenation](https://docs.mau.fi/bridges/go/imessage/index.html) for running `android-sms` and/or `matrix-imessage` on your device(s).
|
||||
Follow the [mautrix-imessage documentation](https://docs.mau.fi/bridges/go/imessage/index.html) for running `android-sms` and/or `matrix-imessage` on your device(s).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
||||
@@ -1,51 +1,31 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2020 - 2022 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2019 - 2025 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2019 Eduardo Beltrame
|
||||
SPDX-FileCopyrightText: 2020 Hugues Morisset
|
||||
SPDX-FileCopyrightText: 2020 Tulir Asokan
|
||||
SPDX-FileCopyrightText: 2021 - 2022 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2022 Dennis Ciba
|
||||
SPDX-FileCopyrightText: 2022 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2022 Vladimir Panteleev
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up MX Puppet Discord bridging (optional)
|
||||
# Setting up MX Puppet Discord bridging (optional, removed)
|
||||
|
||||
**Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md)and [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridges supported by the playbook.
|
||||
- For using as a Bot we recommend the [Appservice Discord](configuring-playbook-bridge-appservice-discord.md), because it supports plumbing.
|
||||
- For personal use with a discord account we recommend the [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridge, because it is the most fully-featured and stable of the 3 Discord bridges supported by the playbook.
|
||||
🪦 The playbook used to be able to install and configure [mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord), but no longer includes this component, as it has been unmaintained for a long time.
|
||||
|
||||
The playbook can install and configure [mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord) for you.
|
||||
You may wish to use the [Mautrix Discord bridge](https://github.com/mautrix/discord) instead.
|
||||
|
||||
See the project's [documentation](https://gitlab.com/mx-puppet/discord/mx-puppet-discord/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||
## Uninstalling the bridge manually
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
If you still have the MX Puppet Discord bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:
|
||||
|
||||
To enable the [Discord](https://discordapp.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mx_puppet_discord_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
systemctl disable --now matrix-mx-puppet-discord.service
|
||||
|
||||
rm -rf /matrix/mx-puppet-discord
|
||||
|
||||
/matrix/postgres/bin/cli-non-interactive 'DROP DATABASE matrix_mx_puppet_discord;'
|
||||
```
|
||||
|
||||
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`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.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bridge, you need to start a chat with `Discord Puppet Bridge` with the handle `@_discordpuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-discord [documentation](https://gitlab.com/mx-puppet/discord/mx-puppet-discord) for more information about how to configure the bridge.
|
||||
|
||||
Once logged in, send `list` to the bot user to list the available rooms.
|
||||
|
||||
Clicking rooms in the list will result in you receiving an invitation to the bridged room.
|
||||
|
||||
Send `help` to the bot to see the available commands.
|
||||
|
||||
@@ -1,51 +1,30 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2021 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2019 - 2025 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2019 Eduardo Beltrame
|
||||
SPDX-FileCopyrightText: 2020 Hugues Morisset
|
||||
SPDX-FileCopyrightText: 2020 Tulir Asokan
|
||||
SPDX-FileCopyrightText: 2021 - 2022 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2022 Dennis Ciba
|
||||
SPDX-FileCopyrightText: 2022 Vladimir Panteleev
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up MX Puppet Instagram bridging (optional)
|
||||
# Setting up MX Puppet Instagram bridging (optional, removed)
|
||||
|
||||
The playbook can install and configure [mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram) for you.
|
||||
🪦 The playbook used to be able to install and configure [mx-puppet-instagram](https://gitlab.com/mx-puppet/instagram/mx-puppet-instagram), but no longer includes this component, as it has been unmaintained for a long time.
|
||||
|
||||
This allows you to bridge Instagram DirectMessages into Matrix.
|
||||
You may wish to use the [Mautrix Meta](https://github.com/mautrix/meta) Messenger/Instagram bridge instead.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
## Uninstalling the bridge manually
|
||||
|
||||
To enable the [Instagram](https://www.instagram.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
If you still have the MX Puppet Instagram bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:
|
||||
|
||||
```yaml
|
||||
matrix_mx_puppet_instagram_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
systemctl disable --now matrix-mx-puppet-instagram.service
|
||||
|
||||
rm -rf /matrix/mx-puppet-instagram
|
||||
|
||||
/matrix/postgres/bin/cli-non-interactive 'DROP DATABASE matrix_mx_puppet_instagram;'
|
||||
```
|
||||
|
||||
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`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.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bridge, you need to start a chat with `Instagram Puppet Bridge` with the handle `@_instagrampuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
Send `link <username> <password>` to the bridge bot to link your instagram account.
|
||||
|
||||
The `list` commands shows which accounts are linked and which `puppetId` is associated.
|
||||
|
||||
For double-puppeting, you probably want to issue these commands:
|
||||
|
||||
- `settype $puppetId puppet` to enable puppeting for the link (instead of relaying)
|
||||
- `setautoinvite $puppetId 1` to automatically invite you to chats
|
||||
- `setmatrixtoken $accessToken` to set the access token to enable puppeting from the other side (the "double" in double puppeting)
|
||||
|
||||
If you are linking only one Instagram account, your `$puppetId` is probably 1, but use the `list` command find out.
|
||||
|
||||
Send `help` to the bot to see the available commands. At the time of writing, not every command is fully implemented.
|
||||
|
||||
@@ -10,4 +10,4 @@ SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
🪦 The playbook used to be able to install and configure [mx-puppet-skype](https://github.com/Sorunome/mx-puppet-skype), but no longer includes this component, because it has been broken and unmaintained for a long time.
|
||||
|
||||
Bridging to [Skype](https://www.skype.com/) can also happen via the [go-skype-bridge](configuring-playbook-bridge-go-skype-bridge.md) bridge supported by the playbook.
|
||||
The playbook used to be able to install and configure [go-skype-bridge](configuring-playbook-bridge-go-skype-bridge.md) as alternative to this bridge, but no longer includes this component, because Skype has been discontinued since May 2025.
|
||||
|
||||
@@ -1,58 +1,33 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2020 - 2023 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2019 - 2025 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2019 Eduardo Beltrame
|
||||
SPDX-FileCopyrightText: 2020 Rodrigo Belem
|
||||
SPDX-FileCopyrightText: 2020 Tulir Asokan
|
||||
SPDX-FileCopyrightText: 2021 Marcel Ackermann
|
||||
SPDX-FileCopyrightText: 2021 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2022 Dennis Ciba
|
||||
SPDX-FileCopyrightText: 2022 Jim Myhrberg
|
||||
SPDX-FileCopyrightText: 2022 Nikita Chernyi
|
||||
SPDX-FileCopyrightText: 2022 Vladimir Panteleev
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up MX Puppet Slack bridging (optional)
|
||||
# Setting up MX Puppet Slack bridging (optional, removed)
|
||||
|
||||
**Note**: bridging to [Slack](https://slack.com) can also happen via the [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) and [mautrix-slack](configuring-playbook-bridge-mautrix-slack.md) bridges supported by the playbook. Note that `matrix-appservice-slack` is not available for new installation unless you have already created a classic Slack application, because the creation of classic Slack applications, which this bridge makes use of, has been discontinued.
|
||||
🪦 The playbook used to be able to install and configure [mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack), but no longer includes this component, as it has been unmaintained for a long time.
|
||||
|
||||
The playbook can install and configure [mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack) for you.
|
||||
You may wish to use the [Mautrix Slack bridge](https://github.com/mautrix/slack) instead.
|
||||
|
||||
See the project's [documentation](https://gitlab.com/mx-puppet/slack/mx-puppet-slack/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||
## Uninstalling the bridge manually
|
||||
|
||||
## Prerequisite
|
||||
If you still have the MX Puppet Slack bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:
|
||||
|
||||
Follow the [OAuth credentials](https://gitlab.com/mx-puppet/slack/mx-puppet-slack#option-2-oauth) instructions to create a new Slack app, setting the redirect URL to `https://matrix.example.com/slack/oauth`.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable the [Slack](https://slack.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mx_puppet_slack_enabled: true
|
||||
# Client ID must be quoted so YAML does not parse it as a float.
|
||||
matrix_mx_puppet_slack_oauth_client_id: "<SLACK_APP_CLIENT_ID>"
|
||||
matrix_mx_puppet_slack_oauth_client_secret: "<SLACK_APP_CLIENT_SECRET>"
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
systemctl disable --now matrix-mx-puppet-slack.service
|
||||
|
||||
rm -rf /matrix/mx-puppet-slack
|
||||
|
||||
/matrix/postgres/bin/cli-non-interactive 'DROP DATABASE matrix_mx_puppet_slack;'
|
||||
```
|
||||
|
||||
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`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.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bridge, you need to start a chat with `Slack Puppet Bridge` with the handle `@_slackpuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-slack [documentation](https://gitlab.com/mx-puppet/slack/mx-puppet-slack) for more information about how to configure the bridge.
|
||||
|
||||
Once logged in, send `list` to the bot user to list the available rooms.
|
||||
|
||||
Clicking rooms in the list will result in you receiving an invitation to the bridged room.
|
||||
|
||||
Send `help` to the bot to see the available commands.
|
||||
|
||||
@@ -7,11 +7,13 @@ SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up MX Puppet Steam bridging (optional)
|
||||
# Setting up MX Puppet Steam bridging (optional, deprecated)
|
||||
|
||||
The playbook can install and configure [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) for you.
|
||||
**Note**: This bridge has been deprecated in favor of the [matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge) bridge for Steam, which can be [installed using this playbook](configuring-playbook-bridge-steam.md). Consider using that bridge instead of this one.
|
||||
|
||||
See the project's [documentation](https://github.com/icewind1991/mx-puppet-steam/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||
The playbook can install and configure [mx-puppet-steam](https://codeberg.org/icewind/mx-puppet-steam) for you.
|
||||
|
||||
See the project's [documentation](https://codeberg.org/icewind/mx-puppet-steam/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
@@ -38,7 +40,7 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju
|
||||
|
||||
To use the bridge, you need to start a chat with `Steam Puppet Bridge` with the handle `@_steampuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-steam [documentation](https://github.com/icewind1991/mx-puppet-steam) for more information about how to configure the bridge.
|
||||
Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-steam [documentation](https://codeberg.org/icewind/mx-puppet-steam) for more information about how to configure the bridge.
|
||||
|
||||
Once logged in, send `list` to the bot user to list the available rooms.
|
||||
|
||||
|
||||
@@ -1,57 +1,29 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2019 - 2025 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2019 Eduardo Beltrame
|
||||
SPDX-FileCopyrightText: 2020 Tulir Asokan
|
||||
SPDX-FileCopyrightText: 2021 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2021 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2022 Dennis Ciba
|
||||
SPDX-FileCopyrightText: 2022 Vladimir Panteleev
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up MX Puppet Twitter bridging (optional)
|
||||
# Setting up MX Puppet Twitter bridging (optional, removed)
|
||||
|
||||
**Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mautrix-twitter](configuring-playbook-bridge-mautrix-twitter.md) bridge supported by the playbook.
|
||||
🪦 The playbook used to be able to install and configure [mx-puppet-twitter](https://github.com/Sorunome/mx-puppet-twitter), but no longer includes this component, as it has been unmaintained for a long time.
|
||||
|
||||
The playbook can install and configure [mx-puppet-twitter](https://github.com/Sorunome/mx-puppet-twitter) for you.
|
||||
You may wish to use the [Mautrix Twitter bridge](https://github.com/mautrix/twitter) instead.
|
||||
|
||||
See the project's [documentation](https://github.com/Sorunome/mx-puppet-twitter/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||
## Uninstalling the bridge manually
|
||||
|
||||
## Prerequisite
|
||||
If you still have the MX Puppet Twitter bridge installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:
|
||||
|
||||
Make an app on [developer.twitter.com](https://developer.twitter.com/en/apps).
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable the [Twitter](https://twitter.com) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mx_puppet_twitter_enabled: true
|
||||
matrix_mx_puppet_twitter_consumer_key: ''
|
||||
matrix_mx_puppet_twitter_consumer_secret: ''
|
||||
matrix_mx_puppet_twitter_access_token: ''
|
||||
matrix_mx_puppet_twitter_access_token_secret: ''
|
||||
matrix_mx_puppet_twitter_environment: ''
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
systemctl disable --now matrix-mx-puppet-twitter.service
|
||||
|
||||
rm -rf /matrix/mx-puppet-twitter
|
||||
|
||||
/matrix/postgres/bin/cli-non-interactive 'DROP DATABASE matrix_mx_puppet_twitter;'
|
||||
```
|
||||
|
||||
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`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.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bridge, you need to start a chat with `Twitter Puppet Bridge` with the handle `@_twitterpuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
To log in, use `link` and click the link.
|
||||
|
||||
Once logged in, send `list` to the bot user to list the available rooms.
|
||||
|
||||
Clicking rooms in the list will result in you receiving an invitation to the bridged room.
|
||||
|
||||
Send `help` to the bot to see the available commands.
|
||||
|
||||
48
docs/configuring-playbook-bridge-steam.md
Normal file
48
docs/configuring-playbook-bridge-steam.md
Normal file
@@ -0,0 +1,48 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2025 Jason LaGuidice
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up Steam bridging (optional)
|
||||
|
||||
The playbook can install and configure [matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge) for you.
|
||||
|
||||
See the project's [documentation](https://github.com/jasonlaguidice/matrix-steam-bridge/blob/main/README.md) to learn what it does and why it might be useful to you.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable the [Steam](https://steampowered.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_steam_bridge_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
```
|
||||
|
||||
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` and `just setup-all`
|
||||
|
||||
`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.
|
||||
|
||||
The tag for `just` commands for this bridge is `matrix-steam-bridge` - for example: `just install-service matrix-steam-bridge`
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bridge, you need to start a chat with `Steam bridge bot` with the handle `@steambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
The bridge supports QR code and password-based login as well as SteamGuard codes via app, SMS, or e-mail. See matrix-steam-bridge [documentation](https://github.com/jasonlaguidice/matrix-steam-bridge) for more information about how to configure the bridge.
|
||||
|
||||
To login, send `login [flow ID]` where possible flow IDs are `password` or `qr`
|
||||
|
||||
Once logged in, send `search [name]` to search through recognized Steam friends. You can send a user name, display name, or all forms of Steam ID. Send `start-chat [identifier]` to request the bridge bot to open a chat room with a user.
|
||||
|
||||
Chat rooms will automatically be opened as new messages are received.
|
||||
|
||||
Send `help` to the bot to see the available commands.
|
||||
83
docs/configuring-playbook-bridge-zulip.md
Normal file
83
docs/configuring-playbook-bridge-zulip.md
Normal file
@@ -0,0 +1,83 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2021 - 2024 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2021 Toni Spets
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up a Zulip bridge (optional)
|
||||
|
||||
The playbook can install and configure [MatrixZulipBridge](https://github.com/GearKite/MatrixZulipBridge) for you.
|
||||
|
||||
See the project's [documentation](https://github.com/GearKite/MatrixZulipBridge/blob/main/README.md) to learn what it does and why it might be useful to you.
|
||||
|
||||
## Adjusting DNS records (optional)
|
||||
|
||||
By default, this playbook installs the Zulip bridge on the `matrix.` subdomain, at the `/zulip` path (https://matrix.example.com/zulip). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section.
|
||||
|
||||
If you wish to adjust it, see the section [below](#adjusting-the-zulip-bridge-url-optional) for details about DNS configuration.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable the Zulip bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_zulip_bridge_enabled: true
|
||||
|
||||
# Uncomment to add one or more admins to this bridge:
|
||||
#
|
||||
# matrix_zulip_bridge_owner:
|
||||
# - '@yourAdminAccount:{{ matrix_domain }}'
|
||||
#
|
||||
# … unless you've made yourself an admin of all bots/bridges like this:
|
||||
#
|
||||
# matrix_admin: '@yourAdminAccount:{{ matrix_domain }}'
|
||||
```
|
||||
|
||||
### Adjusting the Zulip bridge URL (optional)
|
||||
|
||||
By tweaking the `matrix_zulip_bridge_hostname` and `matrix_zulip_bridge_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one.
|
||||
|
||||
Example additional configuration for your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
# Change the default hostname and path prefix
|
||||
matrix_zulip_bridge_hostname: zulip.example.com
|
||||
matrix_zulip_bridge_path_prefix: /
|
||||
```
|
||||
|
||||
If you've changed the default hostname, you may need to create a CNAME record for the Zulip bridge domain (`zulip.example.com`), which targets `matrix.example.com`.
|
||||
|
||||
When setting, replace `example.com` with your own.
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the bridge.
|
||||
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-bridge-zulip/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
```
|
||||
|
||||
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`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.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bridge, you need to start a chat with `@zulipbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). If the bridge ignores you and a DM is not accepted then the owner setting may be wrong.
|
||||
|
||||
If you encounter issues or feel lost you can join the project room at [#matrixzulipbridge:shema.lv](https://matrix.to/#/#matrixzulipbridge:shema.lv) for help.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bridge-zulip`.
|
||||
@@ -13,7 +13,7 @@ FluffyChat Web is a cute cross-platform (web, iOS, Android) messenger for Matrix
|
||||
|
||||
💡 **Note**: the latest version of FluffyChat Web is also available on the web, hosted by 3rd parties. If you trust giving your credentials to the following 3rd party Single Page Application, you can consider using it from there:
|
||||
|
||||
- [fluffychat.im](https://fluffychat.im/web), hosted by the [FluffyChat](https://fluffychat.im/) developers
|
||||
- [fluffychat.im](https://fluffychat.im/web), hosted by the [FluffyChat](https://fluffy.chat/) developers
|
||||
|
||||
## Adjusting DNS records
|
||||
|
||||
|
||||
@@ -65,6 +65,7 @@ Find the `registration.yaml` in the `/matrix` directory, for example `/matrix/ma
|
||||
```
|
||||
as_token: <token>
|
||||
de.sorunome.msc2409.push_ephemeral: true
|
||||
receive_ephemeral: true
|
||||
hs_token: <token>
|
||||
id: signal
|
||||
namespaces:
|
||||
|
||||
@@ -18,6 +18,7 @@ By default, the playbook installs [Synapse](https://github.com/element-hq/synaps
|
||||
> [!WARNING]
|
||||
> - **You can't switch an existing Matrix server's implementation** (e.g. Synapse -> conduwuit). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet.
|
||||
> - **Homeserver implementations other than Synapse may not be fully functional**. The playbook may also not assist you in an optimal way (like it does with Synapse). Make yourself familiar with the downsides before proceeding
|
||||
> - **the Conduwuit project appears to have been abandoned**. You may wish to install [Conduit](./configuring-playbook-conduit.md), or one of the Conduwuit successors (like [Continuwuity](configuring-playbook-continuwuity.md))
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
@@ -83,6 +84,7 @@ Then, send its content to the existing admin room:
|
||||
```
|
||||
as_token: <token>
|
||||
de.sorunome.msc2409.push_ephemeral: true
|
||||
receive_ephemeral: true
|
||||
hs_token: <token>
|
||||
id: signal
|
||||
namespaces:
|
||||
|
||||
117
docs/configuring-playbook-continuwuity.md
Normal file
117
docs/configuring-playbook-continuwuity.md
Normal file
@@ -0,0 +1,117 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2025 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2025 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Configuring Continuwuity (optional)
|
||||
|
||||
The playbook can install and configure the [Continuwuity](https://continuwuity.org) Matrix server for you.
|
||||
|
||||
See the project's [documentation](https://continuwuity.org) to learn what it does and why it might be useful to you.
|
||||
|
||||
By default, the playbook installs [Synapse](https://github.com/element-hq/synapse) as it's the only full-featured Matrix server at the moment. If that's okay, you can skip this document.
|
||||
|
||||
💡 **Note**: continuwuity is a fork of [conduwuit](./configuring-playbook-conduwuit.md), which the playbook also supports.
|
||||
|
||||
> [!WARNING]
|
||||
> - **You can't switch an existing Matrix server's implementation** (e.g. Synapse -> Continuwuity). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet.
|
||||
> - **Homeserver implementations other than Synapse may not be fully functional**. The playbook may also not assist you in an optimal way (like it does with Synapse). Make yourself familiar with the downsides before proceeding
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To use Continuwuity, you **generally** need to adjust the `matrix_homeserver_implementation: synapse` configuration on your `inventory/host_vars/matrix.example.com/vars.yml` file as below:
|
||||
|
||||
```yaml
|
||||
matrix_homeserver_implementation: continuwuity
|
||||
|
||||
# Registering users can only happen via the API,
|
||||
# so it makes sense to enable it, at least initially.
|
||||
matrix_continuwuity_config_allow_registration: true
|
||||
|
||||
# Generate a strong registration token to protect the registration endpoint from abuse.
|
||||
# You can create one with a command like `pwgen -s 64 1`.
|
||||
matrix_continuwuity_config_registration_token: ''
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the server.
|
||||
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-continuwuity/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
- `roles/custom/matrix-continuwuity/templates/continuwuity.toml.j2` for the server's default configuration
|
||||
|
||||
There are various Ansible variables that control settings in the `continuwuity.toml` file.
|
||||
|
||||
If a specific setting you'd like to change does not have a dedicated Ansible variable, you can either submit a PR to us to add it, or you can [override the setting using an environment variable](https://continuwuity.org/configuration#environment-variables) using `matrix_continuwuity_environment_variables_extension`. For example:
|
||||
|
||||
```yaml
|
||||
matrix_continuwuity_environment_variables_extension: |
|
||||
CONTINUWUITY_MAX_REQUEST_SIZE=50000000
|
||||
CONTINUWUITY_REQUEST_TIMEOUT=60
|
||||
```
|
||||
|
||||
## Creating the first user account
|
||||
|
||||
Unlike other homeserver implementations (like Synapse and Dendrite), continuwuity does not support creating users via the command line or via the playbook.
|
||||
|
||||
If you followed the instructions above (see [Adjusting the playbook configuration](#adjusting-the-playbook-configuration)), you should have registration enabled and protected by a registration token.
|
||||
|
||||
This should allow you to create the first user account via any client (like [Element Web](./configuring-playbook-client-element-web.md)) which supports creating users.
|
||||
|
||||
The **first user account that you create will be marked as an admin** and **will be automatically invited to an admin room**.
|
||||
|
||||
|
||||
## Configuring bridges / appservices
|
||||
|
||||
For other homeserver implementations (like Synapse and Dendrite), the playbook automatically registers appservices (for bridges, bots, etc.) with the homeserver.
|
||||
|
||||
For continuwuity, you will have to manually register appservices using the [`!admin appservices register` command](https://continuwuity.org/appservices.html#set-up-the-appservice---general-instructions) sent to the server bot account.
|
||||
|
||||
The server's bot account has a Matrix ID of `@conduit:example.com` (not `@continuwuity:example.com`!) due to continuwuity's historical legacy.
|
||||
Your first user account would already have been invited to an admin room with this bot.
|
||||
|
||||
Find the appservice file you'd like to register. This can be any `registration.yaml` file found in the `/matrix` directory, for example `/matrix/mautrix-signal/bridge/registration.yaml`.
|
||||
|
||||
Then, send its content to the existing admin room:
|
||||
|
||||
!admin appservices register
|
||||
|
||||
```
|
||||
as_token: <token>
|
||||
de.sorunome.msc2409.push_ephemeral: true
|
||||
receive_ephemeral: true
|
||||
hs_token: <token>
|
||||
id: signal
|
||||
namespaces:
|
||||
aliases:
|
||||
- exclusive: true
|
||||
regex: ^#signal_.+:example\.org$
|
||||
users:
|
||||
- exclusive: true
|
||||
regex: ^@signal_.+:example\.org$
|
||||
- exclusive: true
|
||||
regex: ^@signalbot:example\.org$
|
||||
rate_limited: false
|
||||
sender_localpart: _bot_signalbot
|
||||
url: http://matrix-mautrix-signal:29328
|
||||
```
|
||||
|
||||
## Migrating from conduwuit
|
||||
|
||||
Since Continuwuity is a drop-in replacement for [conduwuit](configuring-playbook-conduwuit.md), migration is possible.
|
||||
|
||||
1. Make sure that Continuwuity is properly set up on your `vars.yml` as described above
|
||||
|
||||
2. Make sure that Conduwuit references are removed from your `vars.yml` file
|
||||
|
||||
3. Run the installation in a way that installs new services and uninstalls old ones (e.g. `just setup-all`)
|
||||
|
||||
4. Run the playbook with the `continuwuity-migrate-from-conduwuit` tag (e.g. `just run-tags continuwuity-migrate-from-conduwuit`). This migrates data from `/matrix/conduwuit` to `/matrix/continuwuity`
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-continuwuity`.
|
||||
67
docs/configuring-playbook-element-admin.md
Normal file
67
docs/configuring-playbook-element-admin.md
Normal file
@@ -0,0 +1,67 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2024 wjbeckett
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Slavi Pantaleev
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up Element Admin (optional)
|
||||
|
||||
The playbook can install and configure [Element Admin](https://github.com/element-hq/element-admin) for you.
|
||||
|
||||
Element Admin is a web-based administration panel for Synapse and [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md).
|
||||
|
||||
See the project's [documentation](https://github.com/element-hq/element-admin) to learn more.
|
||||
|
||||
💡 **Note**: This project is still very young and doesn't have many features. For now, it's recommended to use [Synapse Admin](./configuring-playbook-synapse-admin.md) instead. Deployments that use [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md) can use Element Admin for user-management (something that Synapse Admin can't do), while continuing to use Synapse Admin for all other purposes.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A [Synapse](configuring-playbook-synapse.md) homeserver with its Admin API enabled (the playbook automatically enables it for you when you enable Element Admin)
|
||||
- [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md) with its Admin API enabled (the playbook automatically enables it for you when you enable Element Admin)
|
||||
|
||||
## Decide on a domain and path
|
||||
|
||||
By default, the Element Admin is configured to be served on the `admin.element.example.com` domain.
|
||||
|
||||
If you'd like to run Element Admin on another hostname, see the [Adjusting the Element Admin URL](#adjusting-the-element-admin-url-optional) section below.
|
||||
|
||||
## Adjusting DNS records (optional)
|
||||
|
||||
By default, this playbook installs Element Admin on the `admin.element.` subdomain (`admin.element.example.com`) and requires you to create a `CNAME` record for `admin.element`, which targets `matrix.example.com`.
|
||||
|
||||
When setting these values, replace `example.com` with your own.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_element_admin_enabled: true
|
||||
```
|
||||
|
||||
### Adjusting the Element Admin URL (optional)
|
||||
|
||||
By tweaking the `matrix_element_admin_hostname` variable, you can easily make the service available at a **different hostname** than the default one.
|
||||
|
||||
Example additional configuration for your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_element_admin_hostname: element-admin.example.com
|
||||
```
|
||||
|
||||
> [!WARNING]
|
||||
> A `matrix_element_admin_path_prefix` variable is also available and mean to let you configure a path prefix for the Element Admin service, but **Element Admin does not support running under a sub-path yet**.
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
```
|
||||
|
||||
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`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.
|
||||
@@ -16,8 +16,9 @@ See the project's [documentation](https://github.com/element-hq/element-call) to
|
||||
## Prerequisites
|
||||
|
||||
- A [Synapse](configuring-playbook-synapse.md) homeserver (see the warning below)
|
||||
- The [Matrix RTC (Real-Time Communication) stack](configuring-playbook-matrix-rtc.md)
|
||||
- The [Matrix RTC (Real-Time Communication) stack](configuring-playbook-matrix-rtc.md) (automatically done when Element Call is enabled)
|
||||
- A client compatible with Element Call. As of 2025-03-15, that's just [Element Web](configuring-playbook-client-element-web.md) and the Element X mobile clients (iOS and Android).
|
||||
- (Optional) Guest accounts being enabled for your Matrix server, if you'd like guests to be able to use Element Call. See [Allowing guests to use Element Call](#allowing-guests-to-use-element-call-optional)
|
||||
|
||||
> [!WARNING]
|
||||
> Because Element Call [requires](https://github.com/element-hq/element-call/blob/93ae2aed9841e0b066d515c56bd4c122d2b591b2/docs/self-hosting.md#a-matrix-homeserver) a few experimental features in the Matrix protocol, it's **very likely that it only works with the Synapse homeserver**.
|
||||
@@ -27,9 +28,9 @@ See the project's [documentation](https://github.com/element-hq/element-call) to
|
||||
All clients that can currently use Element Call (Element Web and Element X on mobile) already embed the Element Call frontend within them.
|
||||
These **clients will use their own embedded Element Call frontend**, so **self-hosting the Element Call frontend by the playbook is largely unnecessary**.
|
||||
|
||||
💡 A reason you may wish to continue installing the Element Call frontend (despite Matrix clients not making use of it), is if you need to use it standalone - directly via a browser (without a Matrix client).
|
||||
💡 A reason you may wish to continue installing the Element Call frontend (despite Matrix clients not making use of it), is if you need to use it standalone - directly via a browser (without a Matrix client). Note that unless you [allow guest accounts to use Element Call](#allowing-guests-to-use-element-call-optional), you will still need a Matrix user account **on the same homeserver** to be able to use Element Call.
|
||||
|
||||
The playbook makes a distiction between enabling Element Call (`matrix_element_call_enabled`) and enabling the Matrix RTC Stack (`matrix_rtc_enabled`). Enabling Element Call automatically enables the Matrix RTC stack. Because installing the Element Call frontend is now unnecessary, **we recommend only installing the Matrix RTC stack, without the Element Call frontend**.
|
||||
The playbook makes a distinction between enabling Element Call (`matrix_element_call_enabled`) and enabling the Matrix RTC Stack (`matrix_rtc_enabled`). Enabling Element Call automatically enables the Matrix RTC stack. Because installing the Element Call frontend is now unnecessary, **we recommend only installing the Matrix RTC stack, without the Element Call frontend**.
|
||||
|
||||
| Description / Variable | Element Call frontend | [LiveKit Server](configuring-playbook-livekit-server.md) | [LiveKit JWT Service](configuring-playbook-livekit-jwt-service.md) |
|
||||
|------------------------|-----------------------|----------------|---------------------|
|
||||
@@ -81,6 +82,28 @@ matrix_element_call_hostname: element-call.example.com
|
||||
> [!WARNING]
|
||||
> A `matrix_element_call_path_prefix` variable is also available and mean to let you configure a path prefix for the Element Call service, but [Element Call does not support running under a sub-path yet](https://github.com/element-hq/element-call/issues/3084).
|
||||
|
||||
### Allowing guests to use Element Call (optional)
|
||||
|
||||
By default, Element Call can only be used by people having accounts on your Matrix server.
|
||||
|
||||
If you'd like guests to be able to use Element Call as well, you need to enable guest accounts support for your homeserver.
|
||||
|
||||
> [!WARNING]
|
||||
> Enabling guest accounts means that your homeserver's user database may get polluted with guest account signups (potentially made by bots).
|
||||
> Guest accounts should be limited in what (damage) they can do to your server and the rest of the Matrix ecosystem, but it's better to not enable them unless necessary.
|
||||
|
||||
For [Synapse](configuring-playbook-synapse.md) (the default homeserver implementation), the configuration is like this:
|
||||
|
||||
```yml
|
||||
matrix_synapse_allow_guest_access: true
|
||||
```
|
||||
|
||||
For [Dendrite](configuring-playbook-dendrite.md), the configuration is like this:
|
||||
|
||||
```yml
|
||||
matrix_dendrite_guests_disabled: false
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records) and [adjusting firewall rules](#adjusting-firewall-rules), run the playbook with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
@@ -70,7 +70,7 @@ By default the Jitsi Meet instance **does not require for anyone to log in, and
|
||||
|
||||
If you would like to control who is allowed to start meetings on your instance, you'd need to enable Jitsi's authentication and optionally guests mode.
|
||||
|
||||
See [this section](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#configure-jitsi-authentication-and-guests-mode-optional) on the role's documentation for details about how to configure the authentication and guests mode. The recommended authentication method is `internal` as it also works in federated rooms. If you want to enable authentication with Matrix OpenID making use of [Matrix User Verification Service (UVS)](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/configuring-playbook-user-verification-service.md), see [here](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#authenticate-using-matrix-openid-auth-type-matrix) for details about how to set it up.
|
||||
See [this section](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#configure-jitsi-authentication-and-guests-mode-optional) on the role's documentation for details about how to configure the authentication and guests mode. The recommended authentication method is `internal` as it also works in federated rooms. If you want to enable authentication with Matrix OpenID making use of [Matrix User Verification Service (UVS)](configuring-playbook-user-verification-service.md), see [here](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#authenticate-using-matrix-openid-auth-type-matrix) for details about how to set it up.
|
||||
|
||||
### Enable Gravatar (optional)
|
||||
|
||||
|
||||
@@ -15,4 +15,4 @@ This is a helper component which is part of the [Matrix RTC stack](configuring-p
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-livekit-jwt-service/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
- `roles/custom/matrix-livekit-jwt-service/templates/env.j2` for the component's default configuration.
|
||||
- `roles/custom/matrix-livekit-jwt-service/templates/env.j2` for the component's default configuration.
|
||||
|
||||
@@ -35,4 +35,4 @@ To ensure LiveKit Server functions correctly, the following firewall rules and p
|
||||
|
||||
For some reason, LiveKit Server's TURN ports (`3479/udp` and `5350/tcp`) are not reachable over IPv6 regardless of whether you've [enabled IPv6](./configuring-ipv6.md) for your server.
|
||||
|
||||
It seems like LiveKit Server intentionally only listens on `udp4` and `tcp4` as seen [here](https://github.com/livekit/livekit/blob/154b4d26b769c68a03c096124094b97bf61a996f/pkg/service/turn.go#L128) and [here](https://github.com/livekit/livekit/blob/154b4d26b769c68a03c096124094b97bf61a996f/pkg/service/turn.go#L92).
|
||||
It seems like LiveKit Server intentionally only listens on `udp4` and `tcp4` as seen [here](https://github.com/livekit/livekit/blob/154b4d26b769c68a03c096124094b97bf61a996f/pkg/service/turn.go#L128) and [here](https://github.com/livekit/livekit/blob/154b4d26b769c68a03c096124094b97bf61a996f/pkg/service/turn.go#L92).
|
||||
|
||||
@@ -41,7 +41,7 @@ Below, we'll try to **highlight some potential reasons for switching** to Matrix
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- ⚠️ the [Synapse](configuring-playbook-synapse.md) homeserver implementation (which is the default for this playbook). Other homeserver implementations ([Dendrite](./configuring-playbook-dendrite.md), [Conduit](./configuring-playbook-conduit.md), etc.) do not support integrating wtih Matrix Authentication Service yet.
|
||||
- ⚠️ the [Synapse](configuring-playbook-synapse.md) homeserver implementation (which is the default for this playbook). Other homeserver implementations ([Dendrite](./configuring-playbook-dendrite.md), [Conduit](./configuring-playbook-conduit.md), etc.) do not support integrating with Matrix Authentication Service yet.
|
||||
|
||||
- ❌ **disabling all password providers** for Synapse (things like [shared-secret-auth](./configuring-playbook-shared-secret-auth.md), [rest-auth](./configuring-playbook-rest-auth.md), [LDAP auth](./configuring-playbook-ldap-auth.md), etc.) More details about this are available in the [Expectations](#expectations) section below.
|
||||
|
||||
@@ -51,19 +51,17 @@ This section details what you can expect when switching to the Matrix Authentica
|
||||
|
||||
- ❌ **Synapse password providers will need to be disabled**. You can no longer use [shared-secret-auth](./configuring-playbook-shared-secret-auth.md), [rest-auth](./configuring-playbook-rest-auth.md), [LDAP auth](./configuring-playbook-ldap-auth.md), etc. When the authentication flow is handled by MAS (not by Synapse anymore), it doesn't make sense to extend the Synapse authentication flow with additional modules. Many bridges used to rely on shared-secret-auth for doing double-puppeting (impersonating other users), but most (at least the mautrix bridges) nowadays use [Appservice Double Puppet](./configuring-playbook-appservice-double-puppet.md) as a better alternative. Older/maintained bridges may still rely on shared-secret-auth, as do other services like [matrix-corporal](./configuring-playbook-matrix-corporal.md).
|
||||
|
||||
- ❌ Certain **tools like [synapse-admin](./configuring-playbook-synapse-admin.md) do not have full compatibility with MAS yet**. synapse-admin already supports [login with access token](https://github.com/etkecc/synapse-admin/pull/58), browsing users (which Synapse will internally fetch from MAS) and updating user avatars. However, editing users (passwords, etc.) now needs to happen directly against MAS using the [MAS Admin API](https://element-hq.github.io/matrix-authentication-service/api/index.html), which synapse-admin cannot interact with yet.
|
||||
- ❌ Certain **tools like [Synapse Admin](./configuring-playbook-synapse-admin.md) do not have full compatibility with MAS yet**. Synapse Admin already supports OIDC auth, browsing users (which Synapse will internally fetch from MAS) and updating user avatars. However, editing users (passwords, etc.) now needs to happen directly against MAS using the [MAS Admin API](https://element-hq.github.io/matrix-authentication-service/api/index.html), which Synapse Admin cannot interact with yet. You may be interested in using [Element Admin](./configuring-playbook-element-admin.md) for these purposes.
|
||||
|
||||
- ❌ **Some services experience issues when authenticating via MAS**:
|
||||
|
||||
- [Postmoogle](./configuring-playbook-bridge-postmoogle.md) works the first time around, but it consistently fails after restarting:
|
||||
|
||||
> cannot initialize matrix bot error="olm account is marked as shared, keys seem to have disappeared from the server"
|
||||
- [Reminder bot](configuring-playbook-bot-matrix-reminder-bot.md) seems to be losing some of its state on each restart and may reschedule old reminders once again
|
||||
|
||||
- ❌ **Encrypted appservices** do not work yet (related to [MSC4190](https://github.com/matrix-org/matrix-spec-proposals/pull/4190) and [PR 17705 for Synapse](https://github.com/element-hq/synapse/pull/17705)), so all bridges/bots that rely on encryption will fail to start (see [this issue](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3658) for Hookshot). You can use these bridges/bots only if you **keep end-to-bridge encryption disabled** (which is the default setting).
|
||||
|
||||
- ⚠️ [Migrating an existing Synapse homeserver to Matrix Authentication Service](#migrating-an-existing-synapse-homeserver-to-matrix-authentication-service) is **possible**, but requires **some playbook-assisted manual work**. Migration is **reversible with no or minor issues if done quickly enough**, but as users start logging in (creating new login sessions) via the new MAS setup, disabling MAS and reverting back to the Synapse user database will cause these new sessions to break.
|
||||
|
||||
- ⚠️ Delegating user authentication to MAS causes **your Synapse server to be completely dependant on one more service** for its operations. MAS is quick & lightweight and should be stable enough already, but this is something to keep in mind when making the switch.
|
||||
- ⚠️ Delegating user authentication to MAS causes **your Synapse server to be completely dependent on one more service** for its operations. MAS is quick & lightweight and should be stable enough already, but this is something to keep in mind when making the switch.
|
||||
|
||||
- ⚠️ If you've got [OIDC configured in Synapse](./configuring-playbook-synapse.md#synapse--openid-connect-for-single-sign-on), you will need to migrate your OIDC configuration to MAS by adding an [Upstream OAuth2 configuration](#upstream-oauth2-configuration).
|
||||
|
||||
@@ -87,7 +85,7 @@ For new homeservers (which don't have any users in their Synapse database yet),
|
||||
|
||||
### Existing homeserver
|
||||
|
||||
Other homeserver implementations ([Dendrite](./configuring-playbook-dendrite.md), [Conduit](./configuring-playbook-conduit.md), etc.) do not support integrating wtih Matrix Authentication Service yet.
|
||||
Other homeserver implementations ([Dendrite](./configuring-playbook-dendrite.md), [Conduit](./configuring-playbook-conduit.md), etc.) do not support integrating with Matrix Authentication Service yet.
|
||||
|
||||
For existing Synapse homeservers:
|
||||
|
||||
@@ -159,6 +157,10 @@ matrix_authentication_service_config_upstream_oauth2_providers:
|
||||
- # A unique identifier for the provider
|
||||
# Must be a valid ULID
|
||||
id: 01HFVBY12TMNTYTBV8W921M5FA
|
||||
# This can be set if you're migrating an existing (legacy) Synapse OIDC configuration.
|
||||
# The value used here would most likely be "oidc" or "oidc-provider".
|
||||
# See: https://element-hq.github.io/matrix-authentication-service/setup/migration.html#map-any-upstream-sso-providers
|
||||
synapse_idp_id: null
|
||||
# The issuer URL, which will be used to discover the provider's configuration.
|
||||
# If discovery is enabled, this *must* exactly match the `issuer` field
|
||||
# advertised in `<issuer>/.well-known/openid-configuration`.
|
||||
@@ -306,7 +308,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
|
||||
Our migration guide is loosely based on the upstream [Migrating an existing homeserver](https://element-hq.github.io/matrix-authentication-service/setup/migration.html) guide.
|
||||
|
||||
Migration is done via a tool called `syn2mas`, which the playbook could run for you (in a container).
|
||||
Migration is done via a sub-command called `syn2mas`, which the playbook could run for you (in a container).
|
||||
|
||||
The installation + migration steps are like this:
|
||||
|
||||
@@ -322,7 +324,7 @@ The installation + migration steps are like this:
|
||||
|
||||
- The `matrix-user-creator` role would be suppressed, so that it doesn't automatically attempt to create users (for bots, etc.) in the MAS database. These user accounts likely already exist in Synapse's user database and could be migrated over (via syn2mas, as per the steps below), so creating them in the MAS database would have been unnecessary and potentially problematic (conflicts during the syn2mas migration).
|
||||
|
||||
3. Consider taking a full [backup of your Postgres database](./maintenance-postgres.md#backing-up-postgresql). This is done just in case. The **syn2mas migration tool does not delete any data**, so it should be possible to revert to your previous setup by merely disabling MAS and re-running the playbook (no need to restore a Postgres backup). However, do note that as users start logging in (creating new login sessions) via the new MAS setup, disabling MAS and reverting back to the Synapse user database will cause these new sessions to break.
|
||||
3. Consider taking a full [backup of your Postgres database](./maintenance-postgres.md#backing-up-postgresql). This is done just in case. The **syn2mas migration command does not delete any data**, so it should be possible to revert to your previous setup by merely disabling MAS and re-running the playbook (no need to restore a Postgres backup). However, do note that as users start logging in (creating new login sessions) via the new MAS setup, disabling MAS and reverting back to the Synapse user database will cause these new sessions to break.
|
||||
|
||||
4. [Migrate your data from Synapse to Matrix Authentication Service using syn2mas](#migrate-your-data-from-synapse-to-matrix-authentication-service-using-syn2mas)
|
||||
|
||||
@@ -342,9 +344,7 @@ The installation + migration steps are like this:
|
||||
|
||||
### Migrate your data from Synapse to Matrix Authentication Service using syn2mas
|
||||
|
||||
We **don't** ask you to [run the `syn2mas` migration advisor command](https://element-hq.github.io/matrix-authentication-service/setup/migration.html#run-the-migration-advisor), because it only gives you the green light if your Synapse configuration (`homeserver.yaml`) is configured in a way that's compatible with MAS (delegating authentication to MAS; disabling Synapse's password config; etc.). Until we migrate your data with the `syn2mas` tool, we intentionally avoid doing these changes to allow existing user sessions to work.
|
||||
|
||||
You can invoke the `syn2mas` tool via the playbook by running the playbook's `matrix-authentication-service-syn2mas` tag. We recommend first doing a [dry-run](#performing-a-syn2mas-dry-run) and then a [real migration](#performing-a-real-syn2mas-migration).
|
||||
You can invoke the `syn2mas` tool via the playbook by running the playbook's `matrix-authentication-service-mas-cli-syn2mas` tag. We recommend first doing a [dry-run](#performing-a-syn2mas-dry-run) and then a [real migration](#performing-a-real-syn2mas-migration).
|
||||
|
||||
#### Configuring syn2mas
|
||||
|
||||
@@ -356,26 +356,9 @@ When you're done with potentially configuring `syn2mas`, proceed to doing a [dry
|
||||
|
||||
##### Configuring upstream OIDC provider mapping for syn2mas
|
||||
|
||||
If you have existing OIDC users in your Synapse user database (which will be the case if when using [OIDC with Synapse](./configuring-playbook-synapse.md#synapse--openid-connect-for-single-sign-on)), you may need to pass an additional `--upstreamProviderMapping` argument to the `syn2mas` tool to tell it which provider (on the Synapse side) maps to which other provider on the MAS side.
|
||||
Since Matrix Authentication Service v0.16.0 (which replaced the standalone `syn2mas` tool with a `mas-cli syn2mas` sub-command), OIDC configuration (mapping from your old OIDC configuration to your new one, etc) is meant to be configured in the Matrix Authentication Service configuration (via `matrix_authentication_service_config_upstream_oauth2_providers`) as a `synapse_idp_id` property for each provider.
|
||||
|
||||
If you don't do this, `syn2mas` would report errors like this one:
|
||||
|
||||
> [FATAL] migrate - [Failed to import external id 4264b0f0-4f11-4ddd-aedb-b500e4d07c25 with oidc-keycloak for user @alice:example.com: Error: Unknown upstream provider oidc-keycloak]
|
||||
|
||||
Below is an example situation and a guide for how to solve it.
|
||||
|
||||
If in `matrix_synapse_oidc_providers` your provider `idp_id` is (was) named `keycloak`, in the Synapse database users would be associated with the `oidc-keycloak` provider (note the `oidc-` prefix that was added automatically by Synapse to your `idp_id` value).
|
||||
|
||||
The same OIDC provider may have an `id` of `01HFVBY12TMNTYTBV8W921M5FA` on the MAS side, as defined in `matrix_authentication_service_config_upstream_oauth2_providers` (see the [Upstream OAuth2 configuration](#upstream-oauth2-configuration) section above).
|
||||
|
||||
To tell `syn2mas` how the Synapse-configured OIDC provider maps to the new MAS-configured OIDC provider, add this additional configuration to your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
# Adjust the mapping below to match your provider IDs on the Synapse side and the MAS side.
|
||||
# Don't forget that Synapse automatically adds an `oidc-` prefix to provider ids defined in its configuration.
|
||||
matrix_authentication_service_syn2mas_process_extra_arguments:
|
||||
- "--upstreamProviderMapping oidc-keycloak:01HFVBY12TMNTYTBV8W921M5FA"
|
||||
```
|
||||
You can refer to the [Map any upstream SSO providers](https://element-hq.github.io/matrix-authentication-service/setup/migration.html#map-any-upstream-sso-providers) section of the MAS documentation for figuring out how to set the `synapse_idp_id` value in `matrix_authentication_service_config_upstream_oauth2_providers` correctly.
|
||||
|
||||
#### Performing a syn2mas dry-run
|
||||
|
||||
@@ -386,7 +369,7 @@ A dry-run would not cause downtime, because it avoids stopping Synapse.
|
||||
To perform a dry-run, run:
|
||||
|
||||
```sh
|
||||
just run-tags matrix-authentication-service-syn2mas -e matrix_authentication_service_syn2mas_dry_run=true
|
||||
just run-tags matrix-authentication-service-mas-cli-syn2mas -e matrix_authentication_service_syn2mas_migrate_dry_run=true
|
||||
```
|
||||
|
||||
Observe the command output (especially the last line of the the syn2mas output). If you are confident that the migration will work out as expected, you can proceed with a [real migration](#performing-a-real-syn2mas-migration).
|
||||
@@ -405,13 +388,13 @@ Before performing a real migration make sure:
|
||||
|
||||
- you've performed a [syn2mas dry-run](#performing-a-syn2mas-dry-run) and don't see any issues in its output
|
||||
|
||||
To perform a real migration, run the `matrix-authentication-service-syn2mas` tag **without** the `matrix_authentication_service_syn2mas_dry_run` variable:
|
||||
To perform a real migration, run the `matrix-authentication-service-mas-cli-syn2mas` tag **without** the `matrix_authentication_service_syn2mas_migrate_dry_run` variable:
|
||||
|
||||
```sh
|
||||
just run-tags matrix-authentication-service-syn2mas
|
||||
just run-tags matrix-authentication-service-mas-cli-syn2mas
|
||||
```
|
||||
|
||||
Having performed a `syn2mas` migration once, trying to do it again will report errors for users that were already migrated (e.g. "Error: Unknown upstream provider oauth-delegated").
|
||||
Having performed a `syn2mas` migration once, trying to do it again will report errors (e.g. "Error: The MAS database is not empty: rows found in at least `users`. Please drop and recreate the database, then try again.").
|
||||
|
||||
## Verify that Matrix Authentication Service is installed correctly
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
The playbook can install and configure [matrix-corporal](https://github.com/devture/matrix-corporal) for you.
|
||||
|
||||
In short, it's a sort of automation and firewalling service, which is helpful if you're instaling Matrix services in a controlled corporate environment.
|
||||
In short, it's a sort of automation and firewalling service, which is helpful if you're installing Matrix services in a controlled corporate environment.
|
||||
|
||||
See the project's [documentation](https://github.com/devture/matrix-corporal/blob/main/README.md) to learn what it does and why it might be useful to you.
|
||||
|
||||
|
||||
@@ -60,7 +60,7 @@ To `matrix_media_repo_container_labels_traefik_metrics_middleware_basic_auth_use
|
||||
|
||||
#### Enable Grafana (optional)
|
||||
|
||||
Probably you wish to enable Grafana along with Prometheus for generating graphs of the metics.
|
||||
Probably you wish to enable Grafana along with Prometheus for generating graphs of the metrics.
|
||||
|
||||
To enable Grafana, see [this section](configuring-playbook-prometheus-grafana.md#adjusting-the-playbook-configuration-grafana) for instructions.
|
||||
|
||||
|
||||
@@ -16,7 +16,6 @@ The Matrix RTC stack is a set of supporting components ([LiveKit Server](configu
|
||||
## Prerequisites
|
||||
|
||||
- A [Synapse](configuring-playbook-synapse.md) homeserver (see the warning below)
|
||||
- [Federation](configuring-playbook-federation.md) being enabled for your Matrix homeserver (federation is enabled by default, unless you've explicitly disabled it), because [LiveKit JWT Service](configuring-playbook-livekit-jwt-service.md) currently [requires it](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3562#issuecomment-2725250554) ([relevant source code](https://github.com/element-hq/lk-jwt-service/blob/f5f5374c4bdcc00a4fb13d27c0b28e20e4c62334/main.go#L135-L146))
|
||||
- Various experimental features for the Synapse homeserver which Element Call [requires](https://github.com/element-hq/element-call/blob/93ae2aed9841e0b066d515c56bd4c122d2b591b2/docs/self-hosting.md#a-matrix-homeserver) (automatically done when Element Call is enabled)
|
||||
- A [LiveKit Server](configuring-playbook-livekit-server.md) (automatically installed when [Element Call or the Matrix RTC stack is enabled](#decide-between-element-call-vs-just-the-matrix-rtc-stack))
|
||||
- The [LiveKit JWT Service](configuring-playbook-livekit-jwt-service.md) (automatically installed when [Element Call or the Matrix RTC stack is enabled](#decide-between-element-call-vs-just-the-matrix-rtc-stack))
|
||||
@@ -56,4 +55,4 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju
|
||||
|
||||
Once installed, Matrix clients which support Element Call (like [Element Web](configuring-playbook-client-element-web.md) and Element X on mobile (iOS and Android)) will automatically use the Matrix RTC stack.
|
||||
|
||||
These clients typically embed the Element Call frontend UI within them, so installing [Element Call](configuring-playbook-element-call.md) is only necessary if you'd like to use it standalone - directly via a browser.
|
||||
These clients typically embed the Element Call frontend UI within them, so installing [Element Call](configuring-playbook-element-call.md) is only necessary if you'd like to use it standalone - directly via a browser.
|
||||
|
||||
68
docs/configuring-playbook-matrixto.md
Normal file
68
docs/configuring-playbook-matrixto.md
Normal file
@@ -0,0 +1,68 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2023 - 2024 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up Matrix.to (optional)
|
||||
|
||||
The playbook can install and configure the [Matrix.to](https://github.com/matrix-org/matrix.to) URL redirection service for you.
|
||||
|
||||
See the project's [documentation](https://github.com/matrix-org/matrix.to/blob/main/README.md) to learn what it does and why it might be useful to you.
|
||||
|
||||
## Adjusting DNS records
|
||||
|
||||
By default, this playbook installs Matrix.to on the `mt.` subdomain (`mt.example.com`) and requires you to create a CNAME record for `mt`, which targets `matrix.example.com`.
|
||||
|
||||
When setting, replace `example.com` with your own.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable Matrix.to, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_matrixto_enabled: true
|
||||
```
|
||||
|
||||
### Adjusting the Matrix.to URL (optional)
|
||||
|
||||
By tweaking the `matrix_matrixto_hostname` variable, you can easily make the service available at a **different hostname** than the default one.
|
||||
|
||||
Example additional configuration for your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
# Change the default hostname
|
||||
matrix_matrixto_hostname: t.example.com
|
||||
```
|
||||
|
||||
After changing the domain, **you may need to adjust your DNS** records to point the Matrix.to domain to the Matrix server.
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the server.
|
||||
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-matrixto/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
|
||||
## Installing
|
||||
|
||||
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:
|
||||
|
||||
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
|
||||
```sh
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
```
|
||||
|
||||
The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`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.
|
||||
|
||||
## Usage
|
||||
|
||||
Refer to the project's [documentation](https://github.com/matrix-org/matrix.to/blob/main/README.md) for available parameters, etc.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-matrixto`.
|
||||
@@ -115,7 +115,7 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju
|
||||
|
||||
## Usage
|
||||
|
||||
To receive push notifications with UnifiedPush from the ntfy server, you need to **install [the ntfy Android app](https://docs.ntfy.sh/subscribe/phone/)** which works as the Distrubutor, **log in to the account on the ntfy app** if you have enabled the access control, and then **configure a UnifiedPush-compatible Matrix client**. After setting up the ntfy Android app, the Matrix client listens to it, and push notitications are "distributed" from it.
|
||||
To receive push notifications with UnifiedPush from the ntfy server, you need to **install [the ntfy Android app](https://docs.ntfy.sh/subscribe/phone/)** which works as the Distributor, **log in to the account on the ntfy app** if you have enabled the access control, and then **configure a UnifiedPush-compatible Matrix client**. After setting up the ntfy Android app, the Matrix client listens to it, and push notifications are "distributed" from it.
|
||||
|
||||
For details about installing and configuring the ntfy Android app, take a look at [this section](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/docs/configuring-ntfy.md#install-the-ntfy-androidios-app) on the role's documentation.
|
||||
|
||||
|
||||
@@ -51,7 +51,7 @@ matrix_playbook_reverse_proxy_type: other-traefik-container
|
||||
# Adjust to point to your Traefik container
|
||||
matrix_playbook_reverse_proxy_hostname: name-of-your-traefik-container
|
||||
|
||||
traefik_certs_dumper_ssl_dir_path: "/path/to/your/traefiks/acme.json/directory"
|
||||
traefik_certs_dumper_ssl_path: "/path/to/your/traefiks/acme.json/directory"
|
||||
|
||||
# Uncomment and adjust the variable below if the name of your federation entrypoint is different
|
||||
# than the default value (matrix-federation).
|
||||
|
||||
@@ -258,4 +258,4 @@ As with all other services, you can find the logs in [systemd-journald](https://
|
||||
- [The Prometheus scraping rules](https://github.com/element-hq/synapse/tree/master/contrib/prometheus) (we use v2)
|
||||
- [The Synapse Grafana dashboard](https://github.com/element-hq/synapse/tree/master/contrib/grafana)
|
||||
- [The Node Exporter dashboard](https://github.com/rfrail3/grafana-dashboards) (for generic non-synapse performance graphs)
|
||||
- [The PostgresSQL dashboard](https://grafana.com/grafana/dashboards/9628) (generic Postgres dashboard)
|
||||
- [The PostgreSQL dashboard](https://grafana.com/grafana/dashboards/9628) (generic Postgres dashboard)
|
||||
|
||||
@@ -22,13 +22,11 @@ Finally, [set up S3 storage for Synapse](#setting-up) (with [Goofys](configuring
|
||||
|
||||
## Choosing an Object Storage provider
|
||||
|
||||
You can create [Amazon S3](https://aws.amazon.com/s3/) or another S3-compatible object storage like [Backblaze B2](https://www.backblaze.com/b2/cloud-storage.html), [Storj](https://storj.io), [Wasabi](https://wasabi.com), [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces), etc.
|
||||
You can create [Amazon S3](https://aws.amazon.com/s3/) or another S3-compatible object storage like [Backblaze B2](https://www.backblaze.com/b2/cloud-storage.html), [Wasabi](https://wasabi.com), [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces), [Storj](https://storj.io), etc.
|
||||
|
||||
Amazon S3, Backblaze B2, and Storj are pay-as-you with no minimum charges for storing too little data.
|
||||
Amazon S3 and Backblaze B2 are pay-as-you with no minimum charges for storing too little data. Note that Backblaze egress is free, but for only certain users for up to 3x the amount of data stored. Beyond that you will pay $0.01/GB of egress.
|
||||
|
||||
All these providers have different prices, with Storj appearing to be the cheapest (as of 2024-10, storage fee is $0.004 per GB/month, and egress fee is $0.007 per GB; check actual pricing [here](https://storj.dev/dcs/pricing)). Backblaze egress is free, but for only certain users for up to 3x the amount of data stored. Beyond that you will pay $0.01/GB of egress.
|
||||
|
||||
Wasabi has a minimum charge of 1TB if you're storing less than 1TB, which becomes expensive if you need to store less data than that. Likewise, Digital Ocean Spaces has also a minimum charge of 250GB ($5/month as of 2022-10).
|
||||
Wasabi has a minimum charge of 1TB if you're storing less than 1TB, which becomes expensive if you need to store less data than that. Likewise, Digital Ocean Spaces has also a minimum charge of 250GB ($5/month as of 2022-10). Though Storj does not set minimum amount of data to be stored, it also charges $5 minimum monthly usage fee since July 1, 2025, if your monthly usage (storage, bandwidth, and segments) totals less than $5.
|
||||
|
||||
Here are some of the important aspects of choosing the right provider:
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ By default, the playbook retrieves and automatically renews free SSL certificate
|
||||
|
||||
**Notes**:
|
||||
- This guide is intended to be referred for configuring the integrated Traefik server with regard to SSL certificates retrieval. If you're using [your own webserver](configuring-playbook-own-webserver.md), consult its documentation about how to configure it.
|
||||
- Let's Encrypt ends the expiration notification email service on June 4, 2025 (see: [the official announcement](https://letsencrypt.org/2025/01/22/ending-expiration-emails/)), and it recommends using a third party service for those who want to receive expiriation notifications. If you are looking for a self-hosting service, you may be interested in a monitoring tool such as [Update Kuma](https://github.com/louislam/uptime-kuma/).
|
||||
- Let's Encrypt ends the expiration notification email service on June 4, 2025 (see: [the official announcement](https://letsencrypt.org/2025/01/22/ending-expiration-emails/)), and it recommends using a third party service for those who want to receive expiration notifications. If you are looking for a self-hosting service, you may be interested in a monitoring tool such as [Update Kuma](https://github.com/louislam/uptime-kuma/).
|
||||
|
||||
The [Mother-of-All-Self-Hosting (MASH)](https://github.com/mother-of-all-self-hosting/mash-playbook) Ansible playbook can be used to install and manage an Uptime Kuma instance. See [this page](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/uptime-kuma.md) for the instruction to install it with the MASH playbook. If you are wondering how to use the MASH playbook for your Matrix server, refer [this page](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/setting-up-services-on-mdad-server.md).
|
||||
|
||||
|
||||
@@ -49,8 +49,8 @@ aux_file_definitions:
|
||||
content
|
||||
here
|
||||
mode: '0600'
|
||||
owner: "{{ matrix_user_username }}"
|
||||
group: "{{ matrix_user_groupname }}"
|
||||
owner: "{{ matrix_user_name }}"
|
||||
group: "{{ matrix_group_name }}"
|
||||
```
|
||||
|
||||
Configuring [GCM/FCM](https://firebase.google.com/docs/cloud-messaging/) is easier, as it only requires that you provide some config values.
|
||||
|
||||
@@ -18,6 +18,8 @@ synapse-admin is a web UI tool you can use to **administrate users, rooms, media
|
||||
|
||||
💡 **Note**: the latest version of synapse-admin is hosted by [etke.cc](https://etke.cc/) at [admin.etke.cc](https://admin.etke.cc/). If you only need this service occasionally and trust giving your admin credentials to a 3rd party Single Page Application, you can consider using it from there and avoiding the (small) overhead of self-hosting.
|
||||
|
||||
💡 **Note**: The playbook also supports an alternative management UI in the shape of [Element Admin](./configuring-playbook-element-admin.md). However, it's currently less feature-rich than Synapse Admin and has a dependency on [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md).
|
||||
|
||||
## Adjusting DNS records (optional)
|
||||
|
||||
By default, this playbook installs Synapse Admin on the `matrix.` subdomain, at the `/synapse-admin` path (https://matrix.example.com/synapse-admin). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section.
|
||||
@@ -39,9 +41,6 @@ matrix_synapse_admin_enabled: true
|
||||
|
||||
By default, synapse-admin installation will be [restricted to only work with one homeserver](https://github.com/etkecc/synapse-admin/blob/e21e44362c879ac41f47c580b04210842b6ff3d7/README.md#restricting-available-homeserver) — the one managed by the playbook. To adjust these restrictions, tweak the `matrix_synapse_admin_config_restrictBaseUrl` variable.
|
||||
|
||||
> [!WARNING]
|
||||
> If you're using [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md) (MAS) for authentication, you will be able to [log into synapse-admin with an access token](https://github.com/etkecc/synapse-admin/pull/58), but certain synapse-admin features (especially those around user management) will be limited or not work at all.
|
||||
|
||||
### Adjusting the Synapse Admin URL (optional)
|
||||
|
||||
By tweaking the `matrix_synapse_admin_hostname` and `matrix_synapse_admin_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one.
|
||||
|
||||
@@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
The playbook can install and configure [synapse-simple-antispam](https://github.com/t2bot/synapse-simple-antispam) for you.
|
||||
|
||||
It lets you fight invite-spam by automatically blocking invitiations from a list of servers specified by you (blacklisting).
|
||||
It lets you fight invite-spam by automatically blocking invitations from a list of servers specified by you (blacklisting).
|
||||
|
||||
See the project's [documentation](https://github.com/t2bot/synapse-simple-antispam/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||
|
||||
|
||||
@@ -53,7 +53,7 @@ You may also consider [tweaking the number of workers of each type](#controlling
|
||||
|
||||
##### Specialized workers
|
||||
|
||||
The playbook now supports a smarter **specialized load-balancing** inspired by [Tom Foster](https://github.com/tcpipuk)'s [Synapse homeserver guide](https://tcpipuk.github.io/synapse/index.html). Instead of routing requests to one or more [generic workers](#generic-workers) based only on the requestor's IP adddress, specialized load-balancing routes to **4 different types of specialized workers** based on **smarter criteria** — the access token (username) of the requestor and/or on the resource (room, etc.) being requested.
|
||||
The playbook now supports a smarter **specialized load-balancing** inspired by [Tom Foster](https://github.com/tcpipuk)'s [Synapse homeserver guide](https://tcpipuk.github.io/synapse/index.html). Instead of routing requests to one or more [generic workers](#generic-workers) based only on the requester's IP address, specialized load-balancing routes to **4 different types of specialized workers** based on **smarter criteria** — the access token (username) of the requester and/or on the resource (room, etc.) being requested.
|
||||
|
||||
The playbook supports these **4 types** of specialized workers:
|
||||
|
||||
|
||||
@@ -53,6 +53,8 @@ For a more custom setup, see the [Other configuration options](#other-configurat
|
||||
|
||||
- [Configuring conduwuit](configuring-playbook-conduwuit.md), if you've switched to the [conduwuit](https://conduwuit.puppyirl.gay/) homeserver implementation
|
||||
|
||||
- [Configuring continuwuity](configuring-playbook-continuwuity.md), if you've switched to the [continuwuity](https://continuwuity.org) homeserver implementation
|
||||
|
||||
- [Configuring Dendrite](configuring-playbook-dendrite.md), if you've switched to the [Dendrite](https://matrix-org.github.io/dendrite) homeserver implementation
|
||||
|
||||
- Server components:
|
||||
@@ -172,19 +174,11 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
||||
|
||||
- [Setting up matrix-hookshot](configuring-playbook-bridge-hookshot.md) — a bridge between Matrix and multiple project management services, such as [GitHub](https://github.com), [GitLab](https://about.gitlab.com) and [JIRA](https://www.atlassian.com/software/jira).
|
||||
|
||||
- [Setting up MX Puppet Slack bridging](configuring-playbook-bridge-mx-puppet-slack.md)
|
||||
|
||||
- [Setting up MX Puppet Instagram bridging](configuring-playbook-bridge-mx-puppet-instagram.md)
|
||||
|
||||
- [Setting up MX Puppet Twitter bridging](configuring-playbook-bridge-mx-puppet-twitter.md)
|
||||
|
||||
- [Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md)
|
||||
|
||||
- [Setting up MX Puppet GroupMe bridging](configuring-playbook-bridge-mx-puppet-groupme.md)
|
||||
|
||||
- [Setting up MX Puppet Steam bridging](configuring-playbook-bridge-mx-puppet-steam.md)
|
||||
- [Setting up Steam bridging](configuring-playbook-bridge-steam.md)
|
||||
|
||||
- [Setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md)
|
||||
- [Setting up MX Puppet Steam bridging](configuring-playbook-bridge-mx-puppet-steam.md)
|
||||
|
||||
- [Setting up Postmoogle email bridging](configuring-playbook-bridge-postmoogle.md)
|
||||
|
||||
@@ -194,6 +188,8 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
||||
|
||||
- [Setting up WeChat bridging](configuring-playbook-bridge-wechat.md)
|
||||
|
||||
- [Setting up Zulip bridging](configuring-playbook-bridge-zulip.md)
|
||||
|
||||
### Bots
|
||||
|
||||
Bots provide various additional functionality to your installation.
|
||||
@@ -251,6 +247,8 @@ Various services that don't fit any other categories.
|
||||
|
||||
- [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (advanced)
|
||||
|
||||
- [Setting up Matrix.to](configuring-playbook-matrixto.md)
|
||||
|
||||
- [Setting up Etherpad](configuring-playbook-etherpad.md)
|
||||
|
||||
- [Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md)
|
||||
@@ -277,10 +275,20 @@ Various services that don't fit any other categories.
|
||||
|
||||
- [Setting up Go-NEB](configuring-playbook-bot-go-neb.md) (unmaintained; the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be [installed using this playbook](configuring-playbook-bridge-hookshot.md))
|
||||
|
||||
- [Setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md) (removed; Skype has been discontinued since May 2025)
|
||||
|
||||
- [Setting up matrix-bot-chatgpt](configuring-playbook-bot-chatgpt.md) (unmaintained; the bridge's author suggests taking a look at [baibot](https://github.com/etkecc/baibot) as a replacement, which can also be [installed using this playbook](configuring-playbook-bot-baibot.md))
|
||||
|
||||
- [Setting up Mautrix Facebook bridging](configuring-playbook-bridge-mautrix-facebook.md) (deprecated in favor of the Messenger/Instagram bridge with [mautrix-meta-messenger](configuring-playbook-bridge-mautrix-meta-messenger.md))
|
||||
|
||||
- [Setting up Mautrix Instagram bridging](configuring-playbook-bridge-mautrix-instagram.md) (deprecated in favor of the Messenger/Instagram bridge with [mautrix-meta-instagram](configuring-playbook-bridge-mautrix-meta-instagram.md))
|
||||
|
||||
- [Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md) (removed; this component has been unmaintained for a long time, so it has been removed from the playbook. Consider [setting up Mautrix Discord bridging](configuring-playbook-bridge-mautrix-discord.md))
|
||||
|
||||
- [Setting up MX Puppet Instagram bridging](configuring-playbook-bridge-mx-puppet-instagram.md) (removed; this component has been unmaintained for a long time, so it has been removed from the playbook. Consider [setting up Instagram bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-instagram.md))
|
||||
|
||||
- [Setting up MX Puppet Skype bridging](configuring-playbook-bridge-mx-puppet-skype.md) (removed; this component has been broken for a long time, so it has been removed from the playbook. Consider [setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md))
|
||||
|
||||
- [Setting up MX Puppet Slack bridging](configuring-playbook-bridge-mx-puppet-slack.md) (removed; this component has been unmaintained for a long time, so it has been removed from the playbook. Consider [setting up Mautrix Slack bridging](configuring-playbook-bridge-mautrix-slack.md))
|
||||
|
||||
- [Setting up MX Puppet Twitter bridging](configuring-playbook-bridge-mx-puppet-twitter.md) (removed; this component has been unmaintained for a long time, so it has been removed from the playbook. Consider [setting up Mautrix Twitter bridging](configuring-playbook-bridge-mautrix-twitter.md))
|
||||
|
||||
@@ -28,6 +28,7 @@ We try to stick to official images (provided by their respective projects) as mu
|
||||
| [Synapse](configuring-playbook-synapse.md) | [element-hq/synapse](https://ghcr.io/element-hq/synapse) | ✅ | Storing your data and managing your presence in the [Matrix](http://matrix.org/) network |
|
||||
| [Conduit](configuring-playbook-conduit.md) | [matrixconduit/matrix-conduit](https://hub.docker.com/r/matrixconduit/matrix-conduit) | ❌ | Storing your data and managing your presence in the [Matrix](http://matrix.org/) network. Conduit is a lightweight open-source server implementation of the Matrix Specification with a focus on easy setup and low system requirements |
|
||||
| [conduwuit](configuring-playbook-conduwuit.md) | [girlbossceo/conduwuit](https://ghcr.io/girlbossceo/conduwuit) | ❌ | Storing your data and managing your presence in the [Matrix](http://matrix.org/) network. conduwuit is a fork of Conduit. |
|
||||
| [continuwuity](configuring-playbook-continuwuity.md) | [continuwuation/continuwuity](https://forgejo.ellis.link/continuwuation/continuwuity) | ❌ | Storing your data and managing your presence in the [Matrix](http://matrix.org/) network. continuwuity is a continuation of conduwuit. |
|
||||
| [Dendrite](configuring-playbook-dendrite.md) | [matrixdotorg/dendrite-monolith](https://hub.docker.com/r/matrixdotorg/dendrite-monolith/) | ❌ | Storing your data and managing your presence in the [Matrix](http://matrix.org/) network. Dendrite is a second-generation Matrix homeserver written in Go, an alternative to Synapse. |
|
||||
|
||||
## Clients
|
||||
@@ -106,13 +107,10 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
||||
| [matrix-hookshot](configuring-playbook-bridge-hookshot.md) | [halfshot/matrix-hookshot](https://hub.docker.com/r/halfshot/matrix-hookshot) | ❌ | Bridge for generic webhooks and multiple project management services, such as GitHub, GitLab, Figma, and Jira in particular |
|
||||
| [matrix-sms-bridge](configuring-playbook-bridge-matrix-bridge-sms.md) | [folivonet/matrix-sms-bridge](https://hub.docker.com/repository/docker/folivonet/matrix-sms-bridge) | ❌ | Bridge to SMS |
|
||||
| [matrix-wechat](configuring-playbook-bridge-wechat.md) | [lxduo/matrix-wechat](https://hub.docker.com/r/lxduo/matrix-wechat) | ❌ | Bridge to [WeChat](https://www.wechat.com/) |
|
||||
| [MatrixZulipBridge](configuring-playbook-bridge-zulip.md) | [GearKite/MatrixZulipBridge](https://ghcr.io/gearkite/matrixzulipbridge) | ❌ | Puppeting appservice bridge for [Zulip](https://zulip.com/) |
|
||||
| [Heisenbridge](configuring-playbook-bridge-heisenbridge.md) | [hif1/heisenbridge](https://hub.docker.com/r/hif1/heisenbridge) | ❌ | Bouncer-style bridge to [IRC](https://wikipedia.org/wiki/Internet_Relay_Chat) |
|
||||
| [go-skype-bridge](configuring-playbook-bridge-go-skype-bridge.md) | [nodefyme/go-skype-bridge](https://hub.docker.com/r/nodefyme/go-skype-bridge) | ❌ | Bridge to [Skype](https://www.skype.com) |
|
||||
| [mx-puppet-slack](configuring-playbook-bridge-mx-puppet-slack.md) | [mx-puppet/slack/mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack/container_registry) | ❌ | Bridge to [Slack](https://slack.com) |
|
||||
| [mx-puppet-instagram](configuring-playbook-bridge-mx-puppet-instagram.md) | [sorunome/mx-puppet-instagram](https://hub.docker.com/r/sorunome/mx-puppet-instagram) | ❌ | Bridge for Instagram-DMs ([Instagram](https://www.instagram.com/)) |
|
||||
| [mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md) | [sorunome/mx-puppet-twitter](https://hub.docker.com/r/sorunome/mx-puppet-twitter) | ❌ | Bridge for Twitter-DMs ([Twitter](https://twitter.com/)) |
|
||||
| [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) | [mx-puppet/discord/mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord/container_registry) | ❌ | Bridge to [Discord](https://discordapp.com/) |
|
||||
| [mx-puppet-groupme](configuring-playbook-bridge-mx-puppet-groupme.md) | [xangelix/mx-puppet-groupme](https://hub.docker.com/r/xangelix/mx-puppet-groupme) | ❌ | Bridge to [GroupMe](https://groupme.com/) |
|
||||
| [matrix-steam-bridge](configuring-playbook-bridge-steam.md) | [jasonlaguidice/matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge/pkgs/container/matrix-steam-bridge) | ❌ | Bridge to [Steam](https://steampowered.com/) |
|
||||
| [mx-puppet-steam](configuring-playbook-bridge-mx-puppet-steam.md) | [icewind1991/mx-puppet-steam](https://hub.docker.com/r/icewind1991/mx-puppet-steam) | ❌ | Bridge to [Steam](https://steamapp.com/) |
|
||||
| [Postmoogle](configuring-playbook-bridge-postmoogle.md) | [etke.cc/postmoogle](https://github.com/etkecc/postmoogle/container_registry) | ❌ | Email to Matrix bridge |
|
||||
|
||||
@@ -157,7 +155,7 @@ Various services that don't fit any other categories.
|
||||
| ------- | --------------- | -------- | ----------- |
|
||||
| [sliding-sync](configuring-playbook-sliding-sync-proxy.md) | [matrix-org/sliding-sync](https://ghcr.io/matrix-org/sliding-sync) | ❌ | Sliding Sync support for clients which require it (like old Element X versions, before it got switched to Simplified Sliding Sync) |
|
||||
| [synapse_auto_accept_invite](configuring-playbook-synapse-auto-accept-invite.md) | (N/A) | ❌ | Synapse module to automatically accept invites |
|
||||
| [synapse_auto_compressor](configuring-playbook-synapse-auto-compressor.md) | [etke.cc/rust-synapse-compress-state](https://gitlab.com/etke.cc/rust-synapse-compress-state/container_registry) | ❌ | Cli tool that automatically compresses `state_groups` database table in background |
|
||||
| [synapse_auto_compressor](configuring-playbook-synapse-auto-compressor.md) | [mb-saces/rust-synapse-tools](https://gitlab.com/mb-saces/rust-synapse-tools/container_registry) | ❌ | Cli tool that automatically compresses Synapse's `state_groups` database table in background |
|
||||
| [Matrix Corporal](configuring-playbook-matrix-corporal.md) (advanced) | [devture/matrix-corporal](https://hub.docker.com/r/devture/matrix-corporal/) | ❌ | Reconciliator and gateway for a managed Matrix server |
|
||||
| [Etherpad](configuring-playbook-etherpad.md) | [etherpad/etherpad](https://hub.docker.com/r/etherpad/etherpad/) | ❌ | Open source collaborative text editor |
|
||||
| [Jitsi](configuring-playbook-jitsi.md) | [jitsi/web](https://hub.docker.com/r/jitsi/web) | ❌ | [Jitsi](https://jitsi.org/) web UI |
|
||||
@@ -177,10 +175,14 @@ The list of the deprecated or unmaintained services is available [here](configur
|
||||
|
||||
| Service | Container image | Default? | Description |
|
||||
| ------- | --------------- | -------- | ----------- |
|
||||
| [matrix-appservice-webhooks](configuring-playbook-bridge-appservice-webhooks.md) | [turt2live/matrix-appservice-webhooks](https://hub.docker.com/r/turt2live/matrix-appservice-webhooks) | ❌ | Bridge for slack compatible webhooks ([ConcourseCI](https://concourse-ci.org/), [Slack](https://slack.com/) etc. pp.) |
|
||||
| [Dimension](configuring-playbook-dimension.md) | [turt2live/matrix-dimension](https://hub.docker.com/r/turt2live/matrix-dimension) | ❌ | Open source integration manager for Matrix clients |
|
||||
| [Email2Matrix](configuring-playbook-email2matrix.md) | [devture/email2matrix](https://hub.docker.com/r/devture/email2matrix/) | ❌ | Bridge for relaying emails to Matrix rooms |
|
||||
| [Go-NEB](configuring-playbook-bot-go-neb.md) | [matrixdotorg/go-neb](https://hub.docker.com/r/matrixdotorg/go-neb) | ❌ | Multi functional bot written in Go |
|
||||
| [matrix-appservice-webhooks](configuring-playbook-bridge-appservice-webhooks.md) | [turt2live/matrix-appservice-webhooks](https://hub.docker.com/r/turt2live/matrix-appservice-webhooks) | ❌ | Bridge for slack compatible webhooks ([ConcourseCI](https://concourse-ci.org/), [Slack](https://slack.com/) etc. pp.) |
|
||||
| [matrix-chatgpt-bot](configuring-playbook-bot-chatgpt.md) | [matrixgpt/matrix-chatgpt-bot](https://ghcr.io/matrixgpt/matrix-chatgpt-bot) | ❌ | Accessing ChatGPT via your favourite Matrix client |
|
||||
| [mautrix-facebook](configuring-playbook-bridge-mautrix-facebook.md) | [mautrix/facebook](https://mau.dev/mautrix/facebook/container_registry) | ❌ | Bridge to [Facebook](https://facebook.com/) |
|
||||
| [mautrix-instagram](configuring-playbook-bridge-mautrix-instagram.md) | [mautrix/instagram](https://mau.dev/mautrix/instagram/container_registry) | ❌ | Bridge to [Instagram](https://instagram.com/) |
|
||||
| [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) | [mx-puppet/discord/mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord/container_registry) | ❌ | Bridge to [Discord](https://discordapp.com/) |
|
||||
| [mx-puppet-instagram](configuring-playbook-bridge-mx-puppet-instagram.md) | [sorunome/mx-puppet-instagram](https://hub.docker.com/r/sorunome/mx-puppet-instagram) | ❌ | Bridge for Instagram-DMs ([Instagram](https://www.instagram.com/)) |
|
||||
| [mx-puppet-slack](configuring-playbook-bridge-mx-puppet-slack.md) | [mx-puppet/slack/mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack/container_registry) | ❌ | Bridge to [Slack](https://slack.com) |
|
||||
| [mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md) | [sorunome/mx-puppet-twitter](https://hub.docker.com/r/sorunome/mx-puppet-twitter) | ❌ | Bridge for Twitter-DMs ([Twitter](https://twitter.com/)) |
|
||||
|
||||
17
docs/faq.md
17
docs/faq.md
@@ -235,7 +235,7 @@ Running Matrix on a server with 1GB of memory is possible (especially if you dis
|
||||
|
||||
**We recommend starting with a server having at least 2GB of memory** and even then using it sparingly. If you know for sure you'll be joining various large rooms, etc., then going for 4GB of memory or more is a good idea.
|
||||
|
||||
Besides the regular Matrix stuff, we also support things like video-conferencing using [Jitsi](configuring-playbook-jitsi.md) and other additional services which (when installed) may use up a lot of memory. Things do add up. Besides the Synapse Matrix server, Jitsi is especially notorious for consuming a lot of resources. If you plan on running Jitsi, we recommend a server with at least 2GB of memory (preferrably more). See our [Jitsi documentation page](configuring-playbook-jitsi.md) to learn how to optimize its memory/CPU usage.
|
||||
Besides the regular Matrix stuff, we also support things like video-conferencing using [Jitsi](configuring-playbook-jitsi.md) and other additional services which (when installed) may use up a lot of memory. Things do add up. Besides the Synapse Matrix server, Jitsi is especially notorious for consuming a lot of resources. If you plan on running Jitsi, we recommend a server with at least 2GB of memory (preferably more). See our [Jitsi documentation page](configuring-playbook-jitsi.md) to learn how to optimize its memory/CPU usage.
|
||||
|
||||
### Can I run this in an LXC container?
|
||||
|
||||
@@ -362,7 +362,7 @@ Configuration variables are defined in multiple places in this playbook and are
|
||||
|
||||
You can discover the variables you can override in each role (`roles/*/*/defaults/main.yml`).
|
||||
|
||||
As described in [How is the effective configuration determined?](#how-is-the-effective-configuration-determined), these role-defaults may be overriden by values defined in `group_vars/matrix_servers`.
|
||||
As described in [How is the effective configuration determined?](#how-is-the-effective-configuration-determined), these role-defaults may be overridden by values defined in `group_vars/matrix_servers`.
|
||||
|
||||
Refer to both of these for inspiration. Still, as mentioned in [Configuring the playbook](configuring-playbook.md), you're only ever supposed to edit your own `inventory/host_vars/matrix.example.com/vars.yml` file and nothing else inside the playbook (unless you're meaning to contribute new features).
|
||||
|
||||
@@ -440,6 +440,19 @@ To prevent double-logging, Docker logging is disabled by explicitly passing `--l
|
||||
|
||||
See [this section](maintenance-and-troubleshooting.md#how-to-see-the-logs) on the page for maintenance and troubleshooting for more details to see the logs.
|
||||
|
||||
### The server fails to start due to the `Unable to start service matrix-coturn.service` error. Why and how to solve it?
|
||||
|
||||
The error is most likely because Traefik cannot obtain SSL certificates due to certain reasons such as wrong domain name configuration or port 80 being unavailable due to other services.
|
||||
|
||||
If Traefik fails to obtain an SSL certificate for domain names such as `matrix.`, Traefik Certs Dumper cannot extract the SSL certificate out of there, and coturn cannot be started and the error occurs. Refer to these comments for details:
|
||||
|
||||
- <https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3957#issuecomment-2599590441>
|
||||
- <https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/4570#issuecomment-3364111466>
|
||||
|
||||
If you are not sure what the problem is, at first make sure that you have set the "base domain" (`example.com`, **not `matrix.example.com`**) to `matrix_domain`. You should be able to find it at the top of your `vars.yml`.
|
||||
|
||||
If it is correctly specified, look Traefik's logs (`journalctl -fu matrix-traefik.service`) for errors by Let's Encrypt for troubleshooting.
|
||||
|
||||
## Miscellaneous
|
||||
|
||||
### I would like to see this favorite service of mine integrated and become available on my Matrix server. How can I request it?
|
||||
|
||||
@@ -26,7 +26,7 @@ The up-to-date list can be accessed on [traefik's documentation](https://doc.tra
|
||||
|
||||
**Note**: the changes below instruct you how to do this for a basic Synapse installation. You will need to adapt the variable name and the content of the labels:
|
||||
|
||||
- if you're using another homeserver implementation (e.g. [Conduit](./configuring-playbook-conduit.md), [conduwuit](./configuring-playbook-conduwuit.md) or [Dendrite](./configuring-playbook-dendrite.md))
|
||||
- if you're using another homeserver implementation (e.g. [Conduit](./configuring-playbook-conduit.md), [conduwuit](./configuring-playbook-conduwuit.md), [continuwuity](./configuring-playbook-continuwuity.md) or [Dendrite](./configuring-playbook-dendrite.md))
|
||||
- if you're using [Synapse with workers enabled](./configuring-playbook-synapse.md#load-balancing-with-workers) (`matrix_synapse_workers_enabled: true`). In that case, it's actually the `matrix-synapse-reverse-proxy-companion` service which has Traefik labels attached
|
||||
|
||||
Also, all instructions below are from an older version of the playbook and may not work anymore.
|
||||
@@ -42,7 +42,7 @@ This is because with SRV federation, some servers / tools (one of which being th
|
||||
|
||||
### Tell Traefik which certificate to serve for the federation endpoint
|
||||
|
||||
Now that the federation endpoint is not bound to a domain anymore we need to explicitely tell Traefik to use a wildcard certificate in addition to one containing the base name.
|
||||
Now that the federation endpoint is not bound to a domain anymore we need to explicitly tell Traefik to use a wildcard certificate in addition to one containing the base name.
|
||||
|
||||
This is because the Matrix specification expects the federation endpoint to be served using a certificate compatible with the base domain, however, the other resources on the endpoint still need a valid certificate to work.
|
||||
|
||||
@@ -79,7 +79,7 @@ traefik_configuration_extension_yaml: |
|
||||
- "8.8.8.8:53"
|
||||
storage: {{ traefik_config_certificatesResolvers_acme_storage | to_json }}
|
||||
|
||||
# 2. Configure the environment variables needed by Rraefik to automate the ACME DNS Challenge (example for Cloudflare)
|
||||
# 2. Configure the environment variables needed by Traefik to automate the ACME DNS Challenge (example for Cloudflare)
|
||||
traefik_environment_variables: |
|
||||
CF_API_EMAIL=redacted
|
||||
CF_ZONE_API_TOKEN=redacted
|
||||
@@ -112,12 +112,12 @@ matrix_coturn_container_additional_volumes: |
|
||||
(
|
||||
[
|
||||
{
|
||||
'src': (traefik_certs_dumper_dumped_certificates_dir_path + '/*.' + matrix_domain + '/certificate.crt'),
|
||||
'src': (traefik_certs_dumper_dumped_certificates_path + '/*.' + matrix_domain + '/certificate.crt'),
|
||||
'dst': '/certificate.crt',
|
||||
'options': 'ro',
|
||||
},
|
||||
{
|
||||
'src': (traefik_certs_dumper_dumped_certificates_dir_path + '/*.' + matrix_domain + '/privatekey.key'),
|
||||
'src': (traefik_certs_dumper_dumped_certificates_path + '/*.' + matrix_domain + '/privatekey.key'),
|
||||
'dst': '/privatekey.key',
|
||||
'options': 'ro',
|
||||
},
|
||||
@@ -173,12 +173,12 @@ matrix_coturn_container_additional_volumes: |
|
||||
(
|
||||
[
|
||||
{
|
||||
'src': (traefik_certs_dumper_dumped_certificates_dir_path + '/*.' + matrix_domain + '/certificate.crt'),
|
||||
'src': (traefik_certs_dumper_dumped_certificates_path + '/*.' + matrix_domain + '/certificate.crt'),
|
||||
'dst': '/certificate.crt',
|
||||
'options': 'ro',
|
||||
},
|
||||
{
|
||||
'src': (traefik_certs_dumper_dumped_certificates_dir_path + '/*.' + matrix_domain + '/privatekey.key'),
|
||||
'src': (traefik_certs_dumper_dumped_certificates_path + '/*.' + matrix_domain + '/privatekey.key'),
|
||||
'dst': '/privatekey.key',
|
||||
'options': 'ro',
|
||||
},
|
||||
|
||||
@@ -157,6 +157,8 @@ The upstream projects, which this playbook makes use of, occasionally if not oft
|
||||
|
||||
Since it is unsafe to keep outdated services running on the server connected to the internet, please consider to update the playbook and re-run it periodically, in order to keep the services up-to-date.
|
||||
|
||||
Also, do not forget to update your system regularly. While this playbook may install basic services, such as Docker, it will not interfere further with system maintenance. Keeping the system itself up-to-date is out of scope for this playbook.
|
||||
|
||||
For more information about upgrading or maintaining services with the playbook, take a look at this page: [Upgrading the Matrix services](maintenance-upgrading-services.md)
|
||||
|
||||
Feel free to **re-run the setup command any time** you think something is wrong with the server configuration. Ansible will take your configuration and update your server to match.
|
||||
|
||||
@@ -104,12 +104,12 @@ To save disk space in `/tmp`, the dump file is gzipped on the fly at the expense
|
||||
|
||||
PostgreSQL can be [tuned](https://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server) to make it run faster. This is done by passing extra arguments to the Postgres process.
|
||||
|
||||
The [Postgres Ansible role](https://github.com/mother-of-all-self-hosting/ansible-role-postgres) **already does some tuning by default**, which matches the [tuning logic](https://github.com/le0pard/pgtune/blob/master/src/features/configuration/configurationSlice.js) done by websites like https://pgtune.leopard.in.ua/. You can manually influence some of the tuning variables. These parameters (variables) are injected via the `postgres_postgres_process_extra_arguments_auto` variable.
|
||||
The [Postgres Ansible role](https://github.com/mother-of-all-self-hosting/ansible-role-postgres) **already does some tuning by default**, which matches the [tuning logic](https://github.com/le0pard/pgtune/blob/master/src/features/configuration/configurationSlice.js) done by websites like https://pgtune.leopard.in.ua/. You can manually influence some of the tuning variables. These parameters (variables) are injected via the `postgres_postgres_process_extra_arguments_default` variable.
|
||||
|
||||
Most users should be fine with the automatically-done tuning. However, you may wish to:
|
||||
|
||||
- **adjust the automatically-determined tuning parameters manually**: change the values for the tuning variables defined in the Postgres role's [default configuration file](https://github.com/mother-of-all-self-hosting/ansible-role-postgres/blob/main/defaults/main.yml) (see `postgres_max_connections`, `postgres_data_storage` etc). These variables are ultimately passed to Postgres via a `postgres_postgres_process_extra_arguments_auto` variable
|
||||
- **adjust the automatically-determined tuning parameters manually**: change the values for the tuning variables defined in the Postgres role's [default configuration file](https://github.com/mother-of-all-self-hosting/ansible-role-postgres/blob/main/defaults/main.yml) (see `postgres_max_connections`, `postgres_data_storage` etc). These variables are ultimately passed to Postgres via a `postgres_postgres_process_extra_arguments_default` variable
|
||||
|
||||
- **turn automatically-performed tuning off**: override it like this: `postgres_postgres_process_extra_arguments_auto: []`
|
||||
- **turn automatically-performed tuning off**: override it like this: `postgres_postgres_process_extra_arguments_default: []`
|
||||
|
||||
- **add additional tuning parameters**: define your additional Postgres configuration parameters in `postgres_postgres_process_extra_arguments_custom`. See `postgres_postgres_process_extra_arguments_auto` defined in the Postgres role's [default configuration file](https://github.com/mother-of-all-self-hosting/ansible-role-postgres/blob/main/defaults/main.yml) for inspiration
|
||||
- **add additional tuning parameters**: define your additional Postgres configuration parameters in `postgres_postgres_process_extra_arguments_custom`. See `postgres_postgres_process_extra_arguments_default` defined in the Postgres role's [default configuration file](https://github.com/mother-of-all-self-hosting/ansible-role-postgres/blob/main/defaults/main.yml) for inspiration
|
||||
|
||||
@@ -49,7 +49,7 @@ We will be using `example.com` as the domain in the following instruction. Pleas
|
||||
|
||||
- [Python](https://www.python.org/). Most distributions install Python by default, but some don't (e.g. Ubuntu 18.04) and require manual installation (something like `apt-get install python3`). On some distros, Ansible may incorrectly [detect the Python version](https://docs.ansible.com/ansible/latest/reference_appendices/interpreter_discovery.html) (2 vs 3) and you may need to explicitly specify the interpreter path in `inventory/hosts` during installation (e.g. `ansible_python_interpreter=/usr/bin/python3`)
|
||||
|
||||
- [sudo](https://www.sudo.ws/), even when you've configured Ansible to log in as `root`. Some distributions, like a minimal Debian net install, do not include the `sudo` package by default.
|
||||
- [sudo](https://www.sudo.ws/), even when you've configured Ansible to log in as `root`, because this Ansible playbook sometimes uses the Ansible [become](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_privilege_escalation.html) module to perform tasks as another user (e.g. `matrix`) and the `become` module's default implementation uses `sudo`. Some distributions, like a minimal Debian net install, do not include the `sudo` package by default.
|
||||
|
||||
- An HTTPS-capable web server at the base domain name (`example.com`) which is capable of serving static files. Unless you decide to [Serve the base domain from the Matrix server](configuring-playbook-base-domain-serving.md) or alternatively, to use DNS SRV records for [Server Delegation](howto-server-delegation.md).
|
||||
|
||||
@@ -60,7 +60,7 @@ We will be using `example.com` as the domain in the following instruction. Pleas
|
||||
- `80/tcp`: HTTP webserver
|
||||
- `443/tcp` and `443/udp`: HTTPS webserver
|
||||
- `3478/tcp`: STUN/TURN over TCP (used by [coturn](./configuring-playbook-turn.md))
|
||||
- `3478/udp`: STUN/TURN over TCP (used by [coturn](./configuring-playbook-turn.md))
|
||||
- `3478/udp`: STUN/TURN over UDP (used by [coturn](./configuring-playbook-turn.md))
|
||||
- `5349/tcp`: TURN over TCP (used by [coturn](./configuring-playbook-turn.md))
|
||||
- `5349/udp`: TURN over UDP (used by [coturn](./configuring-playbook-turn.md))
|
||||
- `8448/tcp` and `8448/udp`: Matrix Federation API HTTPS webserver. Some components like [Matrix User Verification Service](configuring-playbook-user-verification-service.md#open-matrix-federation-port) require this port to be opened **even with federation disabled**.
|
||||
|
||||
@@ -39,9 +39,7 @@ Possibly outdated list of roles where self-building the Docker image is currentl
|
||||
- `matrix-bridge-hookshot`
|
||||
- `matrix-bridge-appservice-irc`
|
||||
- `matrix-bridge-appservice-slack`
|
||||
- `matrix-bridge-appservice-webhooks`
|
||||
- `matrix-bridge-beeper-linkedin`
|
||||
- `matrix-bridge-mautrix-facebook`
|
||||
- `matrix-bridge-mautrix-googlechat`
|
||||
- `matrix-bridge-mautrix-telegram`
|
||||
- `matrix-bridge-mautrix-signal`
|
||||
|
||||
@@ -33,6 +33,12 @@
|
||||
ProxyRequests Off
|
||||
ProxyVia On
|
||||
RequestHeader set "X-Forwarded-Proto" expr=%{REQUEST_SCHEME}
|
||||
ProxyTimeout 86400
|
||||
|
||||
RewriteEngine On
|
||||
RewriteCond %{HTTP:Connection} Upgrade [NC]
|
||||
RewriteCond %{HTTP:Upgrade} websocket [NC]
|
||||
RewriteRule /(.*) ws://127.0.0.1:81/$1 [P,L]
|
||||
|
||||
AllowEncodedSlashes NoDecode
|
||||
ProxyPass / http://127.0.0.1:81/ retry=0 nocanon
|
||||
|
||||
@@ -23,7 +23,7 @@ If Matrix federation is enabled, then you will need to make changes to [NPM's Do
|
||||
|
||||
You'll need to create two proxy hosts in NPM for Matrix web and federation traffic.
|
||||
|
||||
Open the 'Proxy Hosts' page in the NPM web interface and select `Add Proxy Host`, the first being for Matrix web traffic. Apply the proxys configuration like this:
|
||||
Open the 'Proxy Hosts' page in the NPM web interface and select `Add Proxy Host`, the first being for Matrix web traffic. Apply the proxy's configuration like this:
|
||||
|
||||
```md
|
||||
# Details
|
||||
@@ -44,7 +44,7 @@ Custom Nginx Configuration:
|
||||
client_max_body_size 50M;
|
||||
```
|
||||
|
||||
Again, under the 'Proxy Hosts' page select `Add Proxy Host`, this time for your federation traffic. Apply the proxys configuration like this:
|
||||
Again, under the 'Proxy Hosts' page select `Add Proxy Host`, this time for your federation traffic. Apply the proxy's configuration like this:
|
||||
|
||||
```md
|
||||
# Details
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -20,7 +20,7 @@ Currently, we support translation of:
|
||||
Organization of this `i18n` directory is as follows:
|
||||
|
||||
- [PUBLISHED_LANGUAGES](PUBLISHED_LANGUAGES): a list of languages that we publish translations for (in the [translations/](translations/) directory)
|
||||
- [.gitignore](.gitignore): a list of files and directories to ignore in the `i18n` directory. We intentionaly ignore translated results (`translations/<language>` directories) for languages taht are still in progress. We only [publish translations in a new language](#publish-translations-in-a-new-language) when the translation progresses beyond a certain threshold.
|
||||
- [.gitignore](.gitignore): a list of files and directories to ignore in the `i18n` directory. We intentionally ignore translated results (`translations/<language>` directories) for languages that are still in progress. We only [publish translations in a new language](#publish-translations-in-a-new-language) when the translation progresses beyond a certain threshold.
|
||||
- [justfile](justfile): a list of recipes for [just](https://github.com/casey/just) command runner
|
||||
- [requirements.txt](requirements.txt): a list of Python packages required to work with translations
|
||||
- [translation-templates/](translation-templates/): a list of English translation templates - strings extracted from Markdown files
|
||||
|
||||
@@ -0,0 +1,134 @@
|
||||
# SOME DESCRIPTIVE TITLE.
|
||||
# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community
|
||||
# members
|
||||
# This file is distributed under the same license as the
|
||||
# matrix-docker-ansible-deploy package.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
|
||||
#
|
||||
#, fuzzy
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language: bg\n"
|
||||
"Language-Team: bg <LL@li.org>\n"
|
||||
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=utf-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.16.0\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:1
|
||||
msgid "Configuring continuwuity (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:3
|
||||
msgid "The playbook can install and configure the [continuwuity](https://continuwuity.org/) Matrix server for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:5
|
||||
msgid "See the project's [documentation](https://continuwuity.org/) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:7
|
||||
msgid "By default, the playbook installs [Synapse](https://github.com/element-hq/synapse) as it's the only full-featured Matrix server at the moment. If that's okay, you can skip this document."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:9
|
||||
msgid "💡 **Note**: continuwuity is a fork of [conduwuit](./configuring-playbook-conduwuit.md), which the playbook also supports."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:11
|
||||
msgid "⚠️ **Warnings**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:13
|
||||
msgid "**You can't switch an existing Matrix server's implementation** (e.g. Synapse -> continuwuity). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:15
|
||||
msgid "**Homeserver implementations other than Synapse may not be fully functional**. The playbook may also not assist you in an optimal way (like it does with Synapse). Make yourself familiar with the downsides before proceeding"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:17
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:19
|
||||
msgid "To use continuwuity, you **generally** need to adjust the `matrix_homeserver_implementation: synapse` configuration on your `inventory/host_vars/matrix.example.com/vars.yml` file as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:33
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:35
|
||||
msgid "There are some additional things you may wish to configure about the server."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:37
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:39
|
||||
msgid "`roles/custom/matrix-continuwuity/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:40
|
||||
msgid "`roles/custom/matrix-continuwuity/templates/continuwuity.toml.j2` for the server's default configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:42
|
||||
msgid "There are various Ansible variables that control settings in the `continuwuity.toml` file."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:44
|
||||
msgid "If a specific setting you'd like to change does not have a dedicated Ansible variable, you can either submit a PR to us to add it, or you can [override the setting using an environment variable](https://continuwuity.org/configuration#environment-variables) using `matrix_continuwuity_environment_variables_extension`. For example:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:52
|
||||
msgid "Creating the first user account"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:54
|
||||
msgid "Unlike other homeserver implementations (like Synapse and Dendrite), continuwuity does not support creating users via the command line or via the playbook."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:56
|
||||
msgid "If you followed the instructions above (see [Adjusting the playbook configuration](#adjusting-the-playbook-configuration)), you should have registration enabled and protected by a registration token."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:58
|
||||
msgid "This should allow you to create the first user account via any client (like [Element Web](./configuring-playbook-client-element-web.md)) which supports creating users."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:60
|
||||
msgid "The **first user account that you create will be marked as an admin** and **will be automatically invited to an admin room**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:63
|
||||
msgid "Configuring bridges / appservices"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:65
|
||||
msgid "For other homeserver implementations (like Synapse and Dendrite), the playbook automatically registers appservices (for bridges, bots, etc.) with the homeserver."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:67
|
||||
msgid "For continuwuity, you will have to manually register appservices using the [`!admin appservices register` command](https://continuwuity.org/appservices#set-up-the-appservice---general-instructions) sent to the server bot account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:69
|
||||
msgid "The server's bot account has a Matrix ID of `@conduit:example.com` (not `@continuwuity:example.com`!) due to continuwuity's historical legacy. Your first user account would already have been invited to an admin room with this bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:72
|
||||
msgid "Find the appservice file you'd like to register. This can be any `registration.yaml` file found in the `/matrix` directory, for example `/matrix/mautrix-signal/bridge/registration.yaml`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-continuwuity.md:74
|
||||
msgid "Then, send its content to the existing admin room:"
|
||||
msgstr ""
|
||||
@@ -435,7 +435,7 @@ msgid "We **don't** ask you to [run the `syn2mas` migration advisor command](htt
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-authentication-service.md:340
|
||||
msgid "You can invoke the `syn2mas` tool via the playbook by running the playbook's `matrix-authentication-service-syn2mas` tag. We recommend first doing a [dry-run](#performing-a-syn2mas-dry-run) and then a [real migration](#performing-a-real-syn2mas-migration)."
|
||||
msgid "You can invoke the `syn2mas` tool via the playbook by running the playbook's `matrix-authentication-service-mas-cli-syn2mas` tag. We recommend first doing a [dry-run](#performing-a-syn2mas-dry-run) and then a [real migration](#performing-a-real-syn2mas-migration)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-authentication-service.md:342
|
||||
@@ -535,7 +535,7 @@ msgid "you've performed a [syn2mas dry-run](#performing-a-syn2mas-dry-run) and d
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-authentication-service.md:401
|
||||
msgid "To perform a real migration, run the `matrix-authentication-service-syn2mas` tag **without** the `matrix_authentication_service_syn2mas_dry_run` variable:"
|
||||
msgid "To perform a real migration, run the `matrix-authentication-service-mas-cli-syn2mas` tag **without** the `matrix_authentication_service_syn2mas_migrate_dry_run` variable:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-authentication-service.md:407
|
||||
|
||||
@@ -434,7 +434,7 @@ msgid "We **don't** ask you to [run the `syn2mas` migration advisor command](htt
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-authentication-service.md:340
|
||||
msgid "You can invoke the `syn2mas` tool via the playbook by running the playbook's `matrix-authentication-service-syn2mas` tag. We recommend first doing a [dry-run](#performing-a-syn2mas-dry-run) and then a [real migration](#performing-a-real-syn2mas-migration)."
|
||||
msgid "You can invoke the `syn2mas` tool via the playbook by running the playbook's `matrix-authentication-service-mas-cli-syn2mas` tag. We recommend first doing a [dry-run](#performing-a-syn2mas-dry-run) and then a [real migration](#performing-a-real-syn2mas-migration)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-authentication-service.md:342
|
||||
@@ -534,7 +534,7 @@ msgid "you've performed a [syn2mas dry-run](#performing-a-syn2mas-dry-run) and d
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-authentication-service.md:401
|
||||
msgid "To perform a real migration, run the `matrix-authentication-service-syn2mas` tag **without** the `matrix_authentication_service_syn2mas_dry_run` variable:"
|
||||
msgid "To perform a real migration, run the `matrix-authentication-service-mas-cli-syn2mas` tag **without** the `matrix_authentication_service_syn2mas_migrate_dry_run` variable:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-authentication-service.md:407
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
alabaster==1.0.0
|
||||
babel==2.17.0
|
||||
certifi==2025.1.31
|
||||
charset-normalizer==3.4.1
|
||||
click==8.1.8
|
||||
docutils==0.21.2
|
||||
idna==3.10
|
||||
certifi==2025.11.12
|
||||
charset-normalizer==3.4.4
|
||||
click==8.3.1
|
||||
docutils==0.22.3
|
||||
idna==3.11
|
||||
imagesize==1.4.1
|
||||
Jinja2==3.1.6
|
||||
linkify-it-py==2.0.3
|
||||
markdown-it-py==3.0.0
|
||||
MarkupSafe==3.0.2
|
||||
mdit-py-plugins==0.4.2
|
||||
markdown-it-py==4.0.0
|
||||
MarkupSafe==3.0.3
|
||||
mdit-py-plugins==0.5.0
|
||||
mdurl==0.1.2
|
||||
myst-parser==4.0.1
|
||||
packaging==24.2
|
||||
Pygments==2.19.1
|
||||
PyYAML==6.0.2
|
||||
requests==2.32.3
|
||||
setuptools==78.1.0
|
||||
snowballstemmer==2.2.0
|
||||
Sphinx==8.2.3
|
||||
sphinx-intl==2.3.1
|
||||
sphinx-markdown-builder==0.6.8
|
||||
packaging==25.0
|
||||
Pygments==2.19.2
|
||||
PyYAML==6.0.3
|
||||
requests==2.32.5
|
||||
setuptools==80.9.0
|
||||
snowballstemmer==3.0.1
|
||||
Sphinx==9.0.4
|
||||
sphinx-intl==2.3.2
|
||||
sphinx-markdown-builder==0.6.9
|
||||
sphinxcontrib-applehelp==2.0.0
|
||||
sphinxcontrib-devhelp==2.0.0
|
||||
sphinxcontrib-htmlhelp==2.1.0
|
||||
@@ -30,4 +30,4 @@ sphinxcontrib-qthelp==2.0.0
|
||||
sphinxcontrib-serializinghtml==2.0.0
|
||||
tabulate==0.9.0
|
||||
uc-micro-py==1.0.3
|
||||
urllib3==2.3.0
|
||||
urllib3==2.6.1
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -17,7 +17,7 @@ msgstr ""
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../README.md:1
|
||||
msgid "[](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com) [](https://liberapay.com/s.pantaleev/donate)"
|
||||
msgid "[](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com) [](https://liberapay.com/s.pantaleev/donate) [](https://api.reuse.software/info/github.com/spantaleev/matrix-docker-ansible-deploy)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:1
|
||||
@@ -28,6 +28,10 @@ msgstr ""
|
||||
msgid "donate"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:1
|
||||
msgid "REUSE status"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:3
|
||||
msgid "Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker"
|
||||
msgstr ""
|
||||
@@ -184,6 +188,18 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-conduwuit.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[continuwuity](https://continuwuity.org)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Storing your data and managing your presence in the [Matrix](http://matrix.org/) network. continuwuity is a continuation of conduwuit."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-continuwuity.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Dendrite](https://github.com/element-hq/dendrite)"
|
||||
msgstr ""
|
||||
@@ -196,11 +212,11 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-dendrite.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:58
|
||||
#: ../../../README.md:59
|
||||
msgid "Clients"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:60
|
||||
#: ../../../README.md:61
|
||||
msgid "Web clients for Matrix that you can host on your own domains."
|
||||
msgstr ""
|
||||
|
||||
@@ -252,11 +268,23 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-client-schildichat-web.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:69
|
||||
msgid "Server Components"
|
||||
#: ../../../README.md:0
|
||||
msgid "[FluffyChat Web](https://fluffychat.im/)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "The cutest messenger in Matrix"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-client-fluffychat-web.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:71
|
||||
msgid "Server Components"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:73
|
||||
msgid "Services that run on the server to make the various parts of your installation work."
|
||||
msgstr ""
|
||||
|
||||
@@ -289,7 +317,7 @@ msgid "[Traefik](https://doc.traefik.io/traefik/)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Web server, listening on ports 80, 443 and 8448 - standing in front of all the other services. Using your own webserver [is possible](docs/configuring-playbook-own-webserver.md)"
|
||||
msgid "Web server, listening on ports 80, 443 and 8448 - standing in front of all the other services. [Using your own webserver](docs/configuring-playbook-own-webserver.md) is also possible."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -344,11 +372,35 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-dynamic-dns.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:83
|
||||
#: ../../../README.md:0
|
||||
msgid "[LiveKit Server](https://github.com/livekit/livekit)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "WebRTC server for audio/video calls"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-livekit-server.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Livekit JWT Service](https://github.com/livekit/livekit-jwt-service)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "JWT service for integrating [Element Call](./configuring-playbook-element-call.md) with [LiveKit Server](./configuring-playbook-livekit-server.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-livekit-jwt-service.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:87
|
||||
msgid "Authentication"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:85
|
||||
#: ../../../README.md:89
|
||||
msgid "Extend and modify how users are authenticated on your homeserver."
|
||||
msgstr ""
|
||||
|
||||
@@ -393,7 +445,7 @@ msgid "[matrix-ldap-registration-proxy](https://gitlab.com/activism.internationa
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "A proxy that handles Matrix registration requests and forwards them to LDAP."
|
||||
msgid "Proxy that handles Matrix registration requests and forwards them to LDAP"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -405,7 +457,7 @@ msgid "[matrix-registration](https://github.com/ZerataX/matrix-registration)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "A simple python application to have a token based Matrix registration"
|
||||
msgid "Simple python application to have a token based Matrix registration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -413,7 +465,7 @@ msgid "[Link](docs/configuring-playbook-matrix-registration.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) (UVS)"
|
||||
msgid "[Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -429,18 +481,18 @@ msgid "[synapse-simple-antispam](https://github.com/t2bot/synapse-simple-antispa
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "A spam checker module"
|
||||
msgid "Spam checker module"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-synapse-simple-antispam.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:97
|
||||
#: ../../../README.md:101
|
||||
msgid "File Storage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:99
|
||||
#: ../../../README.md:103
|
||||
msgid "Use alternative file storage to the default `media_store` folder."
|
||||
msgstr ""
|
||||
|
||||
@@ -469,18 +521,18 @@ msgid "[matrix-media-repo](https://github.com/turt2live/matrix-media-repo)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "matrix-media-repo is a highly customizable multi-domain media repository for Matrix. Intended for medium to large deployments, this media repo de-duplicates media while being fully compliant with the specification."
|
||||
msgid "Highly customizable multi-domain media repository for Matrix. Intended for medium to large deployments, this media repo de-duplicates media while being fully compliant with the specification."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-matrix-media-repo.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:107
|
||||
#: ../../../README.md:111
|
||||
msgid "Bridges"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:109
|
||||
#: ../../../README.md:113
|
||||
msgid "Bridges can be used to connect your Matrix installation with third-party communication networks."
|
||||
msgstr ""
|
||||
|
||||
@@ -556,6 +608,18 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-bridge-mautrix-wsproxy.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[mautrix-bluesky](https://github.com/mautrix/bluesky)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Bridge to [Bluesky](https://bsky.social/)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-bridge-mautrix-bluesky.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[mautrix-twitter](https://github.com/mautrix/twitter)"
|
||||
msgstr ""
|
||||
@@ -684,6 +748,18 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-bridge-matrix-bridge-sms.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Bridge to [Steam](https://steampowered.com/)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-bridge-steam.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[matrix-wechat](https://github.com/duo/matrix-wechat)"
|
||||
msgstr ""
|
||||
@@ -708,62 +784,6 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-bridge-heisenbridge.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[go-skype-bridge](https://github.com/kelaresg/go-skype-bridge)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Bridge to [Skype](https://www.skype.com)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-bridge-go-skype-bridge.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Bridge to [Slack](https://slack.com)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-bridge-mx-puppet-slack.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Bridge for Instagram-DMs ([Instagram](https://www.instagram.com/))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-bridge-mx-puppet-instagram.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[mx-puppet-twitter](https://github.com/Sorunome/mx-puppet-twitter)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Bridge for Twitter-DMs ([Twitter](https://twitter.com/))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-bridge-mx-puppet-twitter.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-bridge-mx-puppet-discord.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[mx-puppet-groupme](https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme)"
|
||||
msgstr ""
|
||||
@@ -777,7 +797,7 @@ msgid "[Link](docs/configuring-playbook-bridge-mx-puppet-groupme.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam)"
|
||||
msgid "[mx-puppet-steam](https://codeberg.org/icewind/mx-puppet-steam)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -800,11 +820,11 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-bridge-postmoogle.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:141
|
||||
#: ../../../README.md:142
|
||||
msgid "Bots"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:143
|
||||
#: ../../../README.md:144
|
||||
msgid "Bots provide various additional functionality to your installation."
|
||||
msgstr ""
|
||||
|
||||
@@ -813,7 +833,7 @@ msgid "[baibot](https://github.com/etkecc/baibot)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "A bot that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you"
|
||||
msgid "Bot that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -849,7 +869,7 @@ msgid "[maubot](https://github.com/maubot/maubot)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "A plugin-based Matrix bot system"
|
||||
msgid "Plugin-based Matrix bot system"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -861,7 +881,7 @@ msgid "[Honoroit](https://github.com/etkecc/honoroit)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "A helpdesk bot"
|
||||
msgid "Helpdesk bot"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -873,7 +893,7 @@ msgid "[Mjolnir](https://github.com/matrix-org/mjolnir)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "A moderation tool for Matrix"
|
||||
msgid "Moderation tool for Matrix"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -885,7 +905,7 @@ msgid "[Draupnir](https://github.com/the-draupnir-project/Draupnir)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "A moderation tool for Matrix (Fork of Mjolnir)"
|
||||
msgid "Moderation tool for Matrix (Fork of Mjolnir)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -904,11 +924,11 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-bot-buscarron.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:156
|
||||
#: ../../../README.md:157
|
||||
msgid "Administration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:158
|
||||
#: ../../../README.md:159
|
||||
msgid "Services that help you in administrating and monitoring your Matrix installation."
|
||||
msgstr ""
|
||||
|
||||
@@ -941,7 +961,7 @@ msgid "[synapse-admin](https://github.com/etkecc/synapse-admin)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "A web UI tool for administrating users and rooms on your Matrix server"
|
||||
msgid "Web UI tool for administrating users and rooms on your Matrix server"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -957,7 +977,7 @@ msgid "Consists of the [Prometheus](https://prometheus.io) time-series database
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-prometheus-grafana.md) (for [prometheus-nginxlog-exporter](docs/configuring-playbook-prometheus-nginxlog.md))"
|
||||
msgid "[Link](docs/configuring-playbook-prometheus-grafana.md) (for [prometheus-nginxlog-exporter](docs/configuring-playbook-prometheus-grafana.md#enable-metrics-and-graphs-for-nginx-logs-optional))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -996,11 +1016,11 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-synapse-usage-exporter.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:170
|
||||
#: ../../../README.md:171
|
||||
msgid "Misc"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:172
|
||||
#: ../../../README.md:173
|
||||
msgid "Various services that don't fit any other categories."
|
||||
msgstr ""
|
||||
|
||||
@@ -1021,7 +1041,7 @@ msgid "[synapse_auto_accept_invite](https://github.com/matrix-org/synapse-auto-a
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "A Synapse module to automatically accept invites."
|
||||
msgid "Synapse module to automatically accept invites"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -1033,7 +1053,7 @@ msgid "[synapse_auto_compressor](https://github.com/matrix-org/rust-synapse-comp
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "A cli tool that automatically compresses `state_groups` database table in background."
|
||||
msgid "Cli tool that automatically compresses `state_groups` database table in background"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -1057,7 +1077,7 @@ msgid "[Etherpad](https://etherpad.org)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "An open source collaborative text editor"
|
||||
msgid "Open source collaborative text editor"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -1069,7 +1089,7 @@ msgid "[Jitsi](https://jitsi.org/)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "An open source video-conferencing platform"
|
||||
msgid "Open source video-conferencing platform"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -1081,7 +1101,7 @@ msgid "[Cactus Comments](https://cactus.chat)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "A federated comment system built on Matrix"
|
||||
msgid "Federated comment system built on Matrix"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -1093,7 +1113,7 @@ msgid "[Pantalaimon](https://github.com/matrix-org/pantalaimon)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "An E2EE aware proxy daemon"
|
||||
msgid "E2EE aware proxy daemon"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -1124,54 +1144,66 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-ntfy.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:187
|
||||
msgid "🆕 Changes"
|
||||
#: ../../../README.md:0
|
||||
msgid "[Element Call](https://github.com/element-hq/element-call)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "A native Matrix video conferencing application"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-element-call.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:189
|
||||
msgid "This playbook evolves over time, sometimes with backward-incompatible changes."
|
||||
msgid "🆕 Changes"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:191
|
||||
msgid "When updating the playbook, refer to [the changelog](CHANGELOG.md) to catch up with what's new."
|
||||
msgid "This playbook evolves over time, sometimes with backward-incompatible changes."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:193
|
||||
msgid "🆘 Support"
|
||||
msgid "When updating the playbook, refer to [the changelog](CHANGELOG.md) to catch up with what's new."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:195
|
||||
msgid "Matrix room: [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com)"
|
||||
msgid "🆘 Support"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:197
|
||||
msgid "IRC channel: `#matrix-docker-ansible-deploy` on the [Libera Chat](https://libera.chat/) IRC network (irc.libera.chat:6697)"
|
||||
msgid "Matrix room: [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:199
|
||||
msgid "GitHub issues: [spantaleev/matrix-docker-ansible-deploy/issues](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues)"
|
||||
msgid "IRC channel: `#matrix-docker-ansible-deploy` on the [Libera Chat](https://libera.chat/) IRC network (irc.libera.chat:6697)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:201
|
||||
msgid "🌐 Translation"
|
||||
msgid "GitHub issues: [spantaleev/matrix-docker-ansible-deploy/issues](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:203
|
||||
msgid "See the [i18n/README.md](i18n/README.md) file for more information about translation."
|
||||
msgid "🌐 Translation"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:205
|
||||
msgid "Translations are still work in progress."
|
||||
msgid "See the [i18n/README.md](i18n/README.md) file for more information about translation."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:207
|
||||
msgid "🤝 Related"
|
||||
msgid "Translations are still work in progress."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:209
|
||||
msgid "You may also be interested in [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) - another Ansible playbook for self-hosting non-Matrix services (see its [List of supported services](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/supported-services.md))."
|
||||
msgid "🤝 Related"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:211
|
||||
msgid "You may also be interested in [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) - another Ansible playbook for self-hosting non-Matrix services (see its [List of supported services](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/supported-services.md))."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:213
|
||||
msgid "mash-playbook also makes use of [Traefik](./docs/configuring-playbook-traefik.md) as its reverse-proxy, so with minor [interoperability adjustments](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/interoperability.md), you can make matrix-docker-ansible-deploy and mash-playbook co-exist and host Matrix and non-Matrix services on the same server."
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,274 +16,274 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:1
|
||||
#: ../../../YEAR-IN-REVIEW.md:8
|
||||
msgid "2023"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:3
|
||||
#: ../../../YEAR-IN-REVIEW.md:10
|
||||
msgid "2023 was a year filled with many changes for matrix-docker-ansible-deploy. In this post, we're looking backward at some of the major changes that happened this year, as well as taking a glimpse of what's ahead in 2024."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:5
|
||||
#: ../../../YEAR-IN-REVIEW.md:12
|
||||
msgid "2023 is probably [the year of AI](https://journal.everypixel.com/2023-the-year-of-ai), with millions of people jumping aboard [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/chatgpt) train. matrix-docker-ansible-deploy is no stranger to this and 2023 began with a PR from [bertybuttface](https://github.com/bertybuttface) who added support for [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#chatgpt-support)). While OpenAI's chat GPT website was frequently overloaded in the past, their API was up which made using this bot both convenient and more reliable."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:7
|
||||
msgid "AI aside, with the playbook's focus being containers, we're **doubling down on being \"container native\"** and becoming more interoperable for people hosting other containers on the Matrix server. In [2022](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/YEAR-IN-REVIEW.md#2022), we've announced a few sibling Ansible playbooks, their use of [Traefik](https://doc.traefik.io/traefik/) and the possiblity of matrix-docker-ansible-deploy also switching to this reverse-proxy. This prediction materialized quickly. The **largest change** in the playbook in 2023 happened way back in February - matrix-docker-ansible-deploy [starting the switch from nginx to Traefik](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#backward-compatibility-reverse-proxy-configuration-changes-and-initial-traefik-support) and then quickly [making Treafik the default reverse-proxy](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#traefik-is-the-default-reverse-proxy-now). As noted in the changelog entries, we envisioned a quick and complete elimination of `matrix-nginx-proxy`, but at the end of 2023, it hasn't happened yet. The playbook is already using Traefik as the front-most reverse-proxy, but nginx (via `matrix-nginx-proxy`) is still around - it has taken a step back and is only used internally for new setups. Work got to a stall due to:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:9
|
||||
msgid "complexity: untangling the overly large and messy `matrix-nginx-proxy` component is difficult"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:10
|
||||
msgid "the current setup became \"good enough\" because nginx has become an internal implementation detail for those who have migrated to Traefik. Traefik is already the default public reverse-proxy and gives better possibilities to people wishing to run other web-exposed containers on their Matrix server via [Docker Compose](https://docs.docker.com/compose/), other Ansible playbooks like [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) (more about this one, below) or any other way."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:12
|
||||
msgid "`matrix-nginx-proxy` is no longer in the way of us being interoperable, but its ugly internal details are still there. It is one more proxy in the long chain of reverse-proxies we have and we'd like to cut it out. This would both make things simpler and also boost performance."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:14
|
||||
msgid "The delay in eliminating `matrix-nginx-proxy` has probably been welcome by many existing users who decided to postpone the Traefik migration a bit longer. In 2024, work on eliminating `matrix-nginx-proxy` will continue with rapid pace. People who are still using `matrix-nginx-proxy` as their front-most reverse-proxy will need to rework their setup. About a year of putting it off has been long enough."
|
||||
msgid "AI aside, with the playbook's focus being containers, we're **doubling down on being \"container native\"** and becoming more interoperable for people hosting other containers on the Matrix server. In [2022](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/YEAR-IN-REVIEW.md#2022), we've announced a few sibling Ansible playbooks, their use of [Traefik](https://doc.traefik.io/traefik/) and the possibility of matrix-docker-ansible-deploy also switching to this reverse-proxy. This prediction materialized quickly. The **largest change** in the playbook in 2023 happened way back in February - matrix-docker-ansible-deploy [starting the switch from nginx to Traefik](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#backward-compatibility-reverse-proxy-configuration-changes-and-initial-traefik-support) and then quickly [making Treafik the default reverse-proxy](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#traefik-is-the-default-reverse-proxy-now). As noted in the changelog entries, we envisioned a quick and complete elimination of `matrix-nginx-proxy`, but at the end of 2023, it hasn't happened yet. The playbook is already using Traefik as the front-most reverse-proxy, but nginx (via `matrix-nginx-proxy`) is still around - it has taken a step back and is only used internally for new setups. Work got to a stall due to:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:16
|
||||
msgid "complexity: untangling the overly large and messy `matrix-nginx-proxy` component is difficult"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:17
|
||||
msgid "the current setup became \"good enough\" because nginx has become an internal implementation detail for those who have migrated to Traefik. Traefik is already the default public reverse-proxy and gives better possibilities to people wishing to run other web-exposed containers on their Matrix server via [Docker Compose](https://docs.docker.com/compose/), other Ansible playbooks like [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) (more about this one, below) or any other way."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:19
|
||||
msgid "`matrix-nginx-proxy` is no longer in the way of us being interoperable, but its ugly internal details are still there. It is one more proxy in the long chain of reverse-proxies we have and we'd like to cut it out. This would both make things simpler and also boost performance."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:21
|
||||
msgid "The delay in eliminating `matrix-nginx-proxy` has probably been welcome by many existing users who decided to postpone the Traefik migration a bit longer. In 2024, work on eliminating `matrix-nginx-proxy` will continue with rapid pace. People who are still using `matrix-nginx-proxy` as their front-most reverse-proxy will need to rework their setup. About a year of putting it off has been long enough."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:23
|
||||
msgid "This large Traefik reverse-proxy change was also accompanied by another internal change which began in 2022, but continued in 2023 - **moving non-Matrix-related roles from being internal to the playbook to living their own life outside of it**. Various roles were made more decoupled and moved outside of the playbook, so that other projects (like the [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) Ansible playbook or other Ansible playbooks) could benefit from them. This led to the **death of a few sibling playbooks** ([gitea-docker-ansible-deploy](https://github.com/spantaleev/gitea-docker-ansible-deploy), [nextcloud-docker-ansible-deploy](https://github.com/spantaleev/nextcloud-docker-ansible-deploy), [peertube-docker-ansible-deploy](https://github.com/spantaleev/peertube-docker-ansible-deploy), [vaultwarden-docker-ansible-deploy](https://github.com/spantaleev/vaultwarden-docker-ansible-deploy)), but brought life to something better, which supports all these services and more."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:18
|
||||
#: ../../../YEAR-IN-REVIEW.md:25
|
||||
msgid "[mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) is a new Ansible playbook that a few of us (matrix-docker-ansible-deploy contributors) have launched in 2023. It has quickly grown to supports [60+ services](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/supported-services.md) and aims to do the same for [FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) service hosting, as matrix-docker-ansible-deploy has done for Matrix - providing a clean and secure way to run a bunch of services in containers on a regular server (that is to say, without Kubernetes, etc.). Thanks to Traefik and Ansible role reuse, it's easy to host both mash-playbook services and matrix-docker-ansible-deploy services on the same server - see mash-playbook's [interoperability](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/interoperability.md) documentation page. If you've been looking for a holiday project or your New Year's Resolutions list contains \"self-hosting more services\", then you're welcome to give this new playbook a try and join its Matrix room ([#mash-playbook:devture.com](https://matrix.to/#/#mash-playbook:devture.com))."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:20
|
||||
#: ../../../YEAR-IN-REVIEW.md:27
|
||||
msgid "Because many of the roles are now external to this playbook (defined in the [requirements.yml](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/da27655ef34999fa924bc0a5e641dbd9ba06f133/requirements.yml) file), running `make roles` (or better yet `just roles` via the [just tool](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#support-for-running-commands-via-just)) becomes a necessity each time one pulls playbook updates (`git pull`). Pulling external roles happens via the [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) command-line tool, but if available, the playbook would also use the much faster [agru](https://github.com/etkecc/agru) tool (developed by [Aine](https://gitlab.com/etke.cc) from [etke.cc](https://etke.cc/) this year)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:22
|
||||
#: ../../../YEAR-IN-REVIEW.md:29
|
||||
msgid "With the internal (but important) details out of the way, we can now talk more about **new features that landed in matrix-docker-ansible-deploy in 2023**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:24
|
||||
#: ../../../YEAR-IN-REVIEW.md:31
|
||||
msgid "The following **new** **bridges** were added to the playbook in 2023:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:26
|
||||
#: ../../../YEAR-IN-REVIEW.md:33
|
||||
msgid "(2023-01-11) [mautrix-slack](https://mau.dev/mautrix/slack), thanks to a PR by [Cody Neiman](https://github.com/xangelix) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#mautrix-slack-support))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:27
|
||||
#: ../../../YEAR-IN-REVIEW.md:34
|
||||
msgid "(2023-07-21) [mautrix-gmessages](https://github.com/mautrix/gmessages), thanks to a PR by [Shreyas Ajjarapu](https://github.com/shreyasajj) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#mautrix-gmessages-support))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:28
|
||||
#: ../../../YEAR-IN-REVIEW.md:35
|
||||
msgid "(2023-08-23) [mautrix-wsproxy](https://github.com/mautrix/wsproxy) for Apple iMessage bridging (when combined with the [mautrix-imessage](https://github.com/mautrix/imessage) bridge running on your Mac or Android phone), thanks to a PR by [Johan Swetzén](https://github.com/jswetzen)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:30
|
||||
#: ../../../YEAR-IN-REVIEW.md:37
|
||||
msgid "This brings the total number of **[bridges that the playbook supports](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/docs/configuring-playbook.md#bridging-other-networks) up to 30**. There are alternative bridge implementations for various networks and protocols, so the number of \"unique bridged networks\" is surely much smaller."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:32
|
||||
#: ../../../YEAR-IN-REVIEW.md:39
|
||||
msgid "A few other **major components and changes** landed in 2023:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:34
|
||||
#: ../../../YEAR-IN-REVIEW.md:41
|
||||
msgid "(2023-02-10) The [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation tool (successor to [Mjolnir](https://github.com/matrix-org/mjolnir)), thanks to a PR by [FSG-Cat](https://github.com/FSG-Cat) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#draupnir-moderation-tool-bot-support))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:35
|
||||
#: ../../../YEAR-IN-REVIEW.md:42
|
||||
msgid "(2023-02-10) [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) to add Matrix Authentication Support to our Jitsi setup, thanks to a PR by [Jakob S.](https://github.com/jakicoll) from [zakk gGmbH](https://github.com/zakk-it) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#matrix-authentication-support-for-jitsi))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:36
|
||||
#: ../../../YEAR-IN-REVIEW.md:43
|
||||
msgid "(2023-02-25) The [rageshake](https://github.com/matrix-org/rageshake) bug report server, thanks to a PR by [Benjamin Kampmann](https://github.com/gnunicorn) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#rageshake-support))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:37
|
||||
#: ../../../YEAR-IN-REVIEW.md:44
|
||||
msgid "(2023-03-07) [Sliding Sync proxy](https://github.com/matrix-org/sliding-sync) (currently a necessary component for [Element X](https://element.io/labs/element-x) to work), thanks to: [Benjamin Kampmann](https://github.com/gnunicorn) and [FSG-Cat](https://github.com/FSG-Cat) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#sliding-sync-proxy-element-x-support))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:38
|
||||
#: ../../../YEAR-IN-REVIEW.md:45
|
||||
msgid "(2023-03-12) synapse-auto-compressor to periodically and automatically run [rust-synapse-compress-state](https://github.com/matrix-org/rust-synapse-compress-state), thanks to a PR by [Aine](https://gitlab.com/etke.cc) from [etke.cc](https://etke.cc/) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#synapse-auto-compressor-support))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:39
|
||||
#: ../../../YEAR-IN-REVIEW.md:46
|
||||
msgid "(2023-07-17) [matrix-media-repo](https://github.com/turt2live/matrix-media-repo), thanks to a PR by [Michael Hollister](https://github.com/Michael-Hollister) from [FUTO](https://www.futo.org/), the creators of the [Circles app](https://circu.li/) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#matrix-media-repo-support))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:40
|
||||
#: ../../../YEAR-IN-REVIEW.md:47
|
||||
msgid "(2023-08-31) [SchildiChat Web](https://github.com/SchildiChat/schildichat-desktop) client app (fork of [Element Web)](https://github.com/element-hq/element-web), thanks to a PR by [Aine](https://gitlab.com/etke.cc) from [etke.cc](https://etke.cc/) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#schildichat-support))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:41
|
||||
#: ../../../YEAR-IN-REVIEW.md:48
|
||||
msgid "(2023-10-18) Postgres parameters auto-tuning, thanks to a PR by [Aine](https://gitlab.com/etke.cc) from [etke.cc](https://etke.cc/) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#postgres-parameters-are-automatically-tuned-now))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:42
|
||||
#: ../../../YEAR-IN-REVIEW.md:49
|
||||
msgid "(2023-10-23) Enabling federation of the room directory for Synapse (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#enabling-allow_public_rooms_over_federation-by-default-for-synapse))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:44
|
||||
#: ../../../YEAR-IN-REVIEW.md:51
|
||||
msgid "The most recent change in the list above (Enabling federation of the room directory for Synapse) has been somewhat **controversial** as it goes against upstream defaults for Synapse. Nevertheless, we believe it **promotes the well-being of the Matrix Federation by improving room discovery**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:46
|
||||
#: ../../../YEAR-IN-REVIEW.md:53
|
||||
msgid "**Matrix Federation Stats** (containing the percentage of servers publishing their room directory publicly) are posted to [TWIM](https://matrix.org/category/this-week-in-matrix/) each week by [Aine](https://gitlab.com/etke.cc) from [etke.cc](https://etke.cc/). The number of servers which [currently published their room directory publicly](https://matrix.org/blog/2023/12/2/this-week-in-matrix-2023-12-22/#matrix-federation-stats) stands at `26.6%`, which is:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:48
|
||||
#: ../../../YEAR-IN-REVIEW.md:55
|
||||
msgid "**2.4% more** than when it was when [first published to TWIM](https://matrix.org/blog/2023/11/03/this-week-in-matrix-2023-11-03/#matrix-federation-stats) (1 month earlier, in November)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:49
|
||||
#: ../../../YEAR-IN-REVIEW.md:56
|
||||
msgid "likely about **15+% more** than from before we flipped the switch (in October)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:51
|
||||
#: ../../../YEAR-IN-REVIEW.md:58
|
||||
msgid "Hopefully, Synapse defaults would also change the same way and we'd see the number of servers publicly listing their room directory grow faster."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:53
|
||||
#: ../../../YEAR-IN-REVIEW.md:60
|
||||
msgid "With this configuration change in place, projects like [MatrixRooms.info](https://matrixrooms.info/) (made by [etke.cc](https://etke.cc/)) and potentially others in the future, can discover, index the metadata (room address, title, topic, number of users, etc.) and make public rooms browsable & searchable across the whole Matrix Federation. It'd be great if users joining Matrix could more easily find interesting communities that match their interests!"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:55
|
||||
#: ../../../YEAR-IN-REVIEW.md:62
|
||||
msgid "On the **media side of things**, besides Jitsi getting better Matrix integration (via the aforementioned Matrix User Verification Service), we've also had some [coturn security tightening](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#backward-compatibility-tightening-coturn-security-can-lead-to-connectivity-issues) as well as [performance optimizations](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#coturn-can-now-use-host-networking) for configurations exposing lots of network ports."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:57
|
||||
#: ../../../YEAR-IN-REVIEW.md:64
|
||||
msgid "[Element Call](https://github.com/element-hq/element-call) seems to have become a nice and polished product lately (as proclaimed in [The Matrix Holiday Update 2023](https://matrix.org/blog/2023/12/25/the-matrix-holiday-update-2023/)), so 2024 is likely the year we'll see support for it in the playbook. Element Call depends on the [LiveKit](https://livekit.io/) streaming server (which is also useful to developers even by itself), so the first step is likely to see LiveKit support in mash-playbook via a reusable Ansible role. Such a LiveKit Ansible role could later easily land in matrix-docker-ansible-deploy and an Element Call static website could be hooked to it."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:59
|
||||
#: ../../../YEAR-IN-REVIEW.md:66
|
||||
msgid "Besides these highlights, there were many other relatively large changes announced in our [CHANGELOG](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md) and hundreds of other more minor (but still important) playbook changes that didn't get a mention."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:61
|
||||
#: ../../../YEAR-IN-REVIEW.md:68
|
||||
msgid "We have **hundreds of contributors to thank for their hard work** on making Matrix self-hosting better for all of us! It should be noted that **support comes in many shapes**, not only in raw code commits and financial help (via [donations](https://liberapay.com/s.pantaleev) or using the [etke.cc managed Matrix hosting service](https://etke.cc/) which is based on matrix-docker-ansible-deploy). It also comes in the shape of code reviews, helping others with [issues](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues), reporting new issues, participating in our support room on Matrix ([#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com)), etc. To everyone who has been there to make matrix-docker-ansible-deploy better in 2023, thank you! 🙇♂️"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:64
|
||||
#: ../../../YEAR-IN-REVIEW.md:71
|
||||
msgid "2022"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:66
|
||||
#: ../../../YEAR-IN-REVIEW.md:73
|
||||
msgid "For [matrix-docker-ansible-deploy](https://github.com/spantaleev/matrix-docker-ansible-deploy/), 2022 started with **breaking the** [**Synapse**](https://github.com/element-hq/synapse) **monopoly** by [adding support](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#dendrite-support) for the [Dendrite](https://github.com/matrix-org/dendrite) Matrix homeserver in early January. This required various internal changes so that the [Ansible](https://www.ansible.com/) playbook would not be Synapse-centric anymore. This groundwork paved the way for continuing in this direction and we [added support](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#conduit-support) for [Conduit](https://conduit.rs/) in August."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:68
|
||||
#: ../../../YEAR-IN-REVIEW.md:75
|
||||
msgid "When it comes to the `matrix-docker-ansible-deploy` Ansible playbook, 2022 was the year of the non-Synapse homeserver implementation. In practice, none of these homeserver implementations seem ready for prime-time yet and there is no migration path when coming from Synapse. Having done our job of adding support for these alternative homeserver implementations, we can say that we're not getting in the way of future progress. It's time for the Dendrite developers to push harder (development-wise) and for the Synapse developers to take a well-deserved long (infinite) break, and we may get to see more people migrating away from Synapse in the next year(s)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:70
|
||||
#: ../../../YEAR-IN-REVIEW.md:77
|
||||
msgid "Support for the following new **bridges** was added:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:72
|
||||
#: ../../../YEAR-IN-REVIEW.md:79
|
||||
msgid "[Postmoogle](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#postmoogle-email-bridge-support) for bi-directional email bridging, which supersedes my old and simplistic [Email2Matrix](https://github.com/devture/email2matrix) one-way bridge-bot"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:73
|
||||
#: ../../../YEAR-IN-REVIEW.md:80
|
||||
msgid "[mautrix-discord](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#mautrix-discord-support)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:74
|
||||
#: ../../../YEAR-IN-REVIEW.md:81
|
||||
msgid "[go-skype-bridge](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#go-skype-bridge-bridging-support)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:75
|
||||
#: ../../../YEAR-IN-REVIEW.md:82
|
||||
msgid "[matrix-appservice-kakaotalk](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#matrix-appservice-kakaotalk-support)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:77
|
||||
#: ../../../YEAR-IN-REVIEW.md:84
|
||||
msgid "Support for the following new **bots** was added:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:79
|
||||
#: ../../../YEAR-IN-REVIEW.md:86
|
||||
msgid "[buscarron bot](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#buscarron-bot-support)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:80
|
||||
#: ../../../YEAR-IN-REVIEW.md:87
|
||||
msgid "[Honoroit bot](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#honoroit-bot-support)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:81
|
||||
#: ../../../YEAR-IN-REVIEW.md:88
|
||||
msgid "[matrix-registration-bot](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#matrix-registration-bot-support)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:82
|
||||
#: ../../../YEAR-IN-REVIEW.md:89
|
||||
msgid "[matrix-hookshot](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#matrix-hookshot-bridging-support)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:83
|
||||
#: ../../../YEAR-IN-REVIEW.md:90
|
||||
msgid "[maubot](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#maubot-support)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:85
|
||||
#: ../../../YEAR-IN-REVIEW.md:92
|
||||
msgid "Support for the following new **components and services** was added:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:87
|
||||
#: ../../../YEAR-IN-REVIEW.md:94
|
||||
msgid "[BorgBackup](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#borg-backup-support)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:88
|
||||
#: ../../../YEAR-IN-REVIEW.md:95
|
||||
msgid "[Cactus Comments](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#cactus-comments-support)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:89
|
||||
#: ../../../YEAR-IN-REVIEW.md:96
|
||||
msgid "[Cinny](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#cinny-support) client support"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:90
|
||||
#: ../../../YEAR-IN-REVIEW.md:97
|
||||
msgid "[ntfy](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#ntfy-push-notifications-support) notifications"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:91
|
||||
#: ../../../YEAR-IN-REVIEW.md:98
|
||||
msgid "[matrix-ldap-registration-proxy](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#matrix-ldap-registration-proxy-support)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:92
|
||||
#: ../../../YEAR-IN-REVIEW.md:99
|
||||
msgid "[matrix\\_encryption\\_disabler support](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#matrix_encryption_disabler-support)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:93
|
||||
#: ../../../YEAR-IN-REVIEW.md:100
|
||||
msgid "[synapse-s3-storage-provider](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#synapse-s3-storage-provider-support) to stop the Synapse media store from being a scalability problem. This brought along [another feature](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#synapse-container-image-customization-support) - an easier way to customize the Synapse container image without having to fork and self-build all of it from scratch"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:95
|
||||
#: ../../../YEAR-IN-REVIEW.md:102
|
||||
msgid "Besides these major user-visible changes, a lot of work also happened **under the hood**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:97
|
||||
#: ../../../YEAR-IN-REVIEW.md:104
|
||||
msgid "we made [major improvements to Synapse workers](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#potential-backward-compatibility-break-major-improvements-to-synapse-workers) - adding support for stream writers and for running multiple workers of various kinds (federation senders, pushers, background task processing workers, etc.)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:98
|
||||
#: ../../../YEAR-IN-REVIEW.md:105
|
||||
msgid "we [improved the compatibility of (Synapse + workers) with the rest of the playbook](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#backward-compatibility-break-changing-how-reverse-proxying-to-synapse-works---now-via-a-matrix-synapse-reverse-proxy-companion-service) by introducing a new `matrix-synapse-reverse-proxy-companion-service` service"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:99
|
||||
#: ../../../YEAR-IN-REVIEW.md:106
|
||||
msgid "we started [splitting various Ansible roles out of the Matrix playbook and into independent roles](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#the-playbook-now-uses-external-roles-for-some-things) (e.g. `matrix-postgres` -> [ansible-role-postgres](https://github.com/mother-of-all-self-hosting/ansible-role-postgres)), which could be included in other Ansible playbooks. In fact, these roles already power a few **interesting other sibling playbooks**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:100
|
||||
#: ../../../YEAR-IN-REVIEW.md:107
|
||||
msgid "[gitea-docker-ansible-deploy](https://github.com/spantaleev/gitea-docker-ansible-deploy), for deploying a [Gitea](https://gitea.io/) (self-hosted [Git](https://git-scm.com/) service) server"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:101
|
||||
#: ../../../YEAR-IN-REVIEW.md:108
|
||||
msgid "[nextcloud-docker-ansible-deploy](https://github.com/spantaleev/nextcloud-docker-ansible-deploy), for deploying a [Nextcloud](https://nextcloud.com/) groupware server"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:102
|
||||
#: ../../../YEAR-IN-REVIEW.md:109
|
||||
msgid "[vaultwarden-docker-ansible-deploy](https://github.com/spantaleev/vaultwarden-docker-ansible-deploy), for deploying a [Vaultwarden](https://github.com/dani-garcia/vaultwarden) password manager server (unofficial [Bitwarden](https://bitwarden.com/) compatible server)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:104
|
||||
#: ../../../YEAR-IN-REVIEW.md:111
|
||||
msgid "These sibling playbooks co-exist nicely with one another due to using [Traefik](https://traefik.io/) for reverse-proxying, instead of trying to overtake the whole server by running their own [nginx](https://nginx.org/) reverse-proxy. Hopefully soon, the Matrix playbook will follow suit and be powered by Traefik by default."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../YEAR-IN-REVIEW.md:106
|
||||
#: ../../../YEAR-IN-REVIEW.md:113
|
||||
msgid "Last, but not least, to optimize our [etke.cc managed Matrix hosting service](https://etke.cc/)'s performance (but also individual Ansible playbook runs for people self-hosting by themselves using the playbook), we've [improved playbook runtime 2-5x](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/ba09705f7fbaf0108652ecbe209793b1d935eba7/CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) by employing various Ansible tricks."
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,154 +16,154 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/README.md:1
|
||||
#: ../../../docs/README.md:10
|
||||
msgid "Table of Contents"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:3
|
||||
msgid "⬇️ Installaton guides <!-- NOTE: the 🚀 emoji is used by \"Getting started\" on README.md -->"
|
||||
#: ../../../docs/README.md:12
|
||||
msgid "⬇️ Installation guides <!-- NOTE: the 🚀 emoji is used by \"Getting started\" on README.md -->"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:5
|
||||
#: ../../../docs/README.md:14
|
||||
msgid "There are two installation guides available for beginners and advanced users."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:7
|
||||
#: ../../../docs/README.md:16
|
||||
msgid "⚡ **[Quick start](quick-start.md) (for beginners)**: this is recommended for those who do not have an existing Matrix server and want to start quickly with \"opinionated defaults\"."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:9
|
||||
#: ../../../docs/README.md:18
|
||||
msgid "**Full installation guide (for advanced users)**: if you need to import an existing Matrix server's data into the new server or want to learn more while setting up the server, follow this guide."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:11
|
||||
#: ../../../docs/README.md:20
|
||||
msgid "[Prerequisites](prerequisites.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:13
|
||||
msgid "[Configuring your DNS settings](configuring-dns.md)"
|
||||
#: ../../../docs/README.md:22
|
||||
msgid "[Configuring DNS settings](configuring-dns.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:15
|
||||
#: ../../../docs/README.md:24
|
||||
msgid "[Getting the playbook](getting-the-playbook.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:17
|
||||
#: ../../../docs/README.md:26
|
||||
msgid "[Configuring the playbook](configuring-playbook.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:19
|
||||
#: ../../../docs/README.md:28
|
||||
msgid "[Installing](installing.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:21
|
||||
#: ../../../docs/README.md:30
|
||||
msgid "🛠️ Configuration options"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:28
|
||||
#: ../../../docs/README.md:37
|
||||
msgid "You can check useful documentation for configuring components here: [Configuring the playbook](configuring-playbook.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:30
|
||||
#: ../../../docs/README.md:39
|
||||
msgid "[Administration](configuring-playbook.md#administration) — services that help you in administrating and monitoring your Matrix installation"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:32
|
||||
#: ../../../docs/README.md:41
|
||||
msgid "[Authentication and user-related](configuring-playbook.md#authentication-and-user-related) — extend and modify how users are authenticated on your homeserver"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:34
|
||||
#: ../../../docs/README.md:43
|
||||
msgid "[Bots](configuring-playbook.md#bots) — bots provide various additional functionality to your installation"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:36
|
||||
#: ../../../docs/README.md:45
|
||||
msgid "[Bridges](configuring-playbook.md#bridging-other-networks) — bridges can be used to connect your Matrix installation with third-party communication networks"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:38
|
||||
#: ../../../docs/README.md:47
|
||||
msgid "[Clients](configuring-playbook.md#clients) — web clients for Matrix that you can host on your own domains"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:40
|
||||
#: ../../../docs/README.md:49
|
||||
msgid "[Core service adjustments](configuring-playbook.md#core-service-adjustments) — backbone of your Matrix system"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:42
|
||||
#: ../../../docs/README.md:51
|
||||
msgid "[File Storage](configuring-playbook.md#file-storage) — use alternative file storage to the default `media_store` folder"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:46
|
||||
#: ../../../docs/README.md:55
|
||||
msgid "[Other specialized services](configuring-playbook.md#other-specialized-services) — various services that don't fit any other categories"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:48
|
||||
#: ../../../docs/README.md:57
|
||||
msgid "👨🔧 Maintenance"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:50
|
||||
#: ../../../docs/README.md:59
|
||||
msgid "If your server and services experience issues, feel free to come to [our support room](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com) and ask for help."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:54
|
||||
msgid "[Checking if services work](maintenance-checking-services.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:56
|
||||
#: ../../../docs/README.md:63
|
||||
msgid "[Maintenance and Troubleshooting](maintenance-and-troubleshooting.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:58
|
||||
#: ../../../docs/README.md:65
|
||||
msgid "[PostgreSQL maintenance](maintenance-postgres.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:60
|
||||
#: ../../../docs/README.md:67
|
||||
msgid "[Synapse maintenance](maintenance-synapse.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:62
|
||||
#: ../../../docs/README.md:69
|
||||
msgid "[Upgrading services](maintenance-upgrading-services.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:64
|
||||
#: ../../../docs/README.md:71
|
||||
msgid "Other documentation pages <!-- NOTE: this header's title and the section below need optimization -->"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:66
|
||||
#: ../../../docs/README.md:73
|
||||
msgid "ℹ️ **[FAQ](faq.md)** — various Frequently Asked Questions about Matrix, with a focus on this Ansible playbook"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:70
|
||||
#: ../../../docs/README.md:77
|
||||
msgid "[Alternative architectures](alternative-architectures.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:72
|
||||
#: ../../../docs/README.md:79
|
||||
msgid "[Container images used by the playbook](container-images.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:74
|
||||
#: ../../../docs/README.md:81
|
||||
msgid "[Obtaining an Access Token](obtaining-access-tokens.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:76
|
||||
#: ../../../docs/README.md:83
|
||||
msgid "[Playbook tags](playbook-tags.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:78
|
||||
#: ../../../docs/README.md:85
|
||||
msgid "[Registering users](registering-users.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:80
|
||||
#: ../../../docs/README.md:87
|
||||
msgid "[Running `just` commands](just.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:82
|
||||
#: ../../../docs/README.md:89
|
||||
msgid "[Self-building](self-building.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:84
|
||||
#: ../../../docs/README.md:91
|
||||
msgid "[Uninstalling](uninstalling.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:86
|
||||
#: ../../../docs/README.md:93
|
||||
msgid "[Updating users passwords](updating-users-passwords.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:95
|
||||
msgid "[Using Ansible for the playbook](ansible.md)"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,42 +16,42 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/alternative-architectures.md:1
|
||||
#: ../../../docs/alternative-architectures.md:9
|
||||
msgid "Alternative architectures"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/alternative-architectures.md:3
|
||||
#: ../../../docs/alternative-architectures.md:11
|
||||
msgid "As stated in the [Prerequisites](prerequisites.md), currently only `amd64` (`x86_64`) is fully supported."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/alternative-architectures.md:5
|
||||
#: ../../../docs/alternative-architectures.md:13
|
||||
msgid "The playbook automatically determines the target server's architecture (the `matrix_architecture` variable) to be one of the following:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/alternative-architectures.md:7
|
||||
#: ../../../docs/alternative-architectures.md:15
|
||||
msgid "`amd64` (`x86_64`)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/alternative-architectures.md:8
|
||||
#: ../../../docs/alternative-architectures.md:16
|
||||
msgid "`arm32`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/alternative-architectures.md:9
|
||||
#: ../../../docs/alternative-architectures.md:17
|
||||
msgid "`arm64`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/alternative-architectures.md:11
|
||||
#: ../../../docs/alternative-architectures.md:19
|
||||
msgid "Some tools and container images can be built on the host or other measures can be used to install on that architecture."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/alternative-architectures.md:13
|
||||
#: ../../../docs/alternative-architectures.md:21
|
||||
msgid "Implementation details"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/alternative-architectures.md:15
|
||||
#: ../../../docs/alternative-architectures.md:23
|
||||
msgid "For `amd64`, prebuilt container images (see the [container images we use](container-images.md)) are used for all components (except [Hydrogen](configuring-playbook-client-hydrogen.md), which goes through self-building)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/alternative-architectures.md:17
|
||||
#: ../../../docs/alternative-architectures.md:25
|
||||
msgid "For other architecture (`arm64`, `arm32`), components which have a prebuilt image make use of it. If the component is not available for the specific architecture, [self-building](self-building.md) will be used. Not all components support self-building though, so your mileage may vary."
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,165 +16,177 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/ansible.md:2
|
||||
msgid "Running this playbook"
|
||||
#: ../../../docs/ansible.md:11
|
||||
msgid "Using Ansible for the playbook"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:4
|
||||
#: ../../../docs/ansible.md:13
|
||||
msgid "This playbook is meant to be run using [Ansible](https://www.ansible.com/)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:6
|
||||
#: ../../../docs/ansible.md:15
|
||||
msgid "Ansible typically runs on your local computer and carries out tasks on a remote server. If your local computer cannot run Ansible, you can also run Ansible on some server somewhere (including the server you wish to install to)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:8
|
||||
#: ../../../docs/ansible.md:17
|
||||
msgid "Supported Ansible versions"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:10
|
||||
#: ../../../docs/ansible.md:19
|
||||
msgid "To manually check which version of Ansible you're on, run: `ansible --version`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:12
|
||||
#: ../../../docs/ansible.md:21
|
||||
msgid "For the **best experience**, we recommend getting the **latest version of Ansible available**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:14
|
||||
msgid "We're not sure what's the minimum version of Ansible that can run this playbook successfully. The lowest version that we've confirmed (on 2022-11-26) to be working fine is: `ansible-core` (`2.11.7`) combined with `ansible` (`4.10.0`)."
|
||||
#: ../../../docs/ansible.md:23
|
||||
msgid "We're not sure what's the minimum version of Ansible that can run this playbook successfully. The lowest version that we suspect (on 2025-09-03) to be working fine is: `ansible-core` (`2.15.1`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:16
|
||||
#: ../../../docs/ansible.md:25
|
||||
msgid "If your distro ships with an Ansible version older than this, you may run into issues. Consider [Upgrading Ansible](#upgrading-ansible) or [using Ansible via Docker](#using-ansible-via-docker)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:18
|
||||
msgid "Upgrading Ansible"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:20
|
||||
msgid "Depending on your distribution, you may be able to upgrade Ansible in a few different ways:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:22
|
||||
msgid "by using an additional repository (PPA, etc.), which provides newer Ansible versions. See instructions for [CentOS](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-ansible-on-rhel-centos-or-fedora), [Debian](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-ansible-on-debian), or [Ubuntu](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-ansible-on-ubuntu) on the Ansible website."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:24
|
||||
msgid "by removing the Ansible package (`yum remove ansible` or `apt-get remove ansible`) and installing via [pip](https://pip.pypa.io/en/stable/installation/) (`pip install ansible`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:26
|
||||
msgid "If using the `pip` method, do note that the `ansible-playbook` binary may not be on the `$PATH` (https://linuxconfig.org/linux-path-environment-variable), but in some more special location like `/usr/local/bin/ansible-playbook`. You may need to invoke it using the full path."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:28
|
||||
msgid "**Note**: Both of the above methods are a bad way to run system software such as Ansible. If you find yourself needing to resort to such hacks, please consider reporting a bug to your distribution and/or switching to a sane distribution, which provides up-to-date software."
|
||||
#: ../../../docs/ansible.md:27
|
||||
msgid "[!WARNING] One reason for the version requirement being as such is that the playbook by default installs Docker for you using [this Docker role](https://github.com/geerlingguy/ansible-role-docker) which [has a hard requirement on Ansible v2.15.1](https://github.com/geerlingguy/ansible-role-docker/commit/7f44a1d9ad8132819ea9852918bca5dab8757cd0). If you install Docker yourself another way, you can tell the playbook to skip running this role (by adding `matrix_playbook_docker_installation_enabled: false` to your `vars.yml` configuration). It may then be possible to get the playbook running on an older version of Ansible. Still, this is a complication and your mileage may vary. We recommend [upgrading Ansible](#upgrading-ansible) instead of going into uncharted territory."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:30
|
||||
msgid "Using Ansible via Docker"
|
||||
msgid "Upgrading Ansible"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:32
|
||||
msgid "Alternatively, you can run Ansible inside a Docker container (powered by the [devture/ansible](https://hub.docker.com/r/devture/ansible/) Docker image)."
|
||||
msgid "Depending on your distribution, you may be able to upgrade Ansible in a few different ways:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:34
|
||||
msgid "This ensures that you're using a very recent Ansible version, which is less likely to be incompatible with the playbook."
|
||||
msgid "by using an additional repository (PPA, etc.), which provides newer Ansible versions. See instructions for [CentOS](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-ansible-on-rhel-centos-or-fedora), [Debian](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-ansible-on-debian), or [Ubuntu](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-ansible-on-ubuntu) on the Ansible website."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:36
|
||||
msgid "You can either [run Ansible in a container on the Matrix server itself](#running-ansible-in-a-container-on-the-matrix-server-itself) or [run Ansible in a container on another computer (not the Matrix server)](#running-ansible-in-a-container-on-another-computer-not-the-matrix-server)."
|
||||
msgid "by removing the Ansible package (`yum remove ansible` or `apt-get remove ansible`) and installing via [pip](https://pip.pypa.io/en/stable/installation/) (`pip install ansible`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:38
|
||||
msgid "Running Ansible in a container on the Matrix server itself"
|
||||
msgid "If using the `pip` method, do note that the `ansible-playbook` binary may not be on the `$PATH` (https://linuxconfig.org/linux-path-environment-variable), but in some more special location like `/usr/local/bin/ansible-playbook`. You may need to invoke it using the full path."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:40
|
||||
msgid "To run Ansible in a (Docker) container on the Matrix server itself, you need to have a working Docker installation. Docker is normally installed by the playbook, so this may be a bit of a chicken and egg problem. To solve it:"
|
||||
msgid "**Note**: Both of the above methods are a bad way to run system software such as Ansible. If you find yourself needing to resort to such hacks, please consider reporting a bug to your distribution and/or switching to a sane distribution, which provides up-to-date software."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:42
|
||||
msgid "you **either** need to install Docker manually first. Follow [the upstream instructions](https://docs.docker.com/engine/install/) for your distribution and consider setting `matrix_playbook_docker_installation_enabled: false` in your `vars.yml` file, to prevent the playbook from installing Docker"
|
||||
msgid "Using Ansible via Docker"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:43
|
||||
msgid "**or** you need to run the playbook in another way (e.g. [Running Ansible in a container on another computer (not the Matrix server)](#running-ansible-in-a-container-on-another-computer-not-the-matrix-server)) at least the first time around"
|
||||
#: ../../../docs/ansible.md:44
|
||||
msgid "Alternatively, you can run Ansible inside a Docker container (powered by the [ghcr.io/devture/ansible](https://github.com/devture/docker-ansible/pkgs/container/ansible) Docker image)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:45
|
||||
msgid "Once you have a working Docker installation on the server, **clone the playbook** somewhere on the server and configure it as per usual (`inventory/hosts`, `inventory/host_vars/…`, etc.), as described in [configuring the playbook](configuring-playbook.md)."
|
||||
#: ../../../docs/ansible.md:46
|
||||
msgid "This ensures that:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:47
|
||||
msgid "You would then need to add `ansible_connection=community.docker.nsenter` to the host line in `inventory/hosts`. This tells Ansible to connect to the \"remote\" machine by switching Linux namespaces with [nsenter](https://man7.org/linux/man-pages/man1/nsenter.1.html), instead of using SSH."
|
||||
#: ../../../docs/ansible.md:48
|
||||
msgid "you're using a very recent Ansible version, which is less likely to be incompatible with the playbook"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:49
|
||||
msgid "Alternatively, you can leave your `inventory/hosts` as is and specify the connection type in **each** `ansible-playbook` call you do later, like this: `ansible-playbook --connection=community.docker.nsenter …`"
|
||||
msgid "you also get access to the [agru](https://github.com/etkecc/agru) tool for quicker Ansible role installation (when running `just roles`) compared to `ansible-galaxy`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:51
|
||||
#: ../../../docs/ansible.md:71
|
||||
msgid "You can either [run Ansible in a container on the Matrix server itself](#running-ansible-in-a-container-on-the-matrix-server-itself) or [run Ansible in a container on another computer (not the Matrix server)](#running-ansible-in-a-container-on-another-computer-not-the-matrix-server)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:53
|
||||
msgid "Running Ansible in a container on the Matrix server itself"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:55
|
||||
msgid "To run Ansible in a (Docker) container on the Matrix server itself, you need to have a working Docker installation. Docker is normally installed by the playbook, so this may be a bit of a chicken and egg problem. To solve it:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:57
|
||||
msgid "you **either** need to install Docker manually first. Follow [the upstream instructions](https://docs.docker.com/engine/install/) for your distribution and consider setting `matrix_playbook_docker_installation_enabled: false` in your `vars.yml` file, to prevent the playbook from installing Docker"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:58
|
||||
msgid "**or** you need to run the playbook in another way (e.g. [Running Ansible in a container on another computer (not the Matrix server)](#running-ansible-in-a-container-on-another-computer-not-the-matrix-server)) at least the first time around"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:60
|
||||
msgid "Once you have a working Docker installation on the server, **clone the playbook** somewhere on the server and configure it as per usual (`inventory/hosts`, `inventory/host_vars/…`, etc.), as described in [configuring the playbook](configuring-playbook.md)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:62
|
||||
msgid "You would then need to add `ansible_connection=community.docker.nsenter` to the host line in `inventory/hosts`. This tells Ansible to connect to the \"remote\" machine by switching Linux namespaces with [nsenter](https://man7.org/linux/man-pages/man1/nsenter.1.html), instead of using SSH."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:64
|
||||
msgid "Alternatively, you can leave your `inventory/hosts` as is and specify the connection type in **each** `ansible-playbook` call you do later, like this: `just install-all --connection=community.docker.nsenter` (or `ansible-playbook --connection=community.docker.nsenter …`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:66
|
||||
#: ../../../docs/ansible.md:88
|
||||
msgid "Run this from the playbook's directory:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:63
|
||||
#: ../../../docs/ansible.md:84
|
||||
#: ../../../docs/ansible.md:80
|
||||
#: ../../../docs/ansible.md:103
|
||||
msgid "Once you execute the above command, you'll be dropped into a `/work` directory inside a Docker container. The `/work` directory contains the playbook's code."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:65
|
||||
#: ../../../docs/ansible.md:86
|
||||
#: ../../../docs/ansible.md:82
|
||||
#: ../../../docs/ansible.md:105
|
||||
msgid "First, consider running `git config --global --add safe.directory /work` to [resolve directory ownership issues](#resolve-directory-ownership-issues)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:67
|
||||
msgid "Finally, you can execute `ansible-playbook …` (or `ansible-playbook --connection=community.docker.nsenter …`) commands as per normal now."
|
||||
#: ../../../docs/ansible.md:84
|
||||
msgid "Finally, you can execute `just` or `ansible-playbook …` (e.g. `ansible-playbook --connection=community.docker.nsenter …`) commands as per normal now."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:69
|
||||
#: ../../../docs/ansible.md:86
|
||||
msgid "Running Ansible in a container on another computer (not the Matrix server)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:82
|
||||
msgid "The above command tries to mount an SSH key (`$HOME/.ssh/id_rsa`) into the container (at `/root/.ssh/id_rsa`). If your SSH key is at a different path (not in `$HOME/.ssh/id_rsa`), adjust that part."
|
||||
#: ../../../docs/ansible.md:101
|
||||
msgid "The above command tries to mount an SSH key (`$HOME/.ssh/id_ed25519`) into the container (at `/root/.ssh/id_ed25519`). If your SSH key is at a different path (not in `$HOME/.ssh/id_ed25519`), adjust that part."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:88
|
||||
msgid "Finally, you execute `ansible-playbook …` commands as per normal now."
|
||||
#: ../../../docs/ansible.md:107
|
||||
msgid "Finally, you execute `just` or `ansible-playbook …` commands as per normal now."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:90
|
||||
#: ../../../docs/ansible.md:109
|
||||
msgid "If you don't use SSH keys for authentication"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:92
|
||||
msgid "If you don't use SSH keys for authentication, simply remove that whole line (`-v $HOME/.ssh/id_rsa:/root/.ssh/id_rsa:ro`)."
|
||||
#: ../../../docs/ansible.md:111
|
||||
msgid "If you don't use SSH keys for authentication, simply remove that whole line (`--mount type=bind,src$HOME/.ssh/id_ed25519,dst=/root/.ssh/id_ed25519,ro`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:94
|
||||
#: ../../../docs/ansible.md:113
|
||||
msgid "To authenticate at your server using a password, you need to add a package. So, when you are in the shell of the ansible docker container (the previously used `docker run -it …` command), run:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:100
|
||||
msgid "Then, to be asked for the password whenever running an `ansible-playbook` command add `--ask-pass` to the arguments of the command."
|
||||
#: ../../../docs/ansible.md:119
|
||||
msgid "Then, to be asked for the password whenever running an `ansible-playbook` command add `--ask-pass` to the arguments of the command."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:102
|
||||
#: ../../../docs/ansible.md:121
|
||||
msgid "Resolve directory ownership issues"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:104
|
||||
msgid "Because you're `root` in the container running Ansible and this likely differs fom the owner (your regular user account) of the playbook directory outside of the container, certain playbook features which use `git` locally may report warnings such as:"
|
||||
#: ../../../docs/ansible.md:123
|
||||
msgid "Because you're `root` in the container running Ansible and this likely differs from the owner (your regular user account) of the playbook directory outside of the container, certain playbook features which use `git` locally may report warnings such as:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:106
|
||||
#: ../../../docs/ansible.md:125
|
||||
msgid "fatal: unsafe repository ('/work' is owned by someone else) To add an exception for this directory, call: git config --global --add safe.directory /work"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:110
|
||||
#: ../../../docs/ansible.md:129
|
||||
msgid "These errors can be resolved by making `git` trust the playbook directory by running `git config --global --add safe.directory /work`"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,60 +16,60 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:1
|
||||
#: ../../../docs/configuring-captcha.md:10
|
||||
msgid "(Adapted from the [upstream project](https://github.com/element-hq/synapse/blob/develop/docs/CAPTCHA_SETUP.md))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:3
|
||||
#: ../../../docs/configuring-captcha.md:12
|
||||
msgid "Overview"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:5
|
||||
#: ../../../docs/configuring-captcha.md:14
|
||||
msgid "Captcha can be enabled for this home server. This file explains how to do that."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:7
|
||||
#: ../../../docs/configuring-captcha.md:16
|
||||
msgid "The captcha mechanism used is Google's [ReCaptcha](https://www.google.com/recaptcha/). This requires API keys from Google. If your homeserver is Dendrite then [hCapcha](https://www.hcaptcha.com) can be used instead."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:9
|
||||
#: ../../../docs/configuring-captcha.md:18
|
||||
msgid "ReCaptcha"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:11
|
||||
#: ../../../docs/configuring-captcha.md:37
|
||||
#: ../../../docs/configuring-captcha.md:20
|
||||
#: ../../../docs/configuring-captcha.md:46
|
||||
msgid "Getting keys"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:13
|
||||
#: ../../../docs/configuring-captcha.md:39
|
||||
#: ../../../docs/configuring-captcha.md:22
|
||||
#: ../../../docs/configuring-captcha.md:48
|
||||
msgid "Requires a site/secret key pair from:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:15
|
||||
#: ../../../docs/configuring-captcha.md:24
|
||||
msgid "<http://www.google.com/recaptcha/admin>"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:17
|
||||
#: ../../../docs/configuring-captcha.md:26
|
||||
msgid "Must be a reCAPTCHA **v2** key using the \"I'm not a robot\" Checkbox option"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:19
|
||||
#: ../../../docs/configuring-captcha.md:28
|
||||
msgid "Setting ReCaptcha keys"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:21
|
||||
#: ../../../docs/configuring-captcha.md:30
|
||||
msgid "Once registered as above, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:35
|
||||
#: ../../../docs/configuring-captcha.md:44
|
||||
msgid "hCaptcha"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:41
|
||||
#: ../../../docs/configuring-captcha.md:50
|
||||
msgid "<https://dashboard.hcaptcha.com/sites/new>"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:43
|
||||
#: ../../../docs/configuring-captcha.md:52
|
||||
msgid "Setting hCaptcha keys"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,23 +16,23 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-dns.md:1
|
||||
msgid "Configuring your DNS settings"
|
||||
#: ../../../docs/configuring-dns.md:18
|
||||
msgid "Configuring DNS settings"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:3
|
||||
msgid "<sup>[Prerequisites](prerequisites.md) > Configuring your DNS settings > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)</sup>"
|
||||
#: ../../../docs/configuring-dns.md:20
|
||||
msgid "<sup>[Prerequisites](prerequisites.md) > Configuring DNS settings > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)</sup>"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:5
|
||||
#: ../../../docs/configuring-dns.md:22
|
||||
msgid "To set up Matrix on your domain, you'd need to do some DNS configuration."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:7
|
||||
#: ../../../docs/configuring-dns.md:24
|
||||
msgid "DNS settings for services enabled by default"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:9
|
||||
#: ../../../docs/configuring-dns.md:26
|
||||
msgid "To serve the base domain (`example.com`) and [Element Web](configuring-playbook-client-element-web.md) with the default subdomain, adjust DNS records as below."
|
||||
msgstr ""
|
||||
|
||||
@@ -73,7 +73,15 @@ msgid "-"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:0
|
||||
msgid "`matrix-server-IP`"
|
||||
msgid "`matrix-server-IPv4`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:0
|
||||
msgid "AAAA"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:0
|
||||
msgid "`matrix-server-IPv6`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:0
|
||||
@@ -88,58 +96,62 @@ msgstr ""
|
||||
msgid "`matrix.example.com`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:16
|
||||
msgid "As the table illustrates, you need to create 2 subdomains (`matrix.example.com` and `element.example.com`) and point both of them to your server's IP address (DNS `A` record or `CNAME` record is fine)."
|
||||
#: ../../../docs/configuring-dns.md:34
|
||||
msgid "As the table illustrates, you need to create 2 subdomains (`matrix.example.com` and `element.example.com`) and point both of them to your server's IPv4/IPv6 address."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:18
|
||||
#: ../../../docs/configuring-dns.md:36
|
||||
msgid "If you don't have IPv6 connectivity yet, you can skip the `AAAA` record. For more details about IPv6, see the [Configuring IPv6](./configuring-ipv6.md) documentation page."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:38
|
||||
msgid "The `element.example.com` subdomain is necessary, because this playbook installs the [Element Web](https://github.com/element-hq/element-web) client for you by default. If you'd rather instruct the playbook not to install Element Web (`matrix_client_element_enabled: false` when [Configuring the playbook](configuring-playbook.md) later), feel free to skip the `element.example.com` DNS record."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:20
|
||||
#: ../../../docs/configuring-dns.md:40
|
||||
msgid "Be mindful as to how long it will take for the DNS records to propagate."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:22
|
||||
#: ../../../docs/configuring-dns.md:42
|
||||
msgid "**Note**: if you are using Cloudflare DNS, make sure to disable the proxy and set all records to \"DNS only\". Otherwise, fetching certificates will fail."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:24
|
||||
#: ../../../docs/configuring-dns.md:44
|
||||
msgid "DNS setting for server delegation (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:26
|
||||
#: ../../../docs/configuring-dns.md:46
|
||||
msgid "In the sample `vars.yml` ([`examples/vars.yml`](../examples/vars.yml)), we recommend to use a short user ID like `@alice:example.com` instead of `@alice:matrix.example.com`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:28
|
||||
#: ../../../docs/configuring-dns.md:48
|
||||
msgid "To use such an ID, you don't need to install anything on the actual `example.com` server. Instead, you need to instruct the Matrix network that Matrix services for `example.com` are redirected over to `matrix.example.com`. This redirection is also known as \"delegation\"."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:30
|
||||
#: ../../../docs/configuring-dns.md:50
|
||||
msgid "As we discuss in [Server Delegation](howto-server-delegation.md), server delegation can be configured in either of these ways:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:32
|
||||
#: ../../../docs/configuring-dns.md:52
|
||||
msgid "Setting up a `/.well-known/matrix/server` file on the base domain (`example.com`)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:33
|
||||
#: ../../../docs/configuring-dns.md:53
|
||||
msgid "Setting up a `_matrix._tcp` DNS SRV record"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:35
|
||||
#: ../../../docs/configuring-dns.md:55
|
||||
msgid "For simplicity reasons, this playbook recommends you to set up server delegation via a `/.well-known/matrix/server` file, instead of using a DNS SRV record."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:37
|
||||
#: ../../../docs/configuring-dns.md:57
|
||||
msgid "If you choose the recommended method (file-based delegation), you do not need to configure the DNS record to enable server delegation. You will need to add a necessary configuration later, when you [finalize the installation](installing.md#finalize-the-installation) after installing and starting Matrix services."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:39
|
||||
#: ../../../docs/configuring-dns.md:59
|
||||
msgid "On the other hand, if you choose this method (setting up a DNS SRV record), you need to configure the additional DNS record as well as adjust SSL certificate handling. Take a look at this documentation for more information: [Server Delegation via a DNS SRV record (advanced)](howto-server-delegation.md#server-delegation-via-a-dns-srv-record-advanced)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-dns.md:43
|
||||
#: ../../../docs/configuring-dns.md:63
|
||||
msgid "[▶️](getting-the-playbook.md) When you're done with the DNS configuration and ready to proceed, continue with [Getting the playbook](getting-the-playbook.md)."
|
||||
msgstr ""
|
||||
|
||||
361
i18n/translation-templates/docs/configuring-ipv6.pot
Normal file
361
i18n/translation-templates/docs/configuring-ipv6.pot
Normal file
@@ -0,0 +1,361 @@
|
||||
# SOME DESCRIPTIVE TITLE.
|
||||
# Copyright (C) 2018-2025, Slavi Pantaleev, Aine Etke, MDAD community members
|
||||
# This file is distributed under the same license as the matrix-docker-ansible-deploy package.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
||||
#
|
||||
#, fuzzy
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:6
|
||||
msgid "Configuring IPv6"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:8
|
||||
msgid "Since 2025-03-08, the [default example configuration](../examples/vars.yml) for the playbook recommends enabling [IPv6](https://en.wikipedia.org/wiki/IPv6) support for Docker's container networks."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:10
|
||||
msgid "**If you have IPv6 support on your server/network** (see [How do I check if my server has IPv6 connectivity?](#how-do-i-check-if-my-server-has-ipv6-connectivity)), then [enabling IPv6 support for the playbook](#enabling-ipv6-support-for-the-playbook) would give you:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:12
|
||||
msgid "📥 incoming IPv6 connectivity to the server via the server's IPv6 address/addresses (containers won't have their own individual publicly accessible IPs)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:13
|
||||
msgid "📤 outgoing IPv6 connectivity from the server via the server's IPv6 address/addresses (containers won't exit via their own individual IPv6 address)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:14
|
||||
msgid "🔄 IPv6 connectivity for cross-container communication"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:16
|
||||
msgid "**If you still don't have IPv6 support on your server/network**, then enabling IPv6 support for the playbook will only enable IPv6 connectivity for cross-container communication and shouldn't affect your server's incoming/outgoing communication. You may also be interested in reading if [there's a performance penalty to enabling IPv6 if the server/network doesn't support IPv6 connectivity?](#is-there-a-performance-penalty-to-enabling-ipv6-if-the-server-network-doesn-t-support-ipv6-connectivity)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:18
|
||||
msgid "As such, **we recommend that you follow the default example configuration and leave IPv6 support for Docker enabled in all cases**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:20
|
||||
msgid "Enabling IPv6 consists of 2 steps:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:22
|
||||
msgid "[Enabling IPv6 support for the playbook](#enabling-ipv6-support-for-the-playbook)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:23
|
||||
msgid "[Configuring DNS records for IPv6](#configuring-dns-records-for-ipv6)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:25
|
||||
msgid "💡 If you've followed a recent version of our documentation, you would have already done these steps, so there's nothing else to do."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:27
|
||||
msgid "Enabling IPv6 support for the playbook"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:29
|
||||
msgid "You can enable IPv6 support for all components' Docker container networks by using the following `vars.yml` configuration:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:50
|
||||
msgid "Doing this:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:52
|
||||
msgid "all container networks will be IPv6-enabled"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:54
|
||||
msgid "NAT66 will be used, so that:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:55
|
||||
msgid "containers will get [Unique Local Addresses (ULA)](https://en.wikipedia.org/wiki/Unique_local_address)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:56
|
||||
msgid "the outgoing IPv6 address for containers will be the same as the one on the server"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:57
|
||||
msgid "traffic destined for the IPv6 address of the server will be forwarded to the containers that handle (and publish) that specific port"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:59
|
||||
msgid "[!WARNING] Without enabling this and assuming you have IPv6 `AAAA` DNS records pointing to the server (see [Configuring DNS records for IPv6](#configuring-dns-records-for-ipv6)), IPv6 traffic will still be handled, but NAT64 will be used instead of NAT66. As such, containers will only have an IPv4 address and all IPv6 traffic that reaches them will seem to originate from a local IP. Containers also won't be able to make outgoing (even cross-container) IPv6 requests."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:63
|
||||
msgid "To confirm connectivity, see the following other resources:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:65
|
||||
msgid "[How do I check if my server has IPv6 connectivity?](#how-do-i-check-if-my-server-has-ipv6-connectivity)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:66
|
||||
msgid "[How do I check outgoing IPv6 connectivity for containers?](#how-do-i-check-outgoing-ipv6-connectivity-for-containers)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:67
|
||||
msgid "[How do I check incoming IPv6 connectivity for containers?](#how-do-i-check-incoming-ipv6-connectivity-for-containers)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:68
|
||||
msgid "[How do I confirm if my container networks are IPv6-enabled?](#how-do-i-confirm-if-my-container-networks-are-ipv6-enabled)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:69
|
||||
msgid "Ensure that the [Federation Tester](https://federationtester.matrix.org/) reports that your server is reachable over IPv6."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:71
|
||||
msgid "Configuring DNS records for IPv6"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:73
|
||||
msgid "[Enabling IPv6 support for the playbook](#enabling-ipv6-support-for-the-playbook) tells you how to prepare for IPv6 on the container (Docker) side."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:75
|
||||
msgid "For full public IPv6 connectivity (and not just IPv6 connectivity for containers inside the container networks) you also need to **ensure that your domain names** (e.g. `matrix.example.com` and others) have IPv6 (`AAAA`) DNS records pointing to the server's IPv6 address."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:77
|
||||
msgid "Also see the [Configuring DNS settings](configuring-dns.md) documentation page for more details."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:79
|
||||
msgid "A note about old Docker"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:81
|
||||
msgid "With our [default example configuration](../examples/vars.yml), the playbook manages Docker for you and installs a modern-enough version."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:83
|
||||
msgid "Docker versions newer than 27.0.1 enable IPv6 integration at the Docker daemon level out of the box. This still requires that networks are created with IPv6 support as described in the [Enabling IPv6 support for the playbook](#enabling-ipv6-support-for-the-playbook) section above."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:85
|
||||
msgid "**If you're on an old Docker version** (Docker 27.0.0 or older) for some reason, it's likely that your Docker installation is not enabled for IPv6 at all. In such a case:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:87
|
||||
msgid "if Docker is managed by the playbook, you can tell it to force-enable IPv6 via `devture_systemd_docker_base_ipv6_daemon_options_changing_enabled: true`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:89
|
||||
msgid "if Docker is managed by you manually, you can add `{\"experimental\": true, \"ip6tables\": true}` to the Docker daemon options and restart the Docker service (`docker.service`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:91
|
||||
msgid "Frequently Asked Questions"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:93
|
||||
msgid "How do I check if my server has IPv6 connectivity?"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:95
|
||||
msgid "With curl"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:97
|
||||
msgid "You can run `curl https://icanhazip.com` and see if it returns an [IPv6 address](https://en.wikipedia.org/wiki/IPv6_address) (an address with `:` characters in it, like `2001:db8:1234:5678::1`). If it does, then your server has IPv6 connectivity and prefers it over using IPv4. This is common."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:99
|
||||
msgid "If you see an IPv4 address instead (e.g. `1.2.3.4`), it may be that your server prefers IPv4 over IPv6 or that your network does not support IPv6. You can try forcing `curl` to use IPv6 by running `curl -6 https://icanhazip.com` and see if it returns an IPv6 address."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:101
|
||||
msgid "With other network utilities"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:103
|
||||
msgid "You can run `ip -6 addr` to see if you have any IPv6 addresses assigned to your server, besides the link-local (`fe80::*`) addresses that everyone has (unless they have force-disabled IPv6 support on their system)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:105
|
||||
msgid "If you do have an IPv6 address, it's still worth [using curl](#with-curl) to confirm that your server can successfully make outgoing requests over IPv6."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:107
|
||||
msgid "What does the `devture_systemd_docker_base_ipv6_enabled` setting actually do?"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:109
|
||||
msgid "The `devture_systemd_docker_base_ipv6_enabled` setting controls whether container networks will be created with IPv6 support."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:111
|
||||
msgid "Changing this setting subsequently requires manual work (deleting all container networks). See [I've changed the `devture_systemd_docker_base_ipv6_enabled` setting, but it doesn't seem to have any effect](#i-ve-changed-the-devture_systemd_docker_base_ipv6_enabled-setting-but-it-doesn-t-seem-to-have-any-effect)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:114
|
||||
msgid "I've changed the `devture_systemd_docker_base_ipv6_enabled` setting, but it doesn't seem to have any effect."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:116
|
||||
msgid "If you're using an older Docker version (Docker 27.0.0 or older), see [A note about old Docker](#a-note-about-old-docker)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:118
|
||||
msgid "If you've previously installed with one `devture_systemd_docker_base_ipv6_enabled` value and then changed it to another, you need to:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:120
|
||||
msgid "stop all services (`just stop-all`)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:121
|
||||
msgid "delete all container networks on the server: `docker network rm $(docker network ls -q)`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:122
|
||||
msgid "re-run the playbook fully: `just install-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:124
|
||||
msgid "How do I confirm if my container networks are IPv6-enabled?"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:126
|
||||
msgid "You can list container networks by running `docker network ls` on the server."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:128
|
||||
msgid "For each container network (e.g. `matrix-homeserver`), you can check if it has IPv6 connectivity by running a command like this: `docker network inspect matrix-homeserver`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:130
|
||||
msgid "Ensure that there's an IPv6 subnet/gateway in the `IPAM.Config` section. If yes, you may wish to proceed with [How do I check outgoing IPv6 connectivity for containers?](#how-do-i-check-outgoing-ipv6-connectivity-for-containers)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:132
|
||||
msgid "If there's no IPv6 subnet/gateway in the `IPAM.Config` section, this container network was not created with IPv6 support. See [I've changed the `devture_systemd_docker_base_ipv6_enabled` setting, but it doesn't seem to have any effect](#i-ve-changed-the-devture_systemd_docker_base_ipv6_enabled-setting-but-it-doesn-t-seem-to-have-any-effect)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:135
|
||||
msgid "How do I check outgoing IPv6 connectivity for containers?"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:141
|
||||
msgid "💡 This one-off container is connected to the `matrix-homeserver` container network, not to the default Docker bridge network. The default Docker `bridge` network does not have IPv6 connectivity by default (yet) and is not influenced by the `devture_systemd_docker_base_ipv6_enabled` setting, so using that network (by omitting `--network=..` from the command above) will not show an IPv6 address"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:143
|
||||
msgid "✅ If this command returns an IPv6 address, you're all good."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:145
|
||||
msgid "❌ If this command doesn't return an IPv6 address, it may be that:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:147
|
||||
msgid "your container network does not have IPv6 connectivity. See [How do I confirm if my container networks are IPv6-enabled?](#how-do-i-confirm-if-my-container-networks-are-ipv6-enabled) for more details."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:149
|
||||
msgid "your server does not have IPv6 connectivity. See [How do I check if my server has IPv6 connectivity?](#how-do-i-check-if-my-server-has-ipv6-connectivity) for more details. If you do have IPv6 connectivity, then the issue is with Docker's IPv6 configuration. Otherwise, you need to check your server's network configuration/firewall/routing and get back to configuring the playbook later on."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:151
|
||||
msgid "How do I check incoming IPv6 connectivity for containers?"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:153
|
||||
msgid "Only containers that publish ports will be exposed (reachable) publicly on the server's own IPv6 address. Containers will not get their own individual public IPv6 address."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:155
|
||||
msgid "For this playbook, a commonly exposed container is the Traefik reverse-proxy container (unless [you're using your own webserver](./configuring-playbook-own-webserver.md))."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:157
|
||||
msgid "You can either do something like `curl -6 https://matrix.example.com` from an IPv6-enabled host (including the server itself) and see if it works."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:159
|
||||
msgid "An alternative is to use the [IPv6 Port Checker](https://port.tools/port-checker-ipv6/) with a hostname of `matrix.example.com` and a port of `443`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:161
|
||||
msgid "💡 Trying to connect to `matrix.example.com` via IPv6 requires that you have already [configured the DNS records for IPv6](#configuring-dns-records-for-ipv6) as described above. If you wish to eliminate DNS as a potential issue, you can also try connecting to the server's own IPv6 address directly: `curl -6 -H 'Host: matrix.example.com' https://[2001:db8:1234:5678::1]` (we pass a `Host` header to tell Traefik which host we'd like it to serve)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:163
|
||||
msgid "Why enable IPv6 if my network doesn't support it yet?"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:165
|
||||
msgid "Because when your network does get support for IPv6 later on (even if that's 5 years away), you won't have to change anything besides [configuring the DNS records for IPv6](#configuring-dns-records-for-ipv6)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:167
|
||||
msgid "Can I use a custom subnet for IPv6?"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:169
|
||||
msgid "Not easily."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:171
|
||||
msgid "The playbook and the various roles only support passing an `enable_ipv6` flag (`true` or `false` value depending on the `devture_systemd_docker_base_ipv6_enabled` Ansible variable) when creating the Docker container networks."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:173
|
||||
msgid "There's no support for passing a custom subnet for IPv4 and IPv6. We let Docker auto-generate the subnets for us."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:175
|
||||
msgid "You can either create a Pull Request that adds support for this to the various playbook roles, or you can manually recreate the networks from the command-line (e.g. `docker network rm matrix-homeserver && docker network create --ipv6 --subnet=2001:db8:1234:5678::/64 matrix-homeserver`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:177
|
||||
msgid "Can I use Global Unicast Addresses (GUA) for IPv6?"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:179
|
||||
msgid "No. You cannot have GUA addresses where each container is individually addressable over the public internet."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:181
|
||||
msgid "The playbook only supports NAT66, which should be good enough for most use cases."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:183
|
||||
msgid "Having containers get IPv6 addresses from your own GUA subnet requires complex configuration (ndp-proxy, etc.) and is not supported."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:185
|
||||
msgid "You may find [this Reddit post](https://www.reddit.com/r/ipv6/comments/1alpzmb/comment/kphpw11/) interesting."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:187
|
||||
msgid "Is there a performance penalty to enabling IPv6 if the server/network doesn't support IPv6 connectivity?"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:189
|
||||
msgid "Probably a tiny one, as services may try to make (unsuccessful) outgoing requests over IPv6."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-ipv6.md:191
|
||||
msgid "In practice, it's probably negligible."
|
||||
msgstr ""
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,182 +16,174 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:1
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:9
|
||||
msgid "Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:3
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:11
|
||||
msgid "The playbook can install and configure the [matrix-alertmanager-receiver](https://github.com/metio/matrix-alertmanager-receiver) service for you. It's a [client](https://prometheus.io/docs/alerting/latest/clients/) for Prometheus' [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/), allowing you to deliver alerts to Matrix rooms."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:5
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:13
|
||||
msgid "See the project's [documentation](https://github.com/metio/matrix-alertmanager-receiver/blob/main/README.md) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:7
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:15
|
||||
msgid "This service is meant to be used with an external [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) instance. It's **not** meant to be integrated with the [Prometheus & Grafana stack](./configuring-playbook-prometheus-grafana.md) installed by this playbook, because the Alertmanager component is not installed by it."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:9
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:17
|
||||
msgid "Prerequisites"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:11
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:19
|
||||
msgid "Register the bot account"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:13
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:21
|
||||
msgid "This service uses a bot (with a username specified in `matrix_alertmanager_receiver_config_matrix_user_id_localpart`) for delivering messages."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:15
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:23
|
||||
msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:17
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:25
|
||||
msgid "Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:19
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:27
|
||||
msgid "You can use the playbook to [register a new user](registering-users.md):"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:25
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:33
|
||||
msgid "Obtain an access token"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:27
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:35
|
||||
msgid "The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:29
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:37
|
||||
msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:32
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:40
|
||||
msgid "Join to rooms as the bot manually"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:34
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:42
|
||||
msgid "ℹ️ **This bot does not accept room invitations automatically**. To deliver messages to rooms, the bot must be joined to all rooms manually."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:36
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:44
|
||||
msgid "For each new room you would like the bot to deliver alerts to, invite the bot to the room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:38
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:46
|
||||
msgid "Then, log in as the bot using any Matrix client of your choosing, accept the room invitation from the bot's account, and log out."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:40
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:48
|
||||
msgid "Adjusting DNS records (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:42
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:50
|
||||
msgid "By default, this playbook installs matrix-alertmanager-receiver on the `matrix.` subdomain, at the `/matrix-alertmanager-receiver` path (https://matrix.example.com/matrix-alertmanager-receiver). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:44
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:52
|
||||
msgid "If you wish to adjust it, see the section [below](#adjusting-the-matrix-alertmanager-receiver-url-optional) for details about DNS configuration."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:46
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:54
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:48
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:56
|
||||
msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `ACCESS_TOKEN_HERE` with the one created [above](#obtain-an-access-token)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:69
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:77
|
||||
msgid "Adjusting the matrix-alertmanager-receiver URL (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:71
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:79
|
||||
msgid "By tweaking the `matrix_alertmanager_receiver_hostname` and `matrix_alertmanager_receiver_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:73
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:81
|
||||
msgid "Example additional configuration for your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:81
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:89
|
||||
msgid "If you've changed the default hostname, you may need to create a CNAME record for the matrix-alertmanager-receiver domain (`alertmanager.example.com`), which targets `matrix.example.com`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:83
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:91
|
||||
msgid "When setting, replace `example.com` with your own."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:85
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:93
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:87
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:95
|
||||
msgid "There are some additional things you may wish to configure about the component."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:89
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:97
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:91
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:99
|
||||
msgid "`roles/custom/matrix-alertmanager-receiver/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:92
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:100
|
||||
msgid "`roles/custom/matrix-alertmanager-receiver/templates/config.yaml.j2` for the component's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_alertmanager_receiver_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:94
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:102
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:96
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:104
|
||||
msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:103
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:105
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:107
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:111
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:109
|
||||
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."
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:113
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:111
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:115
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:113
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:117
|
||||
msgid "Configure your Prometheus Alertmanager with configuration like this:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:132
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:136
|
||||
msgid "where `URL_HERE` looks like `https://matrix.example.com/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/some-room-name` or `https://matrix.example.com/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/!qporfwt:example.com`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:134
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:138
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:136
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:140
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-alertmanager-receiver`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:138
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:142
|
||||
msgid "Increase logging verbosity"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:140
|
||||
#: ../../../docs/configuring-playbook-alertmanager-receiver.md:144
|
||||
msgid "The default logging level for this component is `info`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,74 +16,66 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:1
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:8
|
||||
msgid "Setting up Appservice Double Puppet (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:3
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:10
|
||||
msgid "The playbook can install and configure the Appservice Double Puppet service for you. It is a homeserver appservice through which bridges (and potentially other services) can impersonate any user on the homeserver."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:5
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:12
|
||||
msgid "This is useful for performing [double-puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) via the appservice method. The service is an implementation of this approach."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:7
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:14
|
||||
msgid "Previously, bridges supported performing double-puppeting with the help of the [Shared Secret Auth password provider module](./configuring-playbook-shared-secret-auth.md), but this old and hacky solution has been superseded by this Appservice Double Puppet method."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:9
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:16
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:11
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:18
|
||||
msgid "To enable the Appservice Double Puppet service, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:17
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:24
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:19
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:26
|
||||
msgid "There are some additional things you may wish to configure about the service."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:21
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:28
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:23
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:30
|
||||
msgid "`roles/custom/matrix-appservice-double-puppet/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 `matrix_appservice_double_puppet_registration_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:25
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:32
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:27
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:34
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:34
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:36
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:38
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:41
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:40
|
||||
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."
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:43
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:42
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:45
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:44
|
||||
#: ../../../docs/configuring-playbook-appservice-double-puppet.md:47
|
||||
msgid "Installing the service will automatically enable double puppeting for all bridges that support double puppeting via the appservice method."
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,167 +16,167 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:1
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:8
|
||||
msgid "Setting up Draupnir for All/D4A (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:3
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:10
|
||||
msgid "The playbook can install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation tool for you in appservice mode."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:5
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:12
|
||||
msgid "Appservice mode can be used together with the regular [Draupnir bot](configuring-playbook-bot-draupnir.md) or independently. Details about the differences between the 2 modes are described below."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:7
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:14
|
||||
msgid "Draupnir Appservice mode compared to Draupnir bot mode"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:9
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:16
|
||||
msgid "The administrative functions for managing the appservice are alpha quality and very limited. However, the experience of using an appservice-provisioned Draupnir is on par with the experience of using Draupnir from bot mode except in the case of avatar customisation as described later on in this document."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:11
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:18
|
||||
msgid "Draupnir for all is the way to go if you need more than 1 Draupnir instance, but you don't need access to Synapse Admin features as they are not accessible through Draupnir for All (Even though the commands do show up in help)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:13
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:20
|
||||
msgid "Draupnir for all in the playbook is rate-limit-exempt automatically as its appservice configuration file does not specify any rate limits."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:15
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:22
|
||||
msgid "Normal Draupnir does come with the benefit of access to Synapse Admin features. You are also able to more easily customise your normal Draupnir than D4A as D4A even on the branch with the Avatar command (To be Upstreamed to Mainline Draupnir) that command is clunky as it requires the use of things like Element Web devtools. In normal Draupnir this is a quick operation where you login to Draupnir with a normal client and set Avatar and Display name normally."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:17
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:24
|
||||
msgid "Draupnir for all does not support external tooling like [MRU](https://mru.rory.gay) as it can't access Draupnir's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:19
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:26
|
||||
msgid "Prerequisites"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:21
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:28
|
||||
msgid "Create a main management room"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:23
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:30
|
||||
msgid "The playbook does not create a management room for your Main Draupnir. You **need to create the room manually** before setting up the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:25
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:32
|
||||
msgid "Note that the room must be unencrypted."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:27
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:34
|
||||
msgid "The management room has to be given an alias, and your bot has to be invited to the room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:29
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:36
|
||||
msgid "This management room is used to control who has access to your D4A deployment. The room stores this data inside of the control room state so your bot must have sufficient powerlevel to send custom state events. This is default 50 or moderator as Element clients call this powerlevel."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:31
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:38
|
||||
msgid "[!WARNING] Anyone in this room can control the bot so it is important that you only invite trusted users to this room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:34
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:41
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:36
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:43
|
||||
msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `MANAGEMENT_ROOM_ALIAS_HERE`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:44
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:51
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:46
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:53
|
||||
msgid "There are some additional things you may wish to configure about the component."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:48
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:55
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:50
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:57
|
||||
msgid "`roles/custom/matrix-appservice-draupnir-for-all/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 `matrix_appservice_draupnir_for_all_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:52
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:59
|
||||
msgid "For example, to change Draupnir's `protectAllJoinedRooms` option to `true`, add the following configuration to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:66
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:73
|
||||
msgid "You can refer to the upstream [documentation](https://github.com/the-draupnir-project/Draupnir) for more configuration documentation."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:68
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:83
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:75
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:90
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:70
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:77
|
||||
msgid "The playbook ships a full copy of the example config that does transfer to provisioned Draupnirs in the production-bots.yaml.j2 file in the template directory of the role."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:72
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:79
|
||||
msgid "Config extension does not affect the appservices config as this config is not extensible in current Draupnir anyway. It instead touches the config passed to the Draupnirs that your Appservice creates. So the example above (`protectAllJoinedRooms: true`) makes all provisioned Draupnirs protect all joined rooms."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:74
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:81
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:76
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:83
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:85
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:92
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:87
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:94
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:89
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:96
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:91
|
||||
msgid "If you made it through all the steps above and your main control room was joined by a user called `@draupnir-main:example.com` you have succesfully installed Draupnir for All and can now start using it."
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:98
|
||||
msgid "If you made it through all the steps above and your main control room was joined by a user called `@draupnir-main:example.com` you have successfully installed Draupnir for All and can now start using it."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:93
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:100
|
||||
msgid "The installation of Draupnir for all in this playbook is very much Alpha quality. Usage-wise, Draupnir for all is almost identical to Draupnir bot mode."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:95
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:102
|
||||
msgid "Granting Users the ability to use D4A"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:97
|
||||
msgid "Draupnir for all includes several security measures like that it only allows users that are on its allow list to ask for a bot. To add a user to this list we have 2 primary options. Using the chat to tell Draupnir to do this for us or if you want to automatically do it by sending `m.policy.rule.user` events that target the subject you want to allow provisioning for with the `org.matrix.mjolnir.allow` recomendation. Using the chat is recomended."
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:104
|
||||
msgid "Draupnir for all includes several security measures like that it only allows users that are on its allow list to ask for a bot. To add a user to this list we have 2 primary options. Using the chat to tell Draupnir to do this for us or if you want to automatically do it by sending `m.policy.rule.user` events that target the subject you want to allow provisioning for with the `org.matrix.mjolnir.allow` recommendation. Using the chat is recommended."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:99
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:106
|
||||
msgid "The bot requires a powerlevel of 50 in the management room to control who is allowed to use the bot. The bot does currently not say anything if this is true or false. (This is considered a bug and is documented in issue [#297](https://github.com/the-draupnir-project/Draupnir/issues/297))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:101
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:108
|
||||
msgid "To allow users or whole homeservers you type /plain !admin allow `target` and target can be either a MXID or a wildcard like `@*:example.com` to allow all users on example.com to register. We use /plain to force the client to not attempt to mess with this command as it can break Wildcard commands especially."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:103
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:110
|
||||
msgid "How to provision a D4A once you are allowed to"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:105
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:112
|
||||
msgid "To provision a D4A, you need to start a chat with `@draupnir-main:example.com`. The bot will reject this invite and you will shortly get invited to the Draupnir control room for your newly provisioned Draupnir. From here its just a normal Draupnir experience."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:107
|
||||
#: ../../../docs/configuring-playbook-appservice-draupnir-for-all.md:114
|
||||
msgid "Congratulations if you made it all the way here because you now have a fully working Draupnir for all deployment."
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,174 +16,26 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:1
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:11
|
||||
msgid "Setting up BorgBackup (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:3
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:13
|
||||
msgid "The playbook can install and configure [BorgBackup](https://www.borgbackup.org/) (short: Borg) with [borgmatic](https://torsion.org/borgmatic/) for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:5
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:15
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:7
|
||||
msgid "Prerequisites"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:9
|
||||
msgid "Set up a remote server for storing backups"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:11
|
||||
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)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:13
|
||||
msgid "Check the Postgres version"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:15
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:17
|
||||
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)."
|
||||
msgid "The [Ansible role for BorgBackup](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg) is developed and maintained by [the MASH (mother-of-all-self-hosting) project](https://github.com/mother-of-all-self-hosting). For details about configuring BorgBackup, you can check them via:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:18
|
||||
msgid "🌐 [the role's documentation at the MASH project](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg/blob/main/docs/configuring-backup-borg.md) online"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:19
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:21
|
||||
msgid "Create a new SSH key"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:23
|
||||
msgid "Run the command below on any machine to create a new SSH key:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:29
|
||||
msgid "You don't need to place the key in the `.ssh` folder."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:31
|
||||
msgid "Add the public key"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:33
|
||||
msgid "Next, add the **public** part of this SSH key (the `matrix-borg-backup.pub` file) to your BorgBackup provider/server."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:35
|
||||
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:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:45
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:47
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:49
|
||||
msgid "To enable BorgBackup, add the following configuration to your `vars.yml` file (adapt to your needs):"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:76
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:78
|
||||
msgid "Set backup archive name (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:80
|
||||
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):"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:86
|
||||
msgid "Configure retention policy (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:88
|
||||
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):"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:98
|
||||
msgid "Edit the backup schedule (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:100
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:102
|
||||
msgid "To edit the schedule, add the following configuration to your `vars.yml` file (adapt to your needs):"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:108
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:110
|
||||
msgid "Set include and/or exclude directories (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:112
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:114
|
||||
msgid "You might also want to exclude certain directories or file patterns from the backup using the `backup_borg_location_exclude_patterns` variable."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:116
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:118
|
||||
msgid "There are some additional things you may wish to configure about the component."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:120
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:122
|
||||
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"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:124
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:126
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:133
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:135
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:137
|
||||
msgid "Manually start a backup"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:139
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:141
|
||||
msgid "If you want to run it immediately, log in to the server with SSH and run `systemctl start matrix-backup-borg`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-backup-borg.md:143
|
||||
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."
|
||||
msgid "📁 `roles/galaxy/backup_borg/docs/configuring-backup-borg.md` locally, if you have [fetched the Ansible roles](installing.md#update-ansible-roles)"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,142 +16,142 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:1
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:8
|
||||
msgid "Serving the base domain (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:3
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:10
|
||||
msgid "By default, this playbook sets up services on your Matrix server (`matrix.example.com`), but has it configured so that it presents itself as the base domain (`example.com`). To have this server officially be responsible for Matrix services for the base domain (`example.com`), you need to set up server delegation / redirection."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:5
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:12
|
||||
msgid "As we discuss in [Server Delegation](howto-server-delegation.md), server delegation / redirection can be configured in either of these ways:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:7
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:14
|
||||
msgid "Setting up a `/.well-known/matrix/server` file on the base domain (`example.com`)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:8
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:15
|
||||
msgid "Setting up a `_matrix._tcp` DNS SRV record"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:10
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:17
|
||||
msgid "For simplicity reasons, this playbook recommends you to set up server delegation via a `/.well-known/matrix/server` file."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:12
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:19
|
||||
msgid "However, those who don't have a separate server to dedicate to the base domain have trouble arranging this."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:14
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:21
|
||||
msgid "Usually, there are 2 options:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:16
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:23
|
||||
msgid "either get a separate server for the base domain, just for serving the files necessary for [Server Delegation via a well-known file](howto-server-delegation.md#server-delegation-via-a-well-known-file)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:18
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:25
|
||||
msgid "or, arrange for the Matrix server to serve the base domain. This either involves you [using your own webserver](configuring-playbook-own-webserver.md) or making the integrated webserver serve the base domain for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:20
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:27
|
||||
msgid "This documentation page tells you how to do the latter. With some easy changes, we make it possible to serve the base domain from the Matrix server via the integrated webserver."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:22
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:29
|
||||
msgid "Just [**adjust your DNS records**](configuring-dns.md), so that your base domain is pointed to the Matrix server's IP address (using a DNS `A` record) **and then add the following configuration** to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:28
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:35
|
||||
msgid "Doing this, the playbook will:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:30
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:37
|
||||
msgid "obtain an SSL certificate for the base domain, just like it does for all other domains (see [how we handle SSL certificates](configuring-playbook-ssl-certificates.md))"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:32
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:39
|
||||
msgid "serve the `/.well-known/matrix/*` files which are necessary for [Federation Server Discovery](configuring-well-known.md#federation-server-discovery) (also see [Server Delegation](howto-server-delegation.md)) and [Client-Server discovery](configuring-well-known.md#client-server-discovery)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:34
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:41
|
||||
msgid "serve a simple homepage at `https://example.com` with content `Hello from example.com` (configurable via the `matrix_static_files_file_index_html_template` variable). You can also [serve a more complicated static website](#serving-a-static-website-at-the-base-domain)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:36
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:43
|
||||
msgid "Serving a static website at the base domain"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:38
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:45
|
||||
msgid "By default, when \"serving the base domain\" is enabled, the playbook hosts a simple `index.html` webpage at `/matrix/static-files/public/index.html`. The content of this page is taken from the `matrix_static_files_file_index_html_template` variable."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:40
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:47
|
||||
msgid "If you'd like to host your own static website (more than a single `index.html` page) at the base domain, you can disable the creation of this default `index.html` page like this:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:54
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:61
|
||||
msgid "With this configuration, Ansible will no longer mess around with the `/matrix/static-files/public/index.html` file."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:56
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:63
|
||||
msgid "You are then free to upload any static website files to `/matrix/static-files/public` and they will get served at the base domain. You can do so manually or by using the [ansible-role-aux](https://github.com/mother-of-all-self-hosting/ansible-role-aux) Ansible role, which is part of this playbook already."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:58
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:65
|
||||
msgid "Serving a more complicated website at the base domain"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:60
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:67
|
||||
msgid "If you'd like to serve an even more complicated (dynamic) website from the Matrix server, relying on the playbook to serve the base domain is not the best choice."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:62
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:69
|
||||
msgid "You have 2 options."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:64
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:71
|
||||
msgid "**One way is to host your base domain elsewhere**. This involves:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:65
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:72
|
||||
msgid "you stopping to serve it from the Matrix server: remove `matrix_static_files_container_labels_base_domain_enabled` from your configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:66
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:73
|
||||
msgid "[configuring Matrix Delegation via well-known](./configuring-well-known.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:68
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:75
|
||||
msgid "**Another way is to serve the base domain from another (your own) container on the Matrix server**. This involves:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:69
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:76
|
||||
msgid "telling the playbook to only serve `example.com/.well-known/matrix` files by adjusting your `vars.yml` configuration like this:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:70
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:77
|
||||
msgid "keep `matrix_static_files_container_labels_base_domain_enabled: true`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:71
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:78
|
||||
msgid "add an extra: `matrix_static_files_container_labels_base_domain_traefik_path_prefix: /.well-known/matrix`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:72
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:79
|
||||
msgid "building and running a new container on the Matrix server:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:73
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:80
|
||||
msgid "it should be connected to the `traefik` network, so that Traefik can reverse-proxy to it"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:74
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:81
|
||||
msgid "it should have appropriate [container labels](https://docs.docker.com/config/labels-custom-metadata/), which instruct Traefik to reverse-proxy to it"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:76
|
||||
#: ../../../docs/configuring-playbook-base-domain-serving.md:83
|
||||
msgid "How you'll be managing building and running this container is up-to-you. You may use of the primitives from [ansible-role-aux](https://github.com/mother-of-all-self-hosting/ansible-role-aux) Ansible role to organize it yourself, or you can set it up in another way."
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,429 +16,433 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:1
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:8
|
||||
msgid "Setting up baibot (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:8
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:15
|
||||
msgid "🤖 [baibot](https://github.com/etkecc/baibot) (pronounced bye-bot) is a [Matrix](https://matrix.org/) bot developed by [etke.cc](https://etke.cc/) that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you. 🤖"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:10
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:17
|
||||
msgid "It supports [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) models, as many well as other [☁️ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:12
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:19
|
||||
msgid "It's designed as a more private and [✨ featureful](https://github.com/etkecc/baibot/?tab=readme-ov-file#-features) alternative to [matrix-chatgpt-bot](./configuring-playbook-bot-chatgpt.md). See the [baibot](https://github.com/etkecc/baibot) project and its documentation for more information."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:14
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:21
|
||||
msgid "Prerequisites"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:16
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:23
|
||||
msgid "API access to one or more LLM [☁️ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:18
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:25
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:20
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:27
|
||||
msgid "There are **a lot of configuration options** (some required, some possibly required, some optional), so they're **split into multiple sections below**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:23
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:30
|
||||
msgid "[Base configuration](#base-configuration)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:24
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:31
|
||||
msgid "[👮♂️ Administrator configuration](#️-administrator-configuration)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:25
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:32
|
||||
msgid "[👥 Initial users configuration](#-initial-users-configuration)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:26
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:33
|
||||
msgid "[🤖 Configuring agents via Ansible](#-configuring-agents-via-ansible)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:27
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:34
|
||||
msgid "[🤝 Configuring initial default handlers](#-configuring-initial-default-handlers)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:29
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:36
|
||||
msgid "Depending on your current `vars.yml` file and desired configuration, **you may require more than just the [base configuration](#base-configuration)**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:31
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:38
|
||||
msgid "Base configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:33
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:40
|
||||
msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:71
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:78
|
||||
msgid "As mentioned above, **this may not be enough**. Continue with the configuration sections below."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:73
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:80
|
||||
msgid "👮♂️ Administrator configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:75
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:99
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:82
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:106
|
||||
msgid "This is an addition to the [base configuration](#base-configuration)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:77
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:84
|
||||
msgid "To specify who is considered a bot [👮♂️ Administrator](https://github.com/etkecc/baibot/blob/main/docs/access.md#administrators), you either need to specify `matrix_bot_baibot_config_access_admin_patterns` or `matrix_admin`. The latter is a single variable which affects all bridges and bots."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:79
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:86
|
||||
msgid "If `matrix_admin` is already configured in your `vars.yml` configuration, you can skip this section."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:81
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:110
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:88
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:117
|
||||
msgid "**If necessary**, add the following configuration to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:95
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:102
|
||||
msgid "👥 Initial users configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:97
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:104
|
||||
msgid "By default, **all users on your homeserver are considered allowed users**. If that's OK, you can skip this section."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:101
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:108
|
||||
msgid "To specify who is considered a bot [👥 User](https://github.com/etkecc/baibot/blob/main/docs/access.md#user), you may:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:103
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:110
|
||||
msgid "define an **initial** value for `matrix_bot_baibot_config_initial_global_config_user_patterns` Ansible variable, as shown below"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:104
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:111
|
||||
msgid "configure the list at runtime via the bot's `!bai access set-users SPACE_SEPARATED_PATTERNS` command"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:106
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:113
|
||||
msgid "Configuring `matrix_bot_baibot_config_initial_global_config_user_patterns` is optional, but it can be useful to pre-configure the bot with a list of users who should have access to the bot's features."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:108
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:115
|
||||
msgid "**Note**: Once initially configured, the allowed users list **cannot be managed via Ansible anymore**. It can only be managed subsequently via bot commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:122
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:129
|
||||
msgid "🤖 Configuring agents via Ansible"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:124
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:131
|
||||
msgid "You are **not required** to define agents [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration) via Ansible. **To get started quickly**, you can **skip this section and define agents at runtime via chat commands** (following the bot's guidance)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:126
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:133
|
||||
msgid "Privileged users (like the [👮♂️ Administrator](#️-administrator-configuration), but potentially others too — see the upstream [🔒 access](https://github.com/etkecc/baibot/blob/main/docs/access.md) documentation) can **define agents dynamically at any time** via chat commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:128
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:135
|
||||
msgid "The Ansible role includes preset variables for easily enabling some [🤖 agents](https://github.com/etkecc/baibot/blob/main/docs/agents.md) on various [☁️ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md) (e.g. OpenAI, etc)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:130
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:137
|
||||
msgid "Besides the presets, the Ansible role also includes support for configuring additional statically-defined agents via the `matrix_bot_baibot_config_agents_static_definitions_custom` Ansible variable."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:132
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:139
|
||||
msgid "Agents defined statically and those created dynamically (via chat) are named differently, so **conflict cannot arise**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:134
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:141
|
||||
msgid "Depending on your propensity for [GitOps](https://en.wikipedia.org/wiki/DevOps#GitOps), you may prefer to define agents statically via Ansible, or you may wish to do it dynamically via chat."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:136
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:143
|
||||
msgid "Before proceeding, we recommend reading the upstream documentation on [How to choose a provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#how-to-choose-a-provider). In short, it's probably best to go with [OpenAI](#openai)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:138
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:145
|
||||
msgid "Anthropic"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:140
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:147
|
||||
msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [Anthropic provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#anthropic) with the help of the playbook's preset variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:142
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:166
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:197
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:225
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:149
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:173
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:204
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:232
|
||||
msgid "Here's an example **addition** to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:158
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:189
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:215
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:243
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:165
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:196
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:222
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:250
|
||||
msgid "If you'd like to use more than one model, take a look at the [Configuring additional agents (without a preset)](#configuring-additional-agents-without-a-preset) section below."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:160
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:191
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:217
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:245
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:167
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:198
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:224
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:252
|
||||
msgid "💡 You may also wish to use this new agent for [🤝 Configuring initial default handlers](#-configuring-initial-default-handlers)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:162
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:169
|
||||
msgid "Groq"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:164
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:171
|
||||
msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [Groq provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#groq) with the help of the playbook's preset variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:187
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:194
|
||||
msgid "Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/groq`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:193
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:200
|
||||
msgid "Mistral"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:195
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:202
|
||||
msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [🇫🇷 Mistral provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#mistral) with the help of the playbook's preset variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:213
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:220
|
||||
msgid "Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/mistral`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:219
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:226
|
||||
msgid "OpenAI"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:221
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:228
|
||||
msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [OpenAI provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#openai) with the help of the playbook's preset variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:223
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:230
|
||||
msgid "The OpenAI provider is **only meant to be used with OpenAI's official API** and compatibility with other services (which do not fully adhere to the OpenAI API spec completely) is limited. **If you're targeting an OpenAI-compatible service**, use the [OpenAI Compatible](#openai-compatible) provider instead."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:241
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:248
|
||||
msgid "Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/openai`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:247
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:254
|
||||
msgid "OpenAI Compatible"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:249
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:256
|
||||
msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [OpenAI Compatible provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#openai-compatible) with the help of the playbook's preset variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:251
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:258
|
||||
msgid "This provider allows you to use OpenAI-compatible API services like [OpenRouter](https://github.com/etkecc/baibot/blob/main/docs/providers.md#openrouter), [Together AI](https://github.com/etkecc/baibot/blob/main/docs/providers.md#together-ai), etc."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:253
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:260
|
||||
msgid "Some of these popular services already have **shortcut** providers (see [supported providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md#supported-providers) leading to this one behind the scenes — this make it easier to get started."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:255
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:262
|
||||
msgid "As of this moment, the playbook does not include presets for any of these services, so you'll need to [Configuring additional agents (without a preset)](#configuring-additional-agents-without-a-preset)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:257
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:264
|
||||
msgid "Configuring additional agents (without a preset)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:259
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:266
|
||||
msgid "The Ansible role may be lacking preset variables for some [☁️ provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md), or you may wish to statically-define an agent on the same provider twice (or more) with different configuration."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:261
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:268
|
||||
msgid "It's possible to inject your own agent configuration using the `matrix_bot_baibot_config_agents_static_definitions_custom` Ansible variable."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:263
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:270
|
||||
msgid "You can also define providers at runtime, by chatting with the bot, so using Ansible is not a requirement."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:265
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:272
|
||||
msgid "Below is an an **example** demonstrating **statically-defining agents via Ansible without using presets**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:304
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:311
|
||||
msgid "Because these are [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agents, they will be given a `static/` ID prefix and will be named `static/my-openai-gpt-3.5-turbo-agent` and `static/my-ollama-agent`, respectively."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:306
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:313
|
||||
msgid "💡 To figure out what to put in the `config` section, refer to the [☁️ provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md) page, which contains **sample configuration YAML for each provider**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:308
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:315
|
||||
msgid "As with any [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md), defining them means they exist. To actually make use of them, they need to be configured as handlers globally or in a specific room — see [Mixing & matching models](https://github.com/etkecc/baibot/blob/main/docs/features.md#mixing--matching-models)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:310
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:317
|
||||
msgid "💡 You may also wish to use these new agents for [🤝 Configuring initial default handlers](#-configuring-initial-default-handlers)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:312
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:319
|
||||
msgid "🤝 Configuring initial default handlers"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:314
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:321
|
||||
msgid "This section is only useful if you're [🤖 Configuring agents via Ansible](#-configuring-agents-via-ansible), as it lets you put these agents to use as soon as the bot starts (by adjusting the bot's **initial global configuration**)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:316
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:323
|
||||
msgid "If you're not configuring agents via Ansible, you can skip this section."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:318
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:325
|
||||
msgid "This section is only useful the first time around. **Once initially configured the global configuration cannot be managed Ansible**, but only via bot commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:320
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:327
|
||||
msgid "baibot supports [various purposes](https://github.com/etkecc/baibot/blob/main/docs/features.md):"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:322
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:329
|
||||
msgid "[💬 text-generation](https://github.com/etkecc/baibot/blob/main/docs/features.md#-text-generation): communicating with you via text"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:324
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:331
|
||||
msgid "[🦻 speech-to-text](https://github.com/etkecc/baibot/blob/main/docs/features.md#-speech-to-text): turning your voice messages into text"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:326
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:333
|
||||
msgid "[🗣️ text-to-speech](https://github.com/etkecc/baibot/blob/main/docs/features.md#-text-to-speech): turning bot or users text messages into voice messages"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:328
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:335
|
||||
msgid "[🖌️ image-generation](https://github.com/etkecc/baibot/blob/main/docs/features.md#-image-generation): generating images based on instructions"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:330
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:337
|
||||
msgid "❓ catch-all: special purposes, indicating use as a fallback (when no specific handler is configured)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:332
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:339
|
||||
msgid "[Mixing & matching models](https://github.com/etkecc/baibot/blob/main/docs/features.md#mixing--matching-models) is made possible by the bot's ability to have different [🤝 handlers](https://github.com/etkecc/baibot/blob/main/docs/configuration/handlers.md) configured for different purposes."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:334
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:341
|
||||
msgid "This configuration can be done as a global fallback, or per-room. Both of these [🛠️ configurations](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md) are managed at runtime (viat chat), but **the global configuration can have some initial defaults configured via Ansible**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:336
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:343
|
||||
msgid "You can configure the **initial values** for these via Ansible, via the `matrix_bot_baibot_config_initial_global_config_handler_*` variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:338
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:345
|
||||
msgid "Example **additional** `vars.yml` configuration:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:355
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:362
|
||||
msgid "**Note**: these are initial defaults for the bot's global configuration. As such, changing any of these values subsequently has no effect on the bot's behavior. **Once initially configured the global configuration cannot be managed Ansible**, but only via bot commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:357
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:364
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:359
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:366
|
||||
msgid "There are some additional things you may wish to configure about the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:361
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:368
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:363
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:370
|
||||
msgid "`roles/custom/matrix-bot-baibot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:364
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:371
|
||||
msgid "`roles/custom/matrix-bot-baibot/templates/config.yaml.j2` for the bot's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_baibot_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:366
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:373
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:368
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:375
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:375
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:382
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:377
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:384
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:379
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:386
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:381
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:388
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:383
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:390
|
||||
msgid "If you change the bot password (`matrix_bot_baibot_config_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_baibot_config_user_password` to let the bot know its new password."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:385
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:392
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:387
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:394
|
||||
msgid "To use the bot, invite it to any existing Matrix room (`/invite @baibot:example.com` where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:389
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:396
|
||||
msgid "If you're an allowed bot [👥 user](https://github.com/etkecc/baibot/blob/main/docs/access.md#user) (see [👥 Initial users configuration](#-initial-users-configuration)), the bot will accept your invitation and join the room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:391
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:398
|
||||
msgid "After joining, the bot will introduce itself and show information about the [✨ features](https://github.com/etkecc/baibot/blob/main/docs/features.md) that are enabled for it."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:393
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:400
|
||||
msgid "If you've [🤖 configured one or more agents via Ansible](#-configuring-agents-via-ansible) and have [🤝 configured initial default handlers](#configuring-initial-default-handlers), the bot will immediately be able to make use of these agents for this new room. Otherwise, you will need to configure agents and/or handlers via chat commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:395
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:402
|
||||
msgid "Send `!bai help` to the bot in the room to see the available commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:397
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:404
|
||||
msgid "You can also refer to the upstream [baibot](https://github.com/etkecc/baibot) project's documentation."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:399
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:406
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:401
|
||||
msgid "As with all other services, you can find service logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by running something like `journalctl -fu matrix-bot-baibot`"
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:408
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-baibot`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:403
|
||||
msgid "The default logging level for this service is `info`, but you can increase it to `debug` (or even `trace`) with the following additional configuration:"
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:410
|
||||
msgid "Increase logging verbosity"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:417
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:412
|
||||
msgid "The default logging level for this service is `info`. If you want to increase the verbosity to `debug` (or even `trace`), add the following configuration to your `vars.yml` file and re-run the playbook:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:426
|
||||
msgid "**Alternatively**, you can use a single variable to set the logging level for all of the above (bot + all libraries):"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,154 +16,154 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:1
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:9
|
||||
msgid "Setting up Buscarron (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:3
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:11
|
||||
msgid "The playbook can install and configure [Buscarron](https://github.com/etkecc/buscarron) for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:5
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:13
|
||||
msgid "Buscarron is bot that receives HTTP POST submissions of web forms and forwards them to a Matrix room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:7
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:15
|
||||
msgid "See the project's [documentation](https://github.com/etkecc/buscarron/blob/main/README.md) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:9
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:17
|
||||
msgid "Adjusting DNS records"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:11
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:19
|
||||
msgid "By default, this playbook installs Buscarron on the `buscarron.` subdomain (`buscarron.example.com`) and requires you to create a CNAME record for `buscarron`, which targets `matrix.example.com`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:13
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:21
|
||||
msgid "When setting, replace `example.com` with your own."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:15
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:23
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:17
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:25
|
||||
msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:40
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:48
|
||||
msgid "Adjusting the Buscarron URL (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:42
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:50
|
||||
msgid "By tweaking the `matrix_bot_buscarron_hostname` and `matrix_bot_buscarron_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:44
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:52
|
||||
msgid "Example additional configuration for your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:55
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:63
|
||||
msgid "After changing the domain, **you may need to adjust your DNS** records to point the Buscarron domain to the Matrix server."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:57
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:65
|
||||
msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:59
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:67
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:61
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:69
|
||||
msgid "There are some additional things you may wish to configure about the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:63
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:71
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:65
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:73
|
||||
msgid "`roles/custom/matrix-bot-buscarron/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:67
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:75
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:69
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:77
|
||||
msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:76
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:84
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:78
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:86
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:80
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:88
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:82
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:90
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:84
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:92
|
||||
msgid "If you change the bot password (`matrix_bot_buscarron_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_buscarron_password` to let the bot know its new password."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:86
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:94
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:88
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:96
|
||||
msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.buscarron:example.com` where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:90
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:98
|
||||
msgid "After the bot joins the room, anyone can call the web form via HTTP POST method."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:92
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:100
|
||||
msgid "Here is an example for the `contact` form:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:100
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:108
|
||||
msgid "**Note**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:102
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:110
|
||||
msgid "you hit the homepage (HTTP `GET` request to `/`)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:103
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:111
|
||||
msgid "you submit a form to the wrong URL (`POST` request to `/non-existing-form`)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:104
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:112
|
||||
msgid "`hasemail` is enabled for the form (like in the example above) and you don't submit an `email` field"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:106
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:114
|
||||
msgid "If you get banned, you'd need to restart the process by running the playbook with `--tags=start` or running `systemctl restart matrix-bot-buscarron` on the server."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:108
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:116
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:110
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:118
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-buscarron`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:112
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:120
|
||||
msgid "Increase logging verbosity"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:114
|
||||
#: ../../../docs/configuring-playbook-bot-buscarron.md:122
|
||||
msgid "The default logging level for this component is `INFO`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,110 +16,134 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:1
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:9
|
||||
msgid "Setting up matrix-bot-chatgpt (optional, unmaintained)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:3
|
||||
msgid "**Note**: [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) is now an archived (**unmaintained**) project. Talking to ChatGPT (and many other LLM providers) can happen via the much more featureful [baibot](https://github.com/etkecc/baibot), which can be installed using [this playbook](configuring-playbook-bot-baibot.md). Consider using that bot instead of this one."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:5
|
||||
msgid "The playbook can install and configure [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:7
|
||||
msgid "Talk to [ChatGPT](https://openai.com/blog/chatgpt/) via your favourite Matrix client!"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:9
|
||||
msgid "Prerequisites"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:11
|
||||
msgid "Obtain an OpenAI API key"
|
||||
msgid "**Note**: [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) is now an archived (**unmaintained**) project. Talking to ChatGPT (and many other LLM providers) can happen via the much more featureful [baibot](https://github.com/etkecc/baibot), which can be [installed using this playbook](configuring-playbook-bot-baibot.md). Consider using that bot instead of this one."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:13
|
||||
msgid "To use the bot, you'd need to obtain an API key from [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys)."
|
||||
msgid "The playbook can install and configure [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:15
|
||||
msgid "Register the bot account"
|
||||
msgid "Talk to [ChatGPT](https://openai.com/blog/chatgpt/) via your favourite Matrix client!"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:17
|
||||
msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot."
|
||||
msgid "See the project's [documentation](https://github.com/matrixgpt/matrix-chatgpt-bot/blob/main/README.md) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:19
|
||||
msgid "Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`."
|
||||
msgid "Prerequisites"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:21
|
||||
msgid "You can use the playbook to [register a new user](registering-users.md):"
|
||||
msgid "Obtain an OpenAI API key"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:23
|
||||
msgid "To use the bot, you'd need to obtain an API key from [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:25
|
||||
msgid "Register the bot account"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:27
|
||||
msgid "Obtain an access token and create encryption keys"
|
||||
msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:29
|
||||
msgid "The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)."
|
||||
msgid "Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:31
|
||||
msgid "You can use the playbook to [register a new user](registering-users.md):"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:37
|
||||
msgid "Obtain an access token and create encryption keys"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:39
|
||||
msgid "The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:41
|
||||
msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:34
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:44
|
||||
msgid "To make sure the bot can read encrypted messages, it will need an encryption key, just like any other new user. While obtaining the access token, follow the prompts to setup a backup key. More information can be found in the [Element documentation](https://element.io/help#encryption6)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:36
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:46
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:38
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:48
|
||||
msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `API_KEY_HERE` with the API key retrieved [here](#obtain-an-openai-api-key) and `ACCESS_TOKEN_HERE` with the access token created [here](#obtain-an-access-token-and-create-encryption-keys), respectively."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:55
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:65
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:67
|
||||
msgid "There are some additional things you may wish to configure about the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:69
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:71
|
||||
msgid "`roles/custom/matrix-bot-chatgpt/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:73
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:57
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:75
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:64
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:82
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:66
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:84
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:68
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:86
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:70
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:88
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:72
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:90
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:74
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:92
|
||||
msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.chatgpt:example.com` where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:76
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:94
|
||||
msgid "After the bot joins the room, you can send a message to it. When you do so, use the prefix if you configured it or mention the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:78
|
||||
msgid "You can also refer to the upstream [documentation](https://github.com/matrixgpt/matrix-chatgpt-bot)."
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:96
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-chatgpt.md:98
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-chatgpt`."
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,390 +16,419 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:1
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:10
|
||||
msgid "Setting up Draupnir (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:3
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:12
|
||||
msgid "The playbook can install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation bot for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:5
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:14
|
||||
msgid "See the project's [documentation](https://the-draupnir-project.github.io/draupnir-documentation/) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:7
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:16
|
||||
msgid "This documentation page is about installing Draupnir in bot mode. As an alternative, you can run a multi-instance Draupnir deployment by installing [Draupnir in appservice mode](./configuring-playbook-appservice-draupnir-for-all.md) (called Draupnir-for-all) instead."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:9
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:18
|
||||
msgid "If your migrating from [Mjolnir](configuring-playbook-bot-mjolnir.md), skip to [this section](#migrating-from-mjolnir-only-required-if-migrating)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:11
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:20
|
||||
msgid "Prerequisites"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:13
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:22
|
||||
msgid "Create a management room"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:15
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:24
|
||||
msgid "Using your own account, create a new invite only room that you will use to manage the bot. This is the room where you will see the status of the bot and where you will send commands to the bot, such as the command to ban a user from another room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:17
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:26
|
||||
msgid "[!WARNING] Anyone in this room can control the bot so it is important that you only invite trusted users to this room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:20
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:29
|
||||
msgid "It is possible to make the management room encrypted (E2EE). If doing so, then you need to enable the native E2EE support (see [below](#native-e2ee-support))."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:22
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:31
|
||||
msgid "Once you have created the room you need to copy the room ID so you can specify it on your `inventory/host_vars/matrix.example.com/vars.yml` file. In Element Web you can check the ID by going to the room's settings and clicking \"Advanced\". The room ID will look something like `!qporfwt:example.com`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:24
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:33
|
||||
msgid "End-to-End Encryption support"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:26
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:35
|
||||
msgid "Decide whether you want to support having an encrypted management room or not. Draupnir can still protect encrypted rooms without encryption support enabled."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:28
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:37
|
||||
msgid "Refer to Draupnir's [documentation](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#protecting-encrypted-rooms) for more details about why you might want to care about encryption support for protected rooms."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:30
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:39
|
||||
msgid "Disable Pantalaimon for Draupnir (since v2.0.0; optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:32
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:41
|
||||
msgid "It is known that running Draupnir along with Pantalaimon breaks all workflows that involve answering prompts with reactions."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:34
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:43
|
||||
msgid "If you are updating Draupnir from v1.x.x and have enabled Pantalaimon for it, you can disable Pantalaimon in favor of the native E2EE support. To disable Pantalaimon, remove the configuration `matrix_bot_draupnir_pantalaimon_use: true` from your `vars.yml` file."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:36
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:45
|
||||
msgid "**Note**: because the management room is still encrypted, disabling it without enabling the native E2EE support will break the management room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:38
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:47
|
||||
msgid "Native E2EE support"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:40
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:49
|
||||
msgid "To enable the native E2EE support, you need to obtain an access token for Draupnir and set it on your `vars.yml` file."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:42
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:51
|
||||
msgid "Note that native E2EE requires a clean access token that has not touched E2EE so curl is recommended as a method to obtain it. **The access token obtained via Element Web does not work with it**. Refer to the documentation on [how to obtain an access token via curl](obtaining-access-tokens.md#obtain-an-access-token-via-curl)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:44
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:53
|
||||
msgid "To enable the native E2EE support, add the following configuration to your `vars.yml` file. Make sure to replace `CLEAN_ACCESS_TOKEN_HERE` with the access token you obtained just now."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:55
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:64
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:57
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:66
|
||||
msgid "To enable the bot, add the following configuration to your `vars.yml` file. Make sure to replace `MANAGEMENT_ROOM_ID_HERE` with the one of the room which you have created earlier."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:76
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:85
|
||||
msgid "Create and invite the bot to the management room"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:78
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:87
|
||||
msgid "Before proceeding to the next step, run the playbook with the following command to create the bot user."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:84
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:93
|
||||
msgid "**Note**: the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:86
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:95
|
||||
msgid "Then, invite the bot (`@bot.draupnir:example.com`) to its management room which you have created earlier."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:88
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:97
|
||||
msgid "Make sure the account is free from rate limiting (optional, recommended)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:90
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:99
|
||||
msgid "If your homeserver's implementation is Synapse, you will need to prevent it from rate limiting the bot's account. **This is a highly recommended step. If you do not configure it, Draupnir performance will be degraded.**"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:92
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:101
|
||||
msgid "This can be done using Synapse's [Admin APIs](https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#override-ratelimiting-for-users). They can be accessed both externally and internally."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:94
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:103
|
||||
msgid "**Note**: access to the APIs is restricted with a valid access token, so exposing them publicly should not be a real security concern. Still, doing so is not recommended for additional security. See [official Synapse reverse-proxying recommendations](https://element-hq.github.io/synapse/latest/reverse_proxy.html#synapse-administration-endpoints)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:96
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:105
|
||||
msgid "The APIs can also be accessed via [Synapse Admin](https://github.com/etkecc/synapse-admin), a web UI tool you can use to administrate users, rooms, media, etc. on your Matrix server. The playbook can install and configure Synapse Admin for you. For details about it, see [this page](configuring-playbook-synapse-admin.md)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:98
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:107
|
||||
msgid "Add the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:100
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:109
|
||||
msgid "To expose the APIs publicly, add the following configuration to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:106
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:115
|
||||
msgid "Obtain an access token for admin account"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:108
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:117
|
||||
msgid "Manual access to Synapse's Admin APIs requires an access token for a homeserver admin account. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:110
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:119
|
||||
msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:113
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:122
|
||||
msgid "Run the `curl` command"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:115
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:124
|
||||
msgid "To disable rate limiting, run the following command on systems that ship curl. Before running it, make sure to replace:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:117
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:126
|
||||
msgid "`ADMIN_ACCESS_TOKEN_HERE` with the access token of the admin account"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:118
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:127
|
||||
msgid "`example.com` with your base domain"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:119
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:128
|
||||
msgid "`@bot.draupnir:example.com` with the MXID of your Draupnir bot user"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:125
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:134
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:207
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:126
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:135
|
||||
msgid "This does not work on outdated Windows 10 as curl is not available there."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:127
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:136
|
||||
msgid "Even if the APIs are not exposed to the internet, you should still be able to run the command on the homeserver locally."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:129
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:138
|
||||
msgid "Abuse Reports"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:131
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:140
|
||||
msgid "Draupnir can receive reports in the management room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:133
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:142
|
||||
msgid "The bot can intercept the report API endpoint of the client-server API, which requires integration with the reverse proxy in front of the homeserver. If you are using Traefik, this playbook can set this up for you:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:145
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:148
|
||||
msgid "Enabling synapse-http-antispam support"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:150
|
||||
msgid "Certain protections in Draupnir require the [synapse-http-antispam](https://github.com/maunium/synapse-http-antispam) module and a Synapse homeserver plus homeserver admin status to function. This module can be enabled in the playbook via setting `matrix_bot_draupnir_config_web_synapseHTTPAntispam_enabled` to `true` and making sure that Draupnir admin API access is enabled."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:160
|
||||
msgid "These protections need to be manually activated and consulting the [enabling protections](#enabling-built-in-protections) guide can be helpful or consulting upstream documentation."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:168
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:147
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:170
|
||||
msgid "There are some additional things you may wish to configure about the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:149
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:172
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:151
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:174
|
||||
msgid "`roles/custom/matrix-bot-draupnir/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 `matrix_bot_draupnir_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:153
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:176
|
||||
msgid "For example, to change Draupnir's `acceptInvitesFromSpace` option to `!qporfwt:example.com`, add the following configuration to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:167
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:190
|
||||
msgid "Migrating from Mjolnir (Only required if migrating)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:169
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:192
|
||||
msgid "Replace your `matrix_bot_mjolnir` config with `matrix_bot_draupnir` config. Also disable Mjolnir if you're doing migration."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:171
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:194
|
||||
msgid "Note that Draupnir supports E2EE natively, so you can enable it instead of Pantalaimon. It is recommended to consult the instruction [here](#native-e2ee-support)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:173
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:196
|
||||
msgid "That is all you need to do due to that Draupnir can complete migration on its own."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:175
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:198
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:177
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:200
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:184
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:209
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:211
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:186
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:213
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:188
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:215
|
||||
msgid "If you change the bot password (`matrix_bot_draupnir_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_draupnir_password` to let the bot know its new password."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:217
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:190
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:219
|
||||
msgid "You can refer to the upstream [documentation](https://the-draupnir-project.github.io/draupnir-documentation/) for additional ways to use and configure Draupnir and for a more detailed usage guide."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:192
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:221
|
||||
msgid "Below is a **non-exhaustive quick-start guide** for the impatient."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:194
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:223
|
||||
msgid "Making Draupnir join and protect a room"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:196
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:225
|
||||
msgid "Draupnir can be told to self-join public rooms, but it's better to follow this flow which works well for all kinds of rooms:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:198
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:227
|
||||
msgid "Invite the bot to the room manually ([inviting Draupnir to rooms](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#inviting-draupnir-to-rooms)). Before joining, the bot *may* ask for confirmation in the Management Room"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:200
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:229
|
||||
msgid "[Give the bot permissions to do its job](#giving-draupnir-permissions-to-do-its-job)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:202
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:231
|
||||
msgid "Tell it to protect the room (using the [rooms command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#using-the-draupnir-rooms-command)) by sending the following command to the Management Room: `!draupnir rooms add !qporfwt:example.com`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:204
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:233
|
||||
msgid "To have Draupnir provide useful room protection, you need do to a bit more work (at least the first time around). You may wish to [Subscribe to a public policy list](#subscribing-to-a-public-policy-list), [Create your own own policy and rules](#creating-your-own-policy-lists-and-rules) and [Enabling built-in protections](#enabling-built-in-protections)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:206
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:235
|
||||
msgid "Giving Draupnir permissions to do its job"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:208
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:237
|
||||
msgid "For Draupnir to do its job, you need to [give it permissions](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#giving-draupnir-permissions) in rooms it's protecting. This involves **giving it an Administrator power level**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:210
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:239
|
||||
msgid "**We recommend setting this power level as soon as the bot joins your room** (and before you create new rules), so that it can apply rules as soon as they are available. If the bot is under-privileged, it may fail to apply protections and may not retry for a while (or until your restart it)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:212
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:241
|
||||
msgid "Subscribing to a public policy list"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:214
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:243
|
||||
msgid "We recommend **subscribing to a public [policy list](https://the-draupnir-project.github.io/draupnir-documentation/concepts/policy-lists)** using the [watch command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-policy-lists#using-draupnirs-watch-command-to-subscribe-to-policy-rooms)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:216
|
||||
msgid "Polcy lists are maintained in Matrix rooms. A popular policy list is maintained in the public `#community-moderation-effort-bl:neko.dev` room."
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:245
|
||||
msgid "Policy lists are maintained in Matrix rooms. Popular ones maintained in the public are:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:218
|
||||
msgid "You can tell Draupnir to subscribe to it by sending the following command to the Management Room: `!draupnir watch #community-moderation-effort-bl:neko.dev`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:220
|
||||
msgid "Creating your own policy lists and rules"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:222
|
||||
msgid "We also recommend **creating your own policy lists** with the [list create](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-policy-lists#using-draupnirs-list-create-command-to-create-a-policy-room) command."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:224
|
||||
msgid "You can do so by sending the following command to the Management Room: `!draupnir list create my-bans my-bans-bl`. This will create a policy list having a name (shortcode) of `my-bans` and stored in a public `#my-bans-bl:example.com` room on your server. As soon as you run this command, the bot will invite you to the policy list room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:226
|
||||
msgid "A policy list does nothing by itself, so the next step is **adding some rules to your policy list**. Policies target a so-called `entity` (one of: `user`, `room` or `server`). These entities are mentioned on the [policy lists](https://the-draupnir-project.github.io/draupnir-documentation/concepts/policy-lists) documentation page and in the Matrix Spec [here](https://spec.matrix.org/v1.11/client-server-api/#mban-recommendation)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:228
|
||||
msgid "The simplest and most useful entity to target is `user`. Below are a few examples using the [ban command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#the-ban-command) and targeting users."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:230
|
||||
msgid "To create rules, you run commands in the Management Room (**not** in the policy list room)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:232
|
||||
msgid "(ban a single user on a given homeserver): `!draupnir ban @charles:example.com my-bans Rude to others`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:233
|
||||
msgid "(ban all users on a given homeserver by using a [wildcard](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#wildcards)): `!draupnir ban @*:example.org my-bans Spam server - all users are fake`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:235
|
||||
msgid "As a result of running these commands, you may observe:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:237
|
||||
msgid "Draupnir creating `m.policy.rule.user` state events in the `#my-bans-bl:example.com` room on your server"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:238
|
||||
msgid "applying these rules against all rooms that Draupnir is an Administrator in"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:240
|
||||
msgid "You can undo bans with the [unban command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#the-unban-command)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:242
|
||||
msgid "Enabling built-in protections"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:244
|
||||
msgid "You can also **turn on various built-in [protections](https://the-draupnir-project.github.io/draupnir-documentation/protections)** like `JoinWaveShortCircuit` (\"If X amount of users join in Y time, set the room to invite-only\")."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:246
|
||||
msgid "To **see which protections are available and which are enabled**, send a `!draupnir protections` command to the Management Room."
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:247
|
||||
msgid "`#community-moderation-effort-bl:neko.dev`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:248
|
||||
msgid "To **see the configuration options for a given protection**, send a `!draupnir protections show PROTECTION_NAME` (e.g. `!draupnir protections show JoinWaveShortCircuit`)."
|
||||
msgid "`#huginn-muninn-active-threats:feline.support`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:250
|
||||
msgid "To **set a specific option for a given protection**, send a command like this: `!draupnir config set PROTECTION_NAME.OPTION VALUE` (e.g. `!draupnir config set JoinWaveShortCircuit.timescaleMinutes 30`)."
|
||||
msgid "You can tell Draupnir to subscribe to each of these by sending the following command to the Management Room: `!draupnir watch POLICY_LIST_ADDRESS_HERE` (e.g. `!draupnir watch #community-moderation-effort-bl:neko.dev`)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:252
|
||||
msgid "To **enable a given protection**, send a command like this: `!draupnir enable PROTECTION_NAME` (e.g. `!draupnir enable JoinWaveShortCircuit`)."
|
||||
msgid "Creating your own policy lists and rules"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:254
|
||||
msgid "To **disable a given protection**, send a command like this: `!draupnir disable PROTECTION_NAME` (e.g. `!draupnir disable JoinWaveShortCircuit`)."
|
||||
msgid "We also recommend **creating your own policy lists** with the [list create](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-policy-lists#using-draupnirs-list-create-command-to-create-a-policy-room) command."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:256
|
||||
msgid "You can do so by sending the following command to the Management Room: `!draupnir list create my-bans my-bans-bl`. This will create a policy list having a name (shortcode) of `my-bans` and stored in a public `#my-bans-bl:example.com` room on your server. As soon as you run this command, the bot will invite you to the policy list room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:258
|
||||
msgid "A policy list does nothing by itself, so the next step is **adding some rules to your policy list**. Policies target a so-called `entity` (one of: `user`, `room` or `server`). These entities are mentioned on the [policy lists](https://the-draupnir-project.github.io/draupnir-documentation/concepts/policy-lists) documentation page and in the Matrix Spec [here](https://spec.matrix.org/v1.11/client-server-api/#mban-recommendation)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:260
|
||||
msgid "The simplest and most useful entity to target is `user`. Below are a few examples using the [ban command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#the-ban-command) and targeting users."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:262
|
||||
msgid "To create rules, you run commands in the Management Room (**not** in the policy list room)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:264
|
||||
msgid "(ban a single user on a given homeserver): `!draupnir ban @charles:example.com my-bans Rude to others`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:265
|
||||
msgid "(ban all users on a given homeserver by using a [wildcard](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#wildcards)): `!draupnir ban @*:example.org my-bans Spam server, all users are fake`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:267
|
||||
msgid "As a result of running these commands, you may observe:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:269
|
||||
msgid "Draupnir creating `m.policy.rule.user` state events in the `#my-bans-bl:example.com` room on your server"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:270
|
||||
msgid "applying these rules against all rooms that Draupnir is an Administrator in"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:272
|
||||
msgid "You can undo bans with the [unban command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#the-unban-command)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:274
|
||||
msgid "Enabling built-in protections"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:276
|
||||
msgid "You can also **turn on various built-in [protections](https://the-draupnir-project.github.io/draupnir-documentation/protections)** like `JoinWaveShortCircuitProtection` (\"If X amount of users join in Y time, set the room to invite-only\")."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:278
|
||||
msgid "To **see which protections are available and which are enabled**, send a `!draupnir protections` command to the Management Room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:280
|
||||
msgid "To [**see the configuration options for a given protection**](https://the-draupnir-project.github.io/draupnir-documentation/protections/configuring-protections#displaying-the-protection-settings), send a `!draupnir protections show PROTECTION_NAME` (e.g. `!draupnir protections show JoinWaveShortCircuitProtection`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:282
|
||||
msgid "To [**set a specific option for a given protection**](https://the-draupnir-project.github.io/draupnir-documentation/protections/configuring-protections#changing-protection-settings), send a command like this: `!draupnir protections config set PROTECTION_NAME OPTION VALUE` (e.g. `!draupnir protections config set JoinWaveShortCircuitProtection timescaleMinutes 30`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:284
|
||||
msgid "To [**enable a given protection**](https://the-draupnir-project.github.io/draupnir-documentation/protections/block-invitations-on-server-protection#enabling-the-protection), send a command like this: `!draupnir protections enable PROTECTION_NAME` (e.g. `!draupnir protections enable JoinWaveShortCircuitProtection`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-draupnir.md:286
|
||||
msgid "To **disable a given protection**, send a command like this: `!draupnir protections disable PROTECTION_NAME` (e.g. `!draupnir protections disable JoinWaveShortCircuitProtection`)."
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,138 +16,158 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:1
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:11
|
||||
msgid "Setting up Go-NEB (optional, unmaintained)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:3
|
||||
msgid "**Note**: [Go-NEB](https://github.com/matrix-org/go-neb) is now an archived (**unmaintained**) project. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bot instead of this one."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:5
|
||||
msgid "The playbook can install and configure [Go-NEB](https://github.com/matrix-org/go-neb) for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:7
|
||||
msgid "Go-NEB is a Matrix bot written in Go. It is the successor to Matrix-NEB, the original Matrix bot written in Python."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:9
|
||||
msgid "See the project's [documentation](https://github.com/matrix-org/go-neb/blob/master/README.md) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:11
|
||||
msgid "Prerequisites"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:13
|
||||
msgid "Register the bot account"
|
||||
msgid "**Note**: [Go-NEB](https://github.com/matrix-org/go-neb) is now an archived (**unmaintained**) project. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be [installed using this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bot instead of this one."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:15
|
||||
msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot."
|
||||
msgid "The playbook can install and configure [Go-NEB](https://github.com/matrix-org/go-neb) for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:17
|
||||
msgid "Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`."
|
||||
msgid "Go-NEB is a Matrix bot written in Go. It is the successor to Matrix-NEB, the original Matrix bot written in Python."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:19
|
||||
msgid "You can use the playbook to [register a new user](registering-users.md):"
|
||||
msgid "See the project's [documentation](https://github.com/matrix-org/go-neb/blob/master/README.md) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:21
|
||||
msgid "Prerequisites"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:23
|
||||
msgid "Register the bot account"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:25
|
||||
msgid "Obtain an access token"
|
||||
msgid "The playbook does not automatically create users for you. You **need to register the bot user manually** before setting up the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:27
|
||||
msgid "The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)."
|
||||
msgid "Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:29
|
||||
msgid "You can use the playbook to [register a new user](registering-users.md):"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:35
|
||||
msgid "Obtain an access token"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:37
|
||||
msgid "The bot requires an access token to be able to connect to your homeserver. Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:39
|
||||
msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:32
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:42
|
||||
msgid "Adjusting DNS records"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:34
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:44
|
||||
msgid "By default, this playbook installs Go-NEB on the `goneb.` subdomain (`goneb.example.com`) and requires you to create a CNAME record for `goneb`, which targets `matrix.example.com`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:36
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:46
|
||||
msgid "When setting, replace `example.com` with your own."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:38
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:48
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:40
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:50
|
||||
msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `ACCESS_TOKEN_FOR_GONEB_HERE` and `ACCESS_TOKEN_FOR_ANOTHER_GONEB_HERE` with the ones created [above](#obtain-an-access-token)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:204
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:214
|
||||
msgid "Adjusting the Go-NEB URL (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:206
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:216
|
||||
msgid "By tweaking the `matrix_bot_go_neb_hostname` and `matrix_bot_go_neb_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:208
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:218
|
||||
msgid "Example additional configuration for your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:219
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:229
|
||||
msgid "After changing the domain, **you may need to adjust your DNS** records to point the Go-NEB domain to the Matrix server."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:221
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:231
|
||||
msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:223
|
||||
msgid "Installing"
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:233
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:225
|
||||
msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:"
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:235
|
||||
msgid "There are some additional things you may wish to configure about the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:232
|
||||
msgid "**Notes**:"
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:237
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:234
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:236
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:238
|
||||
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."
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:239
|
||||
msgid "`roles/custom/matrix-bot-go-neb/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:240
|
||||
msgid "Usage"
|
||||
msgid "`roles/custom/matrix-bot-go-neb/templates/config.yaml.j2` for the bot's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_go_neb_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:242
|
||||
msgid "To use the bot, invite it to any existing Matrix room (`/invite @bot.go-neb:example.com` where `example.com` is your base domain, not the `matrix.` domain). Make sure you are granted with the sufficient permission if you are not the room owner."
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:244
|
||||
msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:251
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:253
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:255
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:257
|
||||
msgid "To use the bot, invite it to any existing Matrix room (`/invite @bot.go-neb:example.com` where `example.com` is your base domain, not the `matrix.` domain). Make sure you are granted with the sufficient permission if you are not the room owner."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:259
|
||||
msgid "Basic usage is like this: `!echo hi` or `!imgur puppies` or `!giphy matrix`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:246
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:261
|
||||
msgid "If you enabled the github_cmd service, send `!github help` to the bot in the room to see the available commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:248
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:263
|
||||
msgid "You can also refer to the upstream [Documentation](https://github.com/matrix-org/go-neb)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:265
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-go-neb.md:267
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-go-neb`."
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,106 +16,138 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:1
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:9
|
||||
msgid "Setting up Honoroit (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:3
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:11
|
||||
msgid "The playbook can install and configure [Honoroit](https://github.com/etkecc/honoroit) for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:5
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:13
|
||||
msgid "It's a bot you can use to setup **your own helpdesk on matrix**"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:7
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:15
|
||||
msgid "See the project's [documentation](https://github.com/etkecc/honoroit/blob/main/README.md) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:9
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:17
|
||||
msgid "Adjusting DNS records (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:11
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:19
|
||||
msgid "By default, this playbook installs Honoroit on the `matrix.` subdomain, at the `/honoroit` path (https://matrix.example.com/honoroit). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:13
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:21
|
||||
msgid "If you wish to adjust it, see the section [below](#adjusting-the-honoroit-url-optional) for details about DNS configuration."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:15
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:23
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:17
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:25
|
||||
msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:32
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:40
|
||||
msgid "Adjusting the Honoroit URL (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:34
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:42
|
||||
msgid "By tweaking the `matrix_bot_honoroit_hostname` and `matrix_bot_honoroit_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:36
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:44
|
||||
msgid "Example additional configuration for your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:44
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:52
|
||||
msgid "If you've changed the default hostname, you may need to create a CNAME record for the Honoroit domain (`honoroit.example.com`), which targets `matrix.example.com`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:46
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:54
|
||||
msgid "When setting, replace `example.com` with your own."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:48
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:56
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:58
|
||||
msgid "There are some additional things you may wish to configure about the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:60
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:62
|
||||
msgid "`roles/custom/matrix-bot-honoroit/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:64
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:50
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:66
|
||||
msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:57
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:73
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:59
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:75
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:61
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:77
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:63
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:79
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:65
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:81
|
||||
msgid "If you change the bot password (`matrix_bot_honoroit_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_honoroit_password` to let the bot know its new password."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:67
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:83
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:69
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:85
|
||||
msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @honoroit:example.com` where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:71
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:87
|
||||
msgid "After the bot joins the room, any Matrix user can send a message to it to start a new thread in that room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:73
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:89
|
||||
msgid "Send `!ho help` to the bot in the room to see the available commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:75
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:91
|
||||
msgid "You can also refer to the upstream [documentation](https://github.com/etkecc/honoroit#features)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:93
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:95
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-honoroit`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:97
|
||||
msgid "Increase logging verbosity"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-honoroit.md:99
|
||||
msgid "If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,82 +16,118 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:1
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:13
|
||||
msgid "Setting up matrix-registration-bot (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:3
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:15
|
||||
msgid "The playbook can install and configure [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:5
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:17
|
||||
msgid "The bot allows you to easily **create and manage registration tokens** aka. invitation codes. It can be used for an invitation-based server, where you invite someone by sending them a registration token (tokens look like this: `rbalQ0zkaDSRQCOp`). They can register as per normal but have to provide a valid registration token in the final step of the registration process."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:7
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:19
|
||||
msgid "See the project's [documentation](https://github.com/moan0s/matrix-registration-bot/blob/master/README.md) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:9
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:21
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:11
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:23
|
||||
msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:30
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:46
|
||||
msgid "The bot account will be created automatically."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:32
|
||||
msgid "Installing"
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:48
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:34
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:50
|
||||
msgid "There are some additional things you may wish to configure about the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:41
|
||||
msgid "**Notes**:"
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:52
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:43
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:45
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:47
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:49
|
||||
msgid "If you change the bot password (`matrix_bot_matrix_registration_bot_bot_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_registration_bot_bot_password` to let the bot know its new password."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:51
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:53
|
||||
msgid "To use the bot, start a chat with `@bot.matrix-registration-bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:54
|
||||
msgid "`roles/custom/matrix-bot-matrix-registration-bot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:55
|
||||
msgid "Send `help` to the bot to see the available commands."
|
||||
msgid "`roles/custom/matrix-bot-matrix-registration-bot/templates/config.yaml.j2` for the bridge's default configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:57
|
||||
msgid "You can also refer to the upstream [Usage documentation](https://github.com/moan0s/matrix-registration-bot#supported-commands)."
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:59
|
||||
msgid "If you have any questions, or if you need help setting it up, read the [troublshooting guide](https://github.com/moan0s/matrix-registration-bot/blob/main/docs/troubleshooting.md) or join [#matrix-registration-bot:hyteck.de](https://matrix.to/#/#matrix-registration-bot:hyteck.de)."
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:61
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:66
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:68
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:70
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:72
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:74
|
||||
msgid "If you change the bot password (`matrix_bot_matrix_registration_bot_bot_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_registration_bot_bot_password` to let the bot know its new password."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:76
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:78
|
||||
msgid "To use the bot, start a chat with `@bot.matrix-registration-bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:80
|
||||
msgid "Send `help` to the bot to see the available commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:82
|
||||
msgid "You can also refer to the upstream [Usage documentation](https://github.com/moan0s/matrix-registration-bot#supported-commands)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:84
|
||||
msgid "If you have any questions, or if you need help setting it up, read the [troubleshooting guide](https://github.com/moan0s/matrix-registration-bot/blob/main/docs/troubleshooting.md) or join [#matrix-registration-bot:hyteck.de](https://matrix.to/#/#matrix-registration-bot:hyteck.de)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:86
|
||||
msgid "To clean the cache (session & encryption data) after you changed the bot's username, changed the login method from access_token to password etc… you can use:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:92
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:94
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-matrix-registration-bot`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:96
|
||||
msgid "Increase logging verbosity"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:98
|
||||
msgid "The default logging level for this component is `INFO`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,78 +16,114 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:1
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:9
|
||||
msgid "Setting up matrix-reminder-bot (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:3
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:11
|
||||
msgid "The playbook can install and configure [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:5
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:13
|
||||
msgid "It's a bot you can use to **schedule one-off & recurring reminders and alarms**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:7
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:15
|
||||
msgid "See the project's [documentation](https://github.com/anoadragon453/matrix-reminder-bot/blob/master/README.md) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:9
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:17
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:11
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:19
|
||||
msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:26
|
||||
msgid "Installing"
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:34
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:28
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:36
|
||||
msgid "There are some additional things you may wish to configure about the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:35
|
||||
msgid "**Notes**:"
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:38
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:37
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:39
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:40
|
||||
msgid "`roles/custom/matrix-bot-matrix-reminder-bot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:41
|
||||
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."
|
||||
msgid "`roles/custom/matrix-bot-matrix-reminder-bot/templates/config.yaml.j2` for the bot's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_matrix_reminder_bot_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:43
|
||||
msgid "If you change the bot password (`matrix_bot_matrix_reminder_bot_matrix_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_reminder_bot_matrix_user_password` to let the bot know its new password."
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:45
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:52
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:54
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:56
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:58
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:60
|
||||
msgid "If you change the bot password (`matrix_bot_matrix_reminder_bot_matrix_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_reminder_bot_matrix_user_password` to let the bot know its new password."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:62
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:47
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:64
|
||||
msgid "To use the bot, start a chat with `@bot.matrix-reminder-bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:49
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:66
|
||||
msgid "You can also add the bot to any existing Matrix room (`/invite @bot.matrix-reminder-bot:example.com`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:51
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:68
|
||||
msgid "Basic usage is like this: `!remindme in 2 minutes; This is a test`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:53
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:70
|
||||
msgid "Send `!help reminders` to the room to see the bot's help menu for additional commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:55
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:72
|
||||
msgid "You can also refer to the upstream [Usage documentation](https://github.com/anoadragon453/matrix-reminder-bot#usage)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:74
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:76
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-matrix-reminder-bot`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:78
|
||||
msgid "Increase logging verbosity"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-reminder-bot.md:80
|
||||
msgid "The default logging level for this component is `INFO`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2025-01-27 09:54+0200\n"
|
||||
"POT-Creation-Date: 2025-11-06 23:09+0900\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,147 +16,183 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:1
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:12
|
||||
msgid "Setting up maubot (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:3
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:14
|
||||
msgid "The playbook can install and configure [maubot](https://github.com/maubot/maubot) for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:5
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:16
|
||||
msgid "After setting up maubot, you can use the web management interface to make it do things. The default location of the management interface is `matrix.example.com/_matrix/maubot/`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:7
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:18
|
||||
msgid "See the project's [documentation](https://docs.mau.fi/maubot/usage/basic.html) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:9
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:20
|
||||
msgid "Adjusting DNS records (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:11
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:22
|
||||
msgid "By default, this playbook installs maubot on the `matrix.` subdomain, at the `/_matrix/maubot/` path (https://matrix.example.com/_matrix/maubot/). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:13
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:24
|
||||
msgid "If you wish to adjust it, see the section [below](#adjusting-the-maubot-url-optional) for details about DNS configuration."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:15
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:26
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:17
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:28
|
||||
msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:32
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:43
|
||||
msgid "You can add multiple admins. The admin accounts are only used to access the maubot administration interface."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:34
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:45
|
||||
msgid "Adjusting the maubot URL (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:36
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:47
|
||||
msgid "By tweaking the `matrix_bot_maubot_hostname` and `matrix_bot_maubot_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:38
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:56
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:49
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:76
|
||||
msgid "Example additional configuration for your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:46
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:57
|
||||
msgid "If you've changed the default hostname, you may need to create a CNAME record for the maubot domain (`maubot.example.com`), which targets `matrix.example.com`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:48
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:59
|
||||
msgid "When setting, replace `example.com` with your own."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:50
|
||||
msgid "Customizing the maubot container image"
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:61
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:52
|
||||
msgid "Certain [maubot plugins](https://plugins.mau.bot/) require additional dependencies to be installed."
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:63
|
||||
msgid "There are some additional things you may wish to configure about the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:54
|
||||
msgid "You can customize the default maubot container image and install your own dependencies."
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:65
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:67
|
||||
msgid "`roles/custom/matrix-bot-maubot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:68
|
||||
msgid "`roles/custom/matrix-bot-maubot/templates/config.yaml.j2` for the bot's default configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:70
|
||||
msgid "Customizing the maubot container image"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:72
|
||||
msgid "Certain [maubot plugins](https://plugins.mau.bot/) require additional dependencies to be installed."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:74
|
||||
msgid "You can customize the default maubot container image and install your own dependencies."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:87
|
||||
msgid "Consult the [Dockerfile reference](https://docs.docker.com/reference/dockerfile/) for more information about the syntax."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:69
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:89
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:71
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:91
|
||||
msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:78
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:98
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:80
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:100
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:82
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:102
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:84
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:104
|
||||
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."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:86
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:106
|
||||
msgid "If you change the bot password (`matrix_bot_maubot_initial_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_maubot_initial_password` to let the bot know its new password."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:88
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:108
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:90
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:110
|
||||
msgid "By default, you can visit `matrix.example.com/_matrix/maubot/` to manage your available plugins, clients and instances."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:92
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:112
|
||||
msgid "You should start in the following order"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:93
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:113
|
||||
msgid "**Create one or more clients**: A client is a Matrix account which the bot will use to message. By default, the playbook creates a `bot.maubot` account (as per the configuration above). You only need to [obtain an access token](#obtaining-an-access-token) for it"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:94
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:114
|
||||
msgid "**Upload some Plugins**: Plugins can be obtained from [here](https://github.com/maubot/maubot#plugins) or any other source."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:95
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:115
|
||||
msgid "**Create an instance**: An instance is the actual bot. You have to specify a client which the bot instance will use and the plugin (how the bot will behave)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:97
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:117
|
||||
msgid "Obtain an access token"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:99
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:119
|
||||
msgid "This can be done via `mbc login` then `mbc auth` (see the [maubot documentation](https://docs.mau.fi/maubot/usage/cli/auth.html)). To run these commands, you'll first need to `exec` into the maubot container with `docker exec -it matrix-bot-maubot sh`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:101
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:121
|
||||
msgid "Alternatively, you can refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md). Be aware that you'd better use the **Obtain an access token via curl** method (not **Obtain an access token via Element Web**) as the latter will causes issues to your bot in encrypted rooms. Read [more](https://docs.mau.fi/maubot/usage/basic.html#creating-clients)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:103
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:123
|
||||
msgid "[!WARNING] Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:126
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:128
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-maubot`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:130
|
||||
msgid "Increase logging verbosity"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-maubot.md:132
|
||||
msgid "The default logging level for this component is `WARNING`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
|
||||
msgstr ""
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user