Aplikasi terpalit

Imej Docker Antimatter datang dengan set aplikasi (palam, dalam Konsol Sistem). Halaman ini menyenaraikannya, menyatakan yang mana yang dihidupkan selepas pemasangan, dan merangkumi tetapan yang diperlukan oleh setiap satu daripada seorang pentadbir.

Aplikasi terpalit

Aplikasi disenaraikan sebagai Palam dalam Konsol Sistem. Ia berada dalam imej (dalam /antimatter/prepackaged_plugins), ditandatangani dengan kunci penandatanganan aplikasi Antimatter, jadi ia dipasang tanpa sambungan Internet.

Arkib keluaran dan pakej .deb dan .rpm mengandungi lebih sedikit aplikasi: lihat Aplikasi dalam pakej dan arkib.

Aplikasiid aplikasiImejDihidupkan selepas pemasangan
Ejen (AI)mattermost-aikedua-duaya
Panggilancom.mattermost.callskedua-duaya
Kanbanfocalboardkedua-duaya
Buku Taktikplaybookskedua-duaya
GitHubgithubkedua-duatidak
GitLabcom.github.manland.mattermost-plugin-gitlabkedua-duatidak
Jirajirakedua-duatidak
Metrikcom.mattermost.mattermost-plugin-metricskedua-duatidak
Saluran Suaracom.antimatterchat.voice-channelsantimatter-nextya
Undiancom.antimatterchat.pollsantimatter-nextya
Notacom.antimatterchat.notesantimatter-nextya
Papan Putihcom.antimatterchat.whiteboardantimatter-nextya
Melcom.antimatterchat.mailantimatter-nextya
Kalendarcom.antimatterchat.calendarantimatter-nextya
GIFcom.antimatterchat.gifsantimatter-nextya
Memememesantimatter-nexttidak
Senarai tugasancom.mattermost.plugin-todoantimatter-nexttidak

Aplikasi yang dihidupkan secara lalai dipasang pada setiap permulaan jika ia belum ada, atau dinaik taraf jika imej mempunyai versi yang lebih baharu. Jika anda mematikannya, ia kekal mati: lalai hanya terpakai untuk aplikasi yang belum disebut dalam konfigurasi. Aplikasi yang mengekalkan id Mattermost (Ejen, Panggilan, Kanban, Buku Taktik dan integrasi) adalah binaan sendiri Antimatter.

Hidupkan, matikan dan konfigurasi aplikasi

Pergi ke Konsol Sistem › Plugin › Pengurusan Plagin. Di bawah Plugin Dipasang, setiap aplikasi mempunyai Aktifkan atau Lumpuhkan, Tetapan dan Buang, dan menunjukkan statusnya (Berjalan, Tidak berjalan, Gagal bermula…). Setiap aplikasi dengan tetapan juga mempunyai halaman sendiri di bawah Konsol Sistem › Plugin.

Aplikasi terikat yang dimatikan secara lalai dipasang daripada salinan imej itu sendiri: klik gambar anda di bahagian atas rel aplikasi dan pilih Pasaran Aplikasi (dalam antara muka klasik, ia berada dalam menu produk), cari aplikasi dan klik Pasang, kemudian aktifkannya dalam Pengurusan Plagin. Dari baris arahan:

docker compose exec antimatter amctl --local plugin marketplace install github
docker compose exec antimatter amctl --local plugin enable github

Arahan lain: amctl plugin list, amctl plugin disable <id>, amctl plugin delete <id>.

Hidupkan aplikasi melalui konfigurasi

Aplikasi yang dihidupkan ialah tetapan PluginSettings.PluginStates, iaitu peta id aplikasi. Anda boleh menggabungkan entri ke dalamnya dengan amctl; dengan Aktifkan Plugin Prepackaged Automatik dihidupkan (lalai), aplikasi terikat yang diaktifkan akan dipasang pada permulaan seterusnya:

docker compose exec -T antimatter amctl --local config patch /dev/stdin <<'EOF'
{"PluginSettings": {"PluginStates": {"com.mattermost.plugin-todo": {"Enable": true}}}}
EOF
docker compose restart antimatter

Ini juga cara untuk memasang Senarai tugasan, yang tidak ditawarkan dalam dialog Pasar. Pemboleh ubah AM_PLUGINSETTINGS_PLUGINSTATES juga berfungsi, tetapi ia menggantikan keseluruhan peta: senaraikan setiap aplikasi yang anda mahu dihidupkan.

Tetapan aplikasi

Tetapan aplikasi disimpan di bawah PluginSettings.Plugins.<app id>, dengan kunci dalam huruf kecil. Ubahkannya di halaman Konsol Sistem aplikasi, atau dengan amctl config patch seperti yang ditunjukkan dalam Konfigurasi. AM_PLUGINSETTINGS_PLUGINS menggantikan tetapan semua aplikasi sekaligus dan menguncinya, jadi elak menggunakannya.

GIF

Aplikasi GIFs menambah tab GIF dan pelekat pada pemilih emoji, disokong oleh perkhidmatan GIF Antimatter (gifs-server), yang berkomunikasi dengan API Tenor. Fail compose laman web ini menjalankan perkhidmatan dan mengkonfigurasi aplikasi melalui pemboleh ubah. Tetapannya, dalam Konsol Sistem › Plugins › GIFs:

TetapanPemboleh ubah (cadangan)LalaiFungsinya
URL perkhidmatan GIFAM_GIFS_SERVICE_URLkosongAsas API perkhidmatan, contohnya http://gifs:8080/v2. GIF dimatikan selagi ia kosong.
Kunci APIAM_GIFS_API_KEYkosongSalah satu daripada AM_GIFS_API_KEYS perkhidmatan.
Kunci muat naikAM_GIFS_UPLOAD_KEYkosongSalah satu daripada AM_GIFS_UPLOAD_KEYS perkhidmatan. Membolehkan pengguna menambah GIF dan pelekat daripada pemilih, dan memadam yang ditambah dengan cara ini. Kosong akan mematikan muat naik.
Siapa boleh menambah GIF dan pelekatPentadbir SistemPentadbir sistem, atau Semua orang. Tetamu tidak pernah boleh, sama seperti emoji tersuai. Apa yang ditambah oleh pengguna tersedia untuk semua orang; orang yang menambahnya dan pentadbir sistem boleh memadamnya.
Benarkan pelekathidupMenunjukkan tab pelekat.
Penapis kandungansederhanatinggi, sederhana, rendah atau mati.
Sediakan media melalui AntimatterhidupPelayar memuat GIF dari Antimatter, yang mengambilnya dari perkhidmatan. Biarkan hidup jika perkhidmatan hanya dalam rangkaian dalaman anda.
URL media/media/ perkhidmatanLokasi media, jika disediakan secara langsung.
Saiz cache (MB)64 MBCache memori aplikasi.

Untuk aplikasi ini, pemboleh ubah hanyalah cadangan: nilai yang ditetapkan dalam Konsol Sistem menang ke atasnya. Jika pemilih GIF kekal kosong, semak URL perkhidmatan dan kunci API di halaman itu.

Sementara aplikasi GIF disetup, tabnya menggantikan pemilih Giphy terbina dalam (Konsol Sistem › Integrasi › GIF › Aktifkan Pemilih GIF, ServiceSettings.EnableGifPicker).

Perkhidmatan GIF

Perkhidmatan menyimpan semuanya dalam direktori datanya (/data, volume gifs): indeks carian dan media. Pemboleh ubah utamanya:

Pemboleh ubahLalaiFungsinya
AM_GIFS_API_KEYStiadaKunci API yang dipisahkan oleh koma. Tanpa kunci, API terbuka kepada sesiapa sahaja yang dapat mengaksesnya. Beberapa kunci membolehkan anda memutarkannya.
AM_GIFS_UPLOAD_KEYStiadaKunci yang dibenarkan untuk muat naik, dan untuk memadam apa yang dimuat naik. Tiada muat naik tanpa satu.
AM_GIFS_RATE_LIMIT20Permintaan per saat per klien (kunci API dan alamat); 0 mematikannya. Fail compose menetapkan 0, kerana semua permintaan Antimatter berkongsi satu kunci dan alamat.
AM_GIFS_LISTEN:8080Alamat dengar.
AM_GIFS_PUBLIC_URLdari permintaanURL luaran, jika anda mendedahkan perkhidmatan ini.
AM_GIFS_TRUST_PROXYfalsePercayai pengepala X-Forwarded-*, di belakang proksi sahaja.
AM_GIFS_UPLOAD_MAX_MB16Fail yang dimuat naik paling besar.

Untuk menambah GIF anda sendiri secara pukal, importkannya dengan manifest, daripada direktori yang dipasang ke dalam kontena sekali guna:

docker compose run --rm -v "$PWD/my-gifs:/import:ro" gifs import -manifest /import/manifest.json

Untuk mengimport semula pelekat pemula selepas peningkatan: docker compose run --rm gifs stickers. Format manifest dan arahan lain terdapat dalam README gifs-server.

Mel dan Kalendar

Mel dan Kalendar menghubungkan setiap orang kepada peti mel (IMAP dan SMTP) dan kalendar (CalDAV) mereka sendiri. Orang memasukkan pelayan dan kata laluan mereka dalam aplikasi; kata laluan disimpan dalam bentuk disulitkan. Anda tidak mengkonfigurasi pelayan mel atau kalendar untuk mereka, tetapi anda menentukan apa yang boleh mereka sambungkan:

AplikasiTetapanLalaiFungsinya
Mel, KalendarBenarkan pelayan mel pada rangkaian peribadi, Benarkan pelayan kalendar pada rangkaian peribadi (AllowPrivateNetworks)TutupTutup, pelayan enggan menyambung ke alamat loopback, peribadi dan pautan-tempatan, jadi aplikasi tidak boleh digunakan untuk mencapai rangkaian dalaman anda. Nyalakannya jika pelayan mel atau kalendar anda berada pada alamat peribadi.
Mel, KalendarBenarkan sambungan tidak disulitkan (AllowInsecureConnections)TutupTutup, sambungan mesti menggunakan TLS (Mel: TLS atau STARTTLS; Kalendar: HTTPS).
MelSelang semakan belum dibaca (minit) (UnreadCheckMinutes)2 minitBerapa kerap kiraan belum dibaca disemak apabila pelayan mel tidak dapat menghantarnya.
MelSaiz mesej terbesar (MB) (MaxMessageSizeMB)25 MBHad saiz mesej yang dihantar dan dibaca.
KalendarHantar peringatan (EnableReminders)hidupBot Kalendar menghantar Mesej Terus sebelum acara (10 minit sebelum, untuk acara tanpa alarm sendiri).

Untuk membolehkan orang log masuk ke peti mel Gmail atau Microsoft 365 dengan akaun mereka sebagai ganti kata laluan, cipta klien OAuth dan isi medan Google atau Microsoft aplikasi Mel:

  • Google: klien OAuth Web dengan Gmail API dan skop https://mail.google.com/.
  • Microsoft: aplikasi Entra ID dengan kebenaran terwakil IMAP.AccessAsUser.All, SMTP.Send, offline_access, openid, email dan profile. Penguasa adalah common secara lalai.
  • Dalam kedua-duanya, URI alih arah ialah https://chat.example.com/plugins/com.antimatterchat.mail/oauth/callback (URL laman web anda).

Kanban, Nota, Papan Putih, Undian dan Buku Taktik

  • Kanban (focalboard) dibuka dalam panel sisinya di sebelah perbualan, seperti Playbooks. Pautan lama ke halaman /kanban/… dan /boards/… membuka papan atau kad yang sama dalam komuniti. Tetapan satu-satunya, Aktifkan Papan Kongsi Awam (EnablePublicSharedBoards, mati), membolehkan penyunting papan berkongsi papan dengan sesiapa sahaja yang mempunyai pautan, tanpa log masuk.
  • Nota dan Undian tiada tetapan.
  • Papan Putih: pentadbir sistem boleh muat naik perpustakaan bentuk (fail Excalidraw .excalidrawlib, sehingga 5 MB setiap satu) untuk seluruh pelayan di halaman tetapan. Pentadbir komuniti menguruskan perpustakaan komuniti mereka sendiri.
  • Playbooks dibuka dalam panel sisinya. Pautan lama ke halaman /playbooks/… membuka larian atau playbook yang sama dalam komuniti. Ia mempunyai beberapa tetapan, kebanyakannya ciri eksperimental; lalai sesuai untuk kebanyakan pelayan.
  • Memes: Siapa boleh menambah templat meme: Semua orang (lalai), Pentadbir sistem, atau Tiada (templat tersuai dimatikan), yang menghentikan templat baharu manakala yang sudah ditambah kekal boleh digunakan. Tetamu tidak pernah menambah templat. Orang yang menambah templat dan pentadbir sistem boleh memadamnya.
  • Senarai tugasan tiada tetapan pelayan.

GitHub, GitLab dan Jira

Aplikasi ini menghubungkan Antimatter dengan pelayan kod dan penjejak isu anda. Setiap satu memerlukan aplikasi OAuth di pihak lawan dan webhook yang menunjuk kembali ke Antimatter. Aktifkan aplikasi, kemudian jalankan arahan penetapannya di mana-mana saluran, yang akan membimbing anda langkah demi langkah: /github setup, /gitlab setup atau /jira setup.

AplikasiURL alih-haluan OAuthURL webhook
GitHubhttps://chat.example.com/plugins/github/oauth/completehttps://chat.example.com/plugins/github/webhook
GitLabhttps://chat.example.com/plugins/com.github.manland.mattermost-plugin-gitlab/oauth/completehttps://chat.example.com/plugins/com.github.manland.mattermost-plugin-gitlab/webhook
Jira/jira instance install server <url> atau /jira instance install cloud-oauth <url>; /jira webhook memaparkan URL webhook.
Biarkan Use Preregistered OAuth Application dimatikan dalam aplikasi GitHub dan GitLab: ia bergantung pada perkhidmatan Mattermost yang tiada dalam Antimatter, dan aplikasi akan enggan bermula jika ia dihidupkan. Daftarkan aplikasi OAuth anda sendiri.

Aplikasi GitHub dan GitLab menjana rahsia webhook dan kunci penyahkodannya pada simpanan pertama. Aplikasi GitHub boleh dihadkan kepada organisasi (GithubOrg) dan aplikasi GitLab kepada kumpulan (GitlabGroup); untuk GitHub Enterprise atau GitLab yang dihoskan sendiri, tetapkan URL asasnya.

Metrik

Aplikasi Metrik mengumpul metrik prestasi pelayan ke dalam pangkalan data siri masa kecil di dalam Antimatter, supaya anda boleh memuat turunnya atau menyertainya dalam pakej sokongan tanpa menjalankan Prometheus. Apabila ia bermula, ia akan menghidupkan titik akhir metrik pelayan (MetricsSettings.Enable). Lihat Operasi.

Memasang aplikasi lain

Antimatter menjalankan aplikasi Mattermost (plugin). Tiga cara untuk menambah satu:

  • Dari pasaran jauh. Aktifkan Pasaran Jauh (PluginSettings.EnableRemoteMarketplace) adalah dimatikan secara lalai, dan URL Pasaran (PluginSettings.MarketplaceURL) kosong: Antimatter tidak menggunakan pasaran Mattermost, dan mengabaikan alamatnya jika konfigurasi dari Mattermost masih memilikinya. Untuk senaraikan aplikasi pelayan pasaran yang anda percayai, hidupkan tetapan ini dan tetapkan URL-nya. Binaan pasaran untuk aplikasi yang dibekalkan oleh Antimatter (Panggilan, Buku Taktik, Kanban dan yang lain) disembunyikan, jadi ia tidak boleh menggantikan milik Antimatter: Benarkan Binaan Pasaran untuk Plagin Antimatter (PluginSettings.AllowMarketplaceToReplaceAntimatterPlugins) adalah dimatikan secara lalai.
  • Dengan memuat naik bundel (.tar.gz). Muat naik adalah dimatikan secara lalai dan tiada suis Konsol Sistem: tetapkan AM_PLUGINSETTINGS_ENABLEUPLOADS=true, kemudian gunakan Muat Naik Plagin dalam Pengurusan Plagin, atau amctl --local plugin add app.tar.gz.
  • Dari URL: amctl plugin install-url <url>, juga dengan muat naik dihidupkan.

Antimatter menyemak tandatangan aplikasi terhadap kunci yang dipercayainya: kunci Antimatter, kunci yang Mattermost, Inc. gunakan untuk menandatangani aplikasi yang diterbitkan (jadi aplikasi Mattermost yang anda muat turun sendiri boleh dipasang) dan mana-mana kunci yang anda tambah dalam PluginSettings.SignaturePublicKeyFiles. Dengan Wajibkan Tandatangan Plugin (PluginSettings.RequirePluginSignature, dimatikan secara lalai) dihidupkan, aplikasi tanpa tandatangan ditolak dan muat naik dilumpuhkan.

Aplikasi berjalan di dalam pelayan dengan akses penuh ke datanya. Hanya pasang aplikasi yang anda percayai.

Beberapa aplikasi yang dibuat untuk edisi berbayar Mattermost menyemak lesen Mattermost sendiri dan enggan berjalan; Antimatter tidak berpura-pura memilikinya untuk mereka.