Sisällytetyt sovellukset

Antimatterin Docker-kuvat sisältävät joukon sovelluksia (Järjestelmäkonsolin pluginit). Tämä sivu luettaa ne, kertoo mitkä ovat käytössä asennuksen jälkeen ja käsittelee kunkin sovelluksen ylläpitäjän tarvitsemat asetukset.

Sisällytetyt sovellukset

Sovellukset näkyvät Liiteohjelmat-osiossa Järjestelmäkonsolissa. Ne ovat mukana kuvassa (hakemistossa /antimatter/prepackaged_plugins) ja allekirjoitettu Antimatterin sovellusavaimella, joten ne asennetaan ilman Internet-yhteyttä.

Julkaisun arkisto ja .deb- ja .rpm-paketit sisältävät vähemmän sovelluksia: ks. Pakettien ja arkiston sovellukset.

SovellusSovelluksen idKuvaKäytössä asennuksen jälkeen
Tekoälykeskustelumattermost-aimolemmatkyllä
Puhelutcom.mattermost.callsmolemmatkyllä
GitHubgithubmolemmatei
GitLabcom.github.manland.mattermost-plugin-gitlabmolemmatei
Jirajiramolemmatei
Mittaritcom.mattermost.mattermost-plugin-metricsmolemmatei
Äänikanavatcom.antimatterchat.voice-channelsantimatter-nextkyllä
Kyselytcom.antimatterchat.pollsantimatter-nextkyllä
Muistiinpanotcom.antimatterchat.notesantimatter-nextkyllä
Valkotaulucom.antimatterchat.whiteboardantimatter-nextkyllä
Sähköposticom.antimatterchat.mailantimatter-nextkyllä
Kalentericom.antimatterchat.calendarantimatter-nextkyllä
GIFitcom.antimatterchat.gifsantimatter-nextkyllä
Memitmemesantimatter-nextei
Tehtävälistacom.mattermost.plugin-todoantimatter-nextei

Oletuksena päällä olevat sovellukset asennetaan jokaisella käynnistyksellä, jos niitä ei ole vielä asennettu, tai päivitetään, jos kuvassa on uudempi versio. Jos poistat sovelluksen käytöstä, se pysyy pois päältä: oletusarvo koskee vain sovelluksia, joita asetuksissa ei ole vielä mainittu. Sovellukset, jotka säilyttävät Mattermost-tunnuksensa (Tekoälykeskustelu, Puhelut ja integraatiot), ovat Antimatterin omia versioita.

Kanban (focalboard) ja Ohjekirjat (playbooks) eivät enää sisälly palvelimeen tai kumpaankaan image-tiedostoon: asenna haluamasi versio sen omasta GitHub-julkaisusta (katso Sovellukset paketeissa ja arkistossa) kuten muutkin oletuksena mukana tulemattomat sovellukset. Palvelin, jossa jompikumpi on jo asennettu, säilyttää sen päivityksen jälkeen. Molemmat ovat edelleen Antimatterin omia versioita: Marketplacesta löytyvät alkuperäiset versiot eivät koskaan korvaa Antimatterin versioita.

Sovellusten ottaminen käyttöön, poistaminen käytöstä ja konfigurointi

Siirry kohtaan Järjestelmäkonsoli › Liiteohjelmat › Liiteohjelmien hallinta. Asennetut lisäosat-osiossa jokaisella sovelluksella on Ota käyttöön- tai Poista käytöstä-valinta, Asetukset ja Poista, sekä sen tila (Käynnissä, Ei käynnissä, Käynnistys epäonnistui…). Jokaisella sovelluksella, jolla on asetuksia, on oma sivunsa kohtaan Järjestelmäkonsoli › Liiteohjelmat.

Kytkeytetyt oletusarvolla pois sovellukset asennetaan kuvan omasta kopiosta: napsauta profiilikuvaasi sovellusvalikon yläreunassa ja valitse Sovelluskauppa (klassisessa käyttöliittymässä se on tuotemenussa), etsi sovellus ja napsauta Asenna, ja ota se sitten käyttöön lisäosien hallinnassa. Komentoriviltä:

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

Muut komennot: amctl plugin list, amctl plugin disable <id>, amctl plugin delete <id>.

Sovellusten ottaminen käyttöön konfiguraation kautta

Mikä sovellukset ovat käytössä, määritellään asetuksella PluginSettings.PluginStates, joka on sovellus-tunnisteiden kartoitus. Voit lisätä kohteita siihen amctl:llä; jos Ota automaattiset valmiit lisäosat käyttöön on päällä (oletusarvo), käytössä oleva mukana toimitettu sovellus asennetaan seuraavalla käynnistyksellä:

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

Tämä on myös tapa asennella Tehtävälista, jota ei tarjota Marketplaces-sovellusikkunassa. Muuttuja AM_PLUGINSETTINGS_PLUGINSTATES toimii myös, mutta se korvaa koko kartoituksen: luettele kaikki sovellukset, jotka haluat käytössä.

Sovellusasetukset

Sovelluksen asetukset tallennetaan polkua PluginSettings.Plugins.<app id> pitkin, ja avaimet ovat pien kirjaimin. Muuta niitä sovelluksen Järjestelmäkonsoli-sivulla tai komennolla amctl config patch, kuten Asetukset-osiossa näytetään. AM_PLUGINSETTINGS_PLUGINS korvaa kerralla kaikkien sovellusten asetukset ja lukitsee ne, joten vältä sen käyttöä.

GIFit

GIF:t-sovellus lisää GIF- ja tarravälilehden emoji-valitsimeen. Sen taustalla toimii Antimatterin GIF-palvelu (gifs-server), joka käyttää Tenor API:ta. Sivuston compose-tiedosto käynnistää palvelun ja määrittää sovelluksen muuttujien avulla. Sen asetukset, kohtaan Järjestelmäkonsoli › Liiteohjelmat › GIF:t:

AsetusMuuttuja (varavaihtoehto)OletusarvoToiminto
GIF-palvelun URLAM_GIFS_SERVICE_URLtyhjäPalvelun API-pohja, esimerkiksi http://gifs:8080/v2. GIFit ovat poissa käytöstä, kun arvo on tyhjä.
API-avainAM_GIFS_API_KEYtyhjäPalvelun AM_GIFS_API_KEYS-avaimista yksi.
LähetysavainAM_GIFS_UPLOAD_KEYtyhjäPalvelun AM_GIFS_UPLOAD_KEYS-avain. Sallii GIF- ja tarrakuvien lisäämisen valikosta sekä näin lisättyjen poistamisen. Tyhjä arvo poistaa lataukset käytöstä.
Kuka voi lisätä GIFit ja tarratJärjestelmänvalvojatJärjestelmän ylläpitäjät tai Kaikki. Vieraille ei koskaan, kuten mukautettuihin emojiin. Jokaisen lisäämä on kaikkien käytettävissä; lisännyt ja järjestelmän ylläpitäjät voivat poistaa sen.
Ota tarrat käyttöönonNäyttää tarravälilehden.
Sisällinsuodatinmediumhigh, medium, low tai off.
Toimita media Antimatterin kauttaonSelaimet lataavat GIFit Antimatterista, joka hakee ne palvelusta. Jätä tämä päälle, jos palvelu on vain sisäisessä verkossa.
Median URLpalvelun /media/Median sijainti, kun se toimitetaan suoraan.
Cache-koko (MB)64 MBSovelluksen muistivälimuisti.

Tälle sovellukselle muuttujat ovat vain varavaihtoehtoja: Järjestelmäkonsolissa asetettu arvo voittaa ne. Jos GIF-valitsin jää tyhjäksi, tarkista palvelun URL ja API-avain kyseisellä sivulla.

Kun GIF:t-sovellus on määritetty, sen välilehti korvaa sisäänrakennetun Giphy-valitsimen (Järjestelmäkonsoli › Integraatiot › GIF › Ota käyttöön GIF-valitsin, ServiceSettings.EnableGifPicker).

GIF-palvelu

Palvelu säilyttää kaiken datanssa hakemisto (/data, gifs-volyymi): hakuindeksin ja median. Sen päämuuttujat:

MuuttujaOletusarvoToiminto
AM_GIFS_API_KEYSnonePilkuin erotetut API-avaimet. Ilman avainta API on avoinna kaikille, jotka pääsevät siihen. Useat avaimet mahdollistavat niiden kierrätyksen.
AM_GIFS_UPLOAD_KEYSnoneAvaimet, jotka sallivat latauksen ja ladattujen poistamisen. Ei latauksia ilman avainta.
AM_GIFS_RATE_LIMIT20Pyyntöjä sekunnissa asiakasta kohti (API-avain ja osoite); 0 poistaa rajauksen käytöstä. Compose-tiedosto asettaa arvon 0, koska kaikki Antimatterin pyynnöt käyttävät samaa avainta ja osoitetta.
AM_GIFS_LISTEN:8080Kuunteluosoite.
AM_GIFS_PUBLIC_URLfrom requestsUlkoista URL-osoitetta, jos palvelu on julkinen.
AM_GIFS_TRUST_PROXYfalseLuota X-Forwarded-*-otsakkeisiin, vain proxytaustalla.
AM_GIFS_UPLOAD_MAX_MB16Suurin lähetetty tiedosto.

Lisää omia GIF-kuvia massiivisesti tuomalla ne manifesin avulla hakemistosta, joka on liitetty kertakäyttöiseen astiaan:

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

Tuo aloitustarrat uudelleen päivityksen jälkeen: docker compose run --rm gifs stickers. Manifestin muoto ja muut komennot ovat gifs-serverin README-tiedostossa.

Sähköposti ja kalenteri

Sähköposti ja kalenteri yhdistävät jokaisen henkilön omaan postilaatikkoonsa (IMAP ja SMTP) ja omaan kalenteriinsa (CalDAV). Henkilöt syöttävät palvelimen ja salasanan sovellukseen; salasanat tallennetaan salattuina. Et määritä heille sähköposti- tai kalenteripalvelimia, mutta päätät, mihin he voivat yhdistyä:

SovellusAsetusOletusarvoToiminto
Sähköposti, kalenteriSalli sähköpostipalvelimet yksityisissä verkkoissa, Salli kalenteripalvelimet yksityisissä verkkoissa (AllowPrivateNetworks)Ei käytössäEi käytössä, palvelu hylkää yhteydet loopback-, yksityisiin ja linkkilokaali-osoitteisiin, jotta sovelluksia ei voi käyttää sisäisen verkkoasi tavoittamiseen. Ota käyttöön, jos sähköposti- tai kalenteripalvelimesi on yksityisessä osoitteessa.
Sähköposti, kalenteriSalli salaamattomat yhteydet (AllowInsecureConnections)Ei käytössäEi käytössä, yhteyksien on käytettävä TLS:ää (Sähköposti: TLS tai STARTTLS; Kalenteri: HTTPS).
SähköpostiLukemattomien tarkistusväli (minuutteja) (UnreadCheckMinutes)2 minuuttiaKuinka usein lukemattomien lukumäärä tarkistetaan, kun sähköpostipalvelu ei voi lähettää niitä eteenpäin.
SähköpostiSuurin viestin koko (MB) (MaxMessageSizeMB)25 MBRaja viestien koolla, jotka lähetetään ja luetaan.
KalenteriLähetä muistutukset (EnableReminders)onKalenteribotti lähettää suoran viestin tapahtumien edellä (10 minuuttia ennen, tapahtumille, joilla ei ole omaa hälytystään).

Jotta ihmiset voivat kirjautua Gmail- tai Microsoft 365 -postilaatikoihinsa tilinsä sijaan salasanalla, luo OAuth-asiakas ja täytä Sähköposti-sovelluksen Google- tai Microsoft-kentät:

  • Google: Web OAuth-asiakas Gmail API:lla ja alueella https://mail.google.com/.
  • Microsoft: Entra ID -sovellus delegoiduilla oikeuksilla IMAP.AccessAsUser.All, SMTP.Send, offline_access, openid, email ja profile. Vajaus on common oletuksena.
  • Molemmissa takaisinkytkennän URI on https://chat.example.com/plugins/com.antimatterchat.mail/oauth/callback (omasi sivuston URL).

Kanban, muistiinpanot, valkotaulu, kyselyt ja ohjekirjat

  • Kanban (focalboard) avautuu sivupaneelissa keskustelun viereen, kuten Ohjekirjat. Vanhat linkit /kanban/…- ja /boards/…-sivuille avaavat saman taulun tai kortin yhteisössä. Sen ainoa asetus, Ota julkisesti jaetut taulut käyttöön (EnablePublicSharedBoards, pois), antaa taulun muokkaajille mahdollisuuden jakaa taulu ketään linkin kanssa, ilman kirjautumista.
  • Muistiinpanoilla ja Kyselyillä ei ole asetuksia.
  • Valkotaulu: järjestelmän ylläpitäjät voivat ladata koko palvelimelle muotojen kirjastot (Excalidraw-.excalidrawlib-tiedostot, enintään 5 Mt kpl) sen asetus sivulla. Yhteisöjen ylläpitäjät hallinnoivat omien yhteisöjensä kirjastoja.
  • Ohjekirjat avautuu sivupaneelissa. Vanhat linkit /playbooks/…-sivuille avaavat saman suorituksen tai ohjekirjan yhteisössä. Sillä on muutama asetus, pääosin kokeelliset ominaisuudet; oletusarvot sopivat useimpiin palvelimiin.
  • Memet: Kuka voi lisätä memmalliitteitä: Kaikki (oletus), Järjestelmän ylläpitäjät tai Kukaan (mukautetut mallit pois), joka estää uusien mallien lisäämisen, mutta jo lisätyt pysyvät käytössä. Vieraille ei koskaan. Mallin lisännyt ja järjestelmän ylläpitäjät voivat poistaa sen.
  • Tehtävälistalla ei ole palvelimen asetuksia.

GitHub, GitLab ja Jira

Nämä sovellukset yhdistävät Antimatterin koodinvärastoon ja vikajäljittelemään. Jokainen vaatii OAuth-sovelluksen toisella puolella ja webhoonin, joka osoittaa takaisin Antimatteriin. Ota sovellus käyttöön ja aja sen asennuskomento missä tahansa kanavassa, joka ohjaa sinut vaihe vaiheelta: /github setup, /gitlab setup tai /jira setup.

SovellusOAuth-ohjaus-URLWebhook-URL
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> tai /jira instance install cloud-oauth <url>; /jira webhook tulostaa webhook-URLit.
Jätä Use Preregistered OAuth Application pois käytöstä GitHub- ja GitLab-sovelluksissa: se perustuu Mattermost-palveluun, jota Antimatterilla ei ole, ja sovellus kieltäytyy käynnistymästä, jos se on päällä. Rekisteröi oma OAuth-sovelluksesi.

GitHub- ja GitLab-sovellukset generoivat webhook-salasanansa ja salausavaimensa ensimmäisellä tallennuksella. GitHub-sovellus voidaan rajoittaa organisaatioihin (GithubOrg) ja GitLab-sovellus ryhmään (GitlabGroup); GitHub Enterprise -tai itse isännöidyn GitLabin tapauksessa aseta sen perus-URL.

Mittarit

Metrics-sovellus kerää palvelimen suorituskykytilastot pienen aikasarjatietokannan sisään Antimatteriin, jotta voit ladata ne tai sisällyttää ne tukipakettiin ilman Prometheusia. Kun se käynnistyy, se ottaa palvelimen metrikkipäätteen (MetricsSettings.Enable) käyttöön. Katso Operations.

Muiden sovellusten asennus

Antimatter ajaa Mattermost-sovelluksia (liitännäisiä). Kolme tapaa lisätä yksi:

  • Etäkaupasta. Ota etäkauppa käyttöön (PluginSettings.EnableRemoteMarketplace) on oletusarvona poissa, ja Kaupan URL (PluginSettings.MarketplaceURL) on tyhjä: Antimatter ei käytä Mattermostin sovelluskauppaa ja ohittaa sen osoitteen, jos Mattermostin asetuksissa on se vielä. Luetteloidaksesi luotettavan sovelluskauppapalvelimen sovellukset, ota asetus käyttöön ja aseta sen URL. Sen sovelluskaupan Antimatterin mukana toimitetut sovellukset (Calls, Playbooks, Kanban ja muut) ovat piilossa, joten ne eivät voi korvata Antimatterin omia: Salli Markkinapaikan Antimatter-liiteohjelmien rakennelmia (PluginSettings.AllowMarketplaceToReplaceAntimatterPlugins) on oletusarvona poissa.
  • Lähettämällä paketti (.tar.gz). Lähetys on oletusarvoisesti poistettu käytöstä, eikä sille ole vaihtoehtoa Järjestelmäkonsolissa: aseta AM_PLUGINSETTINGS_ENABLEUPLOADS=true ja käytä sitten Lähetä liiteohjelma -toimintoa Liiteohjelmien hallinnassa tai komentoa amctl --local plugin add app.tar.gz.
  • URL:stä: amctl plugin install-url <url>, myös kun lähetys on käytössä.

Antimatter tarkistaa sovellusten allekirjoitukset luottamustensa avainparien avulla: Antimatterin avain, avain, jolla Mattermost, Inc. allekirjoittaa julkaisemansa sovellukset (joten itse lataamasi Mattermost-sovellus asennetaan) ja kaikki avaimet, jotka lisäät kohtaan PluginSettings.SignaturePublicKeyFiles. Kun Vaadi lisäosan allekirjoitusta (PluginSettings.RequirePluginSignature, oletusarvoisesti poistettu käytöstä) on käytössä, allekirjoittamattomat sovellukset hylätään ja lähetys poistetaan käytöstä.

Sovellus ajetaan palvelimen sisällä ja sillä on täysi pääsy sen tietoihin. Asenna vain sovelluksia, joita luotat.

Jotkut Mattermostin maksullisille versioille tehdyt sovellukset tarkistavat Mattermost-lisenssin itsenäisesti ja kieltäytyvät ajamasta; Antimatter ei väitä omaavansa sellaista niiden puolesta.