Extension:SendGrid/cs

Category:GPL licensed extensions/cs
Příručka k rozšířením MediaWiki
SendGrid
Stav rozšíření: stabilníCategory:Stable extensions/cs
Implementace OznámeníCategory:Notification extensions/cs
Popis Umožňuje MediaWiki používat API SendGrid pro distribuci e-mailů.
Autoři Derick Alangi (X-Savitardiskuse)
Nejnovější verze 4.0
Zásady kompatibility Vydání snímků současně s MediaWiki. Hlavní vývojová větev není zpětně kompatibilní.
MediaWiki 1.39+Category:Extensions with manual MediaWiki version/cs
PHP 7.4+
Composer sendgrid/sendgrid Category:Extensions supporting Composer/cs
Licence GNU General Public License 2.0 nebo novější
Stáhnout
Stáhněte si rozšíření
Git [?]:
Category:Extensions in Wikimedia version control/cs
README
Parametry
  • $wgSendGridAPIKey
Použité háčky (hooks)
Přeložte rozšíření SendGrid, používá-li lokalizaci z translatewiki.net
Problémy Otevřené úkoly · Nahlásit chybu
Category:All extensions/cs

Rozšíření SendGrid umožňuje MediaWiki odesílat e-maily prostřednictvím služby API SendGrid.

Instalace

  • Stáhněte soubor/y a vložte je do adresáře pojmenovaného SendGrid ve vaší složce extensions/.
    Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:
    cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/SendGrid
  • Na konec vašeho souboru LocalSettings.php přidejte následující kód: 
    wfLoadExtension( 'SendGrid' );
  • Yes Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Budete muset spustit composer update ve složce extensions/SendGrid/, aby composer mohl stáhnout a nainstalovat požadované závislosti SendGrid pro hladký chod rozšíření.

Konfigurace

Pro úspěšné odesílání e-mailů přes SendGrid pomocí tohoto rozšíření musíte mít účet na www.sendgrid.com a platný klíč API. Pokyny k vygenerování klíče API naleznete v dokumentaci ke klíči SendGrid API.

Varování Varování: Bezpečnostní varování: Nevkládejte klíč SendGrid API přímo do souboru SendGrid/extension.json, protože by to byla zranitelnost, která by umožnila někomu jinému použít váš účet/klíč k odesílání e-mailů nebo provádění jiných nekalých činností.

Konfigurace na MediaWiki-Vagrant

Jakmile je prostředí MediaWiki-Vagrant správně nastaveno, proveďte následující kroky, aby SendGrid správně fungoval s vaším novým prostředím;

  • Na terminálu spusťte: vagrant roles enable sendgrid.

V nastavení účtu SendGrid vygenerujte klíč API. S platným klíčem API nakonfigurujte svůj klíč API v LocalSettings.php:

$wgSendGridAPIKey = "YOUR_API_KEY_HERE";

Pokud toto rozšíření používáte se SMTP, nezapomeňte nakonfigurovat SMTP takto:

$wgSMTP = [
      'host'=> "smtp.yoursmtp.org",
      'IDHost'   => "yourhost.org",
      'port'     => 587,
      'auth'     => true,
      'username' => "yourSMTPusername",
      'password' => "yourSMTPpassword"
];

Otestujte si nastavení

Přejděte na Special:EmailUser a odešlete e-mail na svou vlastní adresu, abyste ověřili, zda rozšíření funguje. Z zadané adresy obdržíte e-mail a zkontrolujete, zda byl odeslán prostřednictvím rozhraní SendGrid API (například: váš název rozšíření@domain.com via sendgrid.net).

Využití produkčními wikinami

Toto rozšíření používají wikiny uvedené zde: https://wikiapiary.com/wiki/Extension:SendGrid (přes WikiApiary)

Chyby nebo výjimky

Pokud se odeslání e-mailu nepodaří a dojde k výjimce, ujistěte se, že hodnota $wgPasswordSender odpovídá identifikátoru odesílatele e-mailu použitému ve vašem účtu SendGrid.

Všimněte si změny: https://gerrit.wikimedia.org/r/c/mediawiki/extensions/SendGrid/+/833121

Category:All extensions/cs Category:AlternateUserMailer extensions/cs Category:Extensions in Wikimedia version control/cs Category:Extensions supporting Composer/cs Category:Extensions with manual MediaWiki version/cs Category:GPL licensed extensions/cs Category:Notification extensions/cs Category:Stable extensions/cs