Aplikasi bawaan

Gambar Docker Antimatter dilengkapi dengan seperangkat aplikasi (plugin, di Konsol Sistem). Halaman ini mencantumkan aplikasi tersebut, menyebutkan mana yang aktif setelah instalasi, dan membahas pengaturan yang diperlukan dari seorang admin untuk masing-masing aplikasi.

Aplikasi bawaan

Aplikasi dicantumkan sebagai Plugins di Konsol Sistem. Aplikasi ini ada di dalam gambar (di /antimatter/prepackaged_plugins), ditandatangani dengan kunci penandatanganan aplikasi Antimatter, sehingga dapat diinstal tanpa koneksi Internet.

Arsip rilis dan paket .deb dan .rpm mencakup lebih sedikit aplikasi: lihat Aplikasi dalam paket dan arsip.

AplikasiID aplikasiGambarAktif setelah instalasi
Agen (AI)mattermost-aikeduanyaya
Panggilancom.mattermost.callskeduanyaya
Kanbanfocalboardkeduanyaya
Buku Taktikplaybookskeduanyaya
GitHubgithubkeduanyatidak
GitLabcom.github.manland.mattermost-plugin-gitlabkeduanyatidak
Jirajirakeduanyatidak
Metrikcom.mattermost.mattermost-plugin-metricskeduanyatidak
Kanal Suaracom.antimatterchat.voice-channelsantimatter-nextya
Jajak Pendapatcom.antimatterchat.pollsantimatter-nextya
Catatancom.antimatterchat.notesantimatter-nextya
Papan Putihcom.antimatterchat.whiteboardantimatter-nextya
Surelcom.antimatterchat.mailantimatter-nextya
Kalendercom.antimatterchat.calendarantimatter-nextya
GIFcom.antimatterchat.gifsantimatter-nextya
Memememesantimatter-nexttidak
To-docom.mattermost.plugin-todoantimatter-nexttidak

Aplikasi yang aktif secara bawaan akan diinstal setiap kali dimulai jika belum ada, atau diperbarui jika gambar memiliki versi yang lebih baru. Jika Anda menonaktifkan salah satu, ia akan tetap nonaktif: pengaturan bawaan hanya berlaku untuk aplikasi yang belum disebutkan dalam konfigurasi. Aplikasi yang mempertahankan ID Mattermost-nya (Agen, Panggilan, Kanban, Buku Taktik, dan integrasi) adalah versi build milik Antimatter sendiri.

Aktifkan, nonaktifkan, dan atur aplikasi

Buka Konsol Sistem › Plugin › Manajemen Plugin. Di bawah Plugin Terpasang, setiap aplikasi memiliki Aktifkan atau Nonaktifkan, Pengaturan, dan Keluarkan, serta menampilkan statusnya (Berjalan, Tidak berjalan, Gagal dimulai…). Setiap aplikasi yang memiliki pengaturan juga memiliki halaman tersendiri di bawah Konsol Sistem › Plugin.

Aplikasi bawaan yang nonaktif secara default diinstal dari salinan gambar itu sendiri: klik foto Anda di bagian atas bilah aplikasi dan pilih Pasar Aplikasi (dalam antarmuka klasik, ini ada di menu produk), temukan aplikasinya dan klik Instal, lalu aktifkan di Manajemen Plugin. Dari baris perintah:

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

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

Aktifkan aplikasi melalui konfigurasi

Aplikasi yang aktif diatur oleh PluginSettings.PluginStates, yaitu peta ID aplikasi. Anda dapat menggabungkan entri ke dalamnya menggunakan amctl; dengan Aktifkan Plugin Prepackaged Otomatis (default) diaktifkan, aplikasi bawaan yang diaktifkan akan diinstal saat startup berikutnya:

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 menginstal To-do, yang tidak ditawarkan di dialog Marketplace. Variabel AM_PLUGINSETTINGS_PLUGINSTATES juga berfungsi, tetapi ia mengganti seluruh peta: cantumkan setiap aplikasi yang ingin Anda aktifkan.

Pengaturan aplikasi

Pengaturan aplikasi disimpan di bawah PluginSettings.Plugins.<app id>, dengan kunci dalam huruf kecil. Ubah di halaman Konsol Sistem aplikasi, atau dengan amctl config patch seperti yang ditunjukkan di Konfigurasi. AM_PLUGINSETTINGS_PLUGINS mengganti pengaturan semua aplikasi sekaligus dan menguncinya, jadi hindari penggunaannya.

GIF

Aplikasi GIFs menambahkan tab GIF dan stiker ke pemilih emoji, didukung oleh layanan GIF Antimatter (gifs-server), yang menggunakan API Tenor. File compose situs menjalankan layanan dan mengonfigurasi aplikasi melalui variabel. Pengaturannya, di Konsol Sistem › Plugins › GIFs:

PengaturanVariabel (cadangan)BawaanFungsinya
URL layanan GIFAM_GIFS_SERVICE_URLkosongDasar API layanan, misalnya http://gifs:8080/v2. GIF nonaktif selama ini kosong.
Kunci APIAM_GIFS_API_KEYkosongSalah satu AM_GIFS_API_KEYS dari layanan.
Kunci unggahAM_GIFS_UPLOAD_KEYkosongSalah satu AM_GIFS_UPLOAD_KEYS layanan. Memungkinkan orang menambahkan GIF dan stiker dari pemilih, serta menghapus yang ditambahkan dengan cara ini. Jika kosong, unggahan dinonaktifkan.
Siapa yang dapat menambahkan GIF dan stikerAdmin SistemAdmin sistem, atau Semua orang. Tamu tidak pernah bisa, seperti halnya emoji kustom. Apa yang ditambahkan orang tersedia untuk semua orang; orang yang menambahkan dan administrator sistem dapat menghapusnya.
Aktifkan stikeronMenampilkan tab stiker.
Filter kontenmediumhigh, medium, low atau off.
Sajikan media melalui AntimatteronPeramban memuat GIF dari Antimatter, yang mengambilnya dari layanan. Biarkan aktif jika layanan hanya ada di jaringan internal Anda.
URL media/media/ dari layananLokasi media, jika disajikan langsung.
Ukuran cache (MB)64 MBCache memori aplikasi.

Untuk aplikasi ini, variabel hanya cadangan: nilai yang diatur di Konsol Sistem menang atasnya. Jika pemilih GIF tetap kosong, periksa URL layanan dan kunci API di halaman tersebut.

Saat aplikasi GIF disetel, tabnya menggantikan pemilih Giphy bawaan (Konsol Sistem › Integrasi › GIF › Aktifkan Pemilih GIF, ServiceSettings.EnableGifPicker).

Layanan GIF

Layanan menyimpan semuanya di direktori datanya (/data, volume gifs): indeks pencarian dan media. Variabel utamanya:

VariabelBawaanFungsinya
AM_GIFS_API_KEYSnoneKunci API yang dipisahkan koma. Tanpa kunci, API terbuka untuk siapa pun yang mengaksesnya. Beberapa kunci memungkinkan rotasi.
AM_GIFS_UPLOAD_KEYSnoneKunci yang diizinkan untuk mengunggah, dan menghapus apa yang diunggah. Tidak ada unggahan tanpa salah satu kunci ini.
AM_GIFS_RATE_LIMIT20Permintaan per detik per klien (kunci API dan alamat); 0 menonaktifkannya. File compose mengatur 0, karena semua permintaan Antimatter berbagi satu kunci dan alamat.
AM_GIFS_LISTEN:8080Alamat dengar.
AM_GIFS_PUBLIC_URLdari permintaanURL eksternal, jika Anda mengekspos layanan.
AM_GIFS_TRUST_PROXYfalsePercayai header X-Forwarded-*, hanya di belakang proxy.
AM_GIFS_UPLOAD_MAX_MB16Ukuran file unggahan terbesar.

Untuk menambahkan GIF Anda sendiri secara massal, impor menggunakan manifest dari direktori yang dimuat ke dalam kontainer sekali pakai:

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

Untuk mengimpor ulang stiker awal setelah peningkatan: docker compose run --rm gifs stickers. Format manifest dan perintah lainnya ada di README gifs-server.

Surel dan Kalender

Surel dan Kalender menghubungkan setiap orang ke kotak masuk (IMAP dan SMTP) dan kalender (CalDAV) mereka sendiri. Orang-orang memasukkan server dan kata sandi mereka di aplikasi; kata sandi disimpan secara terenkripsi. Anda tidak mengonfigurasi server surel atau kalender untuk mereka, tetapi Anda menentukan apa yang boleh mereka hubungkan:

AplikasiPengaturanBawaanFungsinya
Surel, KalenderIzinkan server surel di jaringan privat, Izinkan server kalender di jaringan privat (AllowPrivateNetworks)nonaktifNonaktif, server menolak untuk terhubung ke alamat loopback, privat, dan link-local, sehingga aplikasi tidak dapat digunakan untuk menjangkau jaringan internal Anda. Aktifkan jika server surel atau kalender Anda berada di alamat privat.
Surel, KalenderIzinkan koneksi tanpa enkripsi (AllowInsecureConnections)nonaktifNonaktif, koneksi harus menggunakan TLS (Surel: TLS atau STARTTLS; Kalender: HTTPS).
SurelInterval pemeriksaan belum dibaca (menit) (UnreadCheckMinutes)2 menitSeberapa sering jumlah pesan belum dibaca diperiksa ketika server surel tidak dapat mengirimkannya.
SurelUkuran pesan terbesar (MB) (MaxMessageSizeMB)25 MBBatas ukuran pesan yang dikirim dan dibaca.
KalenderKirim pengingat (EnableReminders)onBot Kalender mengirim Pesan Langsung sebelum acara (10 menit sebelumnya, untuk acara yang tidak memiliki alarm sendiri).

Untuk memungkinkan orang masuk ke kotak masuk Gmail atau Microsoft 365 dengan akun mereka alih-alih kata sandi, buat klien OAuth dan isi bidang Google atau Microsoft di aplikasi Surel:

  • Google: klien OAuth Web dengan Gmail API dan cakupan https://mail.google.com/.
  • Microsoft: aplikasi Entra ID dengan izin delegasi IMAP.AccessAsUser.All, SMTP.Send, offline_access, openid, email dan profile. Tenant default adalah common.
  • Di keduanya, URI pengalihan adalah https://chat.example.com/plugins/com.antimatterchat.mail/oauth/callback (URL situs Anda).

Kanban, Catatan, Papan Putih, Jajak Pendapat, dan Buku Taktik

  • Kanban (focalboard) terbuka di panel sampingnya di sebelah percakapan, seperti Playbooks. Tautan lama ke halaman /kanban/… dan /boards/… membuka papan atau kartu yang sama di komunitas. Satu-satunya pengaturannya, Aktifkan Papan yang Dibagikan Secara Publik (EnablePublicSharedBoards, nonaktif), memungkinkan editor papan membagikan papan dengan siapa pun yang memiliki tautan, tanpa perlu masuk.
  • Catatan dan Jajak Pendapat tidak memiliki pengaturan.
  • Papan Putih: administrator sistem dapat mengunggah pustaka bentuk (berkas Excalidraw .excalidrawlib, maksimal 5 MB per berkas) untuk seluruh server di halaman pengaturannya. Administrator komunitas mengelola pustaka komunitas mereka sendiri.
  • Playbooks terbuka di panel sampingnya. Tautan lama ke halaman /playbooks/… membuka eksekusi atau playbook yang sama di komunitas. Ini memiliki beberapa pengaturan, sebagian besar fitur eksperimental; nilai default cocok untuk sebagian besar server.
  • Memes: Siapa yang dapat menambahkan template meme: Semua orang (default), Admin sistem, atau Tidak ada (template kustom nonaktif), yang menghentikan template baru sementara yang sudah ditambahkan tetap dapat digunakan. Tamu tidak pernah menambahkan template. Orang yang menambahkan template dan administrator sistem dapat menghapusnya.
  • To-do tidak memiliki pengaturan server.

GitHub, GitLab dan Jira

Aplikasi ini menghubungkan Antimatter ke platform hosting kode dan pelacak masalah Anda. Masing-masing memerlukan aplikasi OAuth di sisi lain dan webhook yang menunjuk kembali ke Antimatter. Aktifkan aplikasinya, lalu jalankan perintah pengaturannya di kanal mana pun, yang akan memandu Anda langkah demi langkah: /github setup, /gitlab setup atau /jira setup.

AplikasiURL pengalihan 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 menampilkan URL webhook.
Biarkan Use Preregistered OAuth Application nonaktif di aplikasi GitHub dan GitLab: fitur ini bergantung pada layanan Mattermost yang tidak dimiliki Antimatter, dan aplikasi akan menolak untuk dimulai jika fitur ini diaktifkan. Daftarkan aplikasi OAuth Anda sendiri.

Aplikasi GitHub dan GitLab menghasilkan rahasia webhook dan kunci enkripsi mereka saat disimpan pertama kali. Aplikasi GitHub dapat dibatasi untuk organisasi (GithubOrg) dan aplikasi GitLab untuk grup (GitlabGroup); untuk GitHub Enterprise atau GitLab self-hosted, atur URL dasarnya.

Metrik

Aplikasi Metrik mengumpulkan metrik kinerja server ke dalam basis data deret waktu kecil di dalam Antimatter, sehingga Anda dapat mengunduhnya atau menyertakannya dalam paket dukungan tanpa menjalankan Prometheus. Saat dimulai, aplikasi ini mengaktifkan endpoint metrik server (MetricsSettings.Enable). Lihat Operasi.

Menginstal aplikasi lain

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

  • Dari marketplace jarak jauh. Aktifkan Marketplace Jarak Jauh (PluginSettings.EnableRemoteMarketplace) nonaktif secara bawaan, dan URL Marketplace (PluginSettings.MarketplaceURL) kosong: Antimatter tidak menggunakan marketplace Mattermost, dan mengabaikan alamatnya jika konfigurasi dari Mattermost masih memuatnya. Untuk menampilkan aplikasi dari server marketplace yang Anda percaya, aktifkan pengaturan tersebut dan atur URL-nya. Build marketplace untuk aplikasi yang dibundel Antimatter (Calls, Playbooks, Kanban, dan lainnya) disembunyikan, sehingga tidak dapat menggantikan milik Antimatter: Izinkan Build Marketplace untuk Plugin Antimatter (PluginSettings.AllowMarketplaceToReplaceAntimatterPlugins) nonaktif secara bawaan.
  • Dengan mengunggah bundle (.tar.gz). Unggahan nonaktif secara default dan tidak memiliki saklar di Konsol Sistem: setel AM_PLUGINSETTINGS_ENABLEUPLOADS=true, lalu gunakan Unggah Plugin di Manajemen Plugin, atau amctl --local plugin add app.tar.gz.
  • Dari URL: amctl plugin install-url <url>, juga dengan unggahan aktif.

Antimatter memeriksa tanda tangan aplikasi terhadap kunci yang dipercayai: kunci Antimatter, kunci yang digunakan Mattermost, Inc. untuk menandatangani aplikasi publikasinya (sehingga aplikasi Mattermost yang Anda unduh sendiri dapat diinstal), dan kunci apa pun yang Anda tambahkan di PluginSettings.SignaturePublicKeyFiles. Dengan Wajibkan Tanda Tangan Plugin (PluginSettings.RequirePluginSignature, nonaktif secara default) diaktifkan, aplikasi tanpa tanda tangan akan ditolak dan unggahan dinonaktifkan.

Aplikasi berjalan di dalam server dengan akses penuh ke datanya. Hanya instal aplikasi yang Anda percaya.

Beberapa aplikasi yang dibuat untuk edisi berbayar Mattermost memeriksa lisensi Mattermost mereka sendiri dan menolak untuk berjalan; Antimatter tidak berpura-pura memilikinya untuk mereka.