From eedd72cd98aa095dc0713a4bb27d823c7fe38d1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Romey?= Date: Thu, 27 Aug 2020 16:44:35 +0200 Subject: [PATCH] Update Notifier bridge DSN in readme --- .../Component/Notifier/Bridge/GoogleChat/README.md | 14 +++++++++++++- .../Component/Notifier/Bridge/Infobip/README.md | 11 ++++++++--- .../Component/Notifier/Bridge/LinkedIn/README.md | 4 ++++ .../Component/Notifier/Bridge/Mobyt/README.md | 12 +++++++++--- .../Component/Notifier/Bridge/Zulip/README.md | 13 +++++++++++++ 5 files changed, 47 insertions(+), 7 deletions(-) diff --git a/src/Symfony/Component/Notifier/Bridge/GoogleChat/README.md b/src/Symfony/Component/Notifier/Bridge/GoogleChat/README.md index 09860d21e2..d1d85ebc2d 100644 --- a/src/Symfony/Component/Notifier/Bridge/GoogleChat/README.md +++ b/src/Symfony/Component/Notifier/Bridge/GoogleChat/README.md @@ -3,7 +3,19 @@ Google Chat Notifier Provides Google Chat integration for Symfony Notifier. - googlechat://ACCESS_KEY:ACCESS_TOKEN@default/SPACE?threadKey=THREAD_KEY +DSN example +----------- + +``` +// .env file +INFOBIP_DSN=googlechat://ACCESS_KEY:ACCESS_TOKEN@default/SPACE?threadKey=THREAD_KEY +``` + +where: + - `ACCESS_KEY` is your Google Chat access key + - `ACCESS_TOKEN` is your Google Chat access token + - `SPACE` is the Google Chat space + - `THREAD_KEY` is the the Google Chat message thread to group messages into a single thread Resources --------- diff --git a/src/Symfony/Component/Notifier/Bridge/Infobip/README.md b/src/Symfony/Component/Notifier/Bridge/Infobip/README.md index 76419a6097..91b3d482bf 100644 --- a/src/Symfony/Component/Notifier/Bridge/Infobip/README.md +++ b/src/Symfony/Component/Notifier/Bridge/Infobip/README.md @@ -3,13 +3,18 @@ Infobip Notifier Provides Infobip integration for Symfony Notifier. -DSN should be as follow: +DSN example +----------- ``` -infobip://authtoken@infobiphost?from=0611223344 +// .env file +INFOBIP_DSN=infobip://AUTH_TOKEN@INFOBIP_HOST?from=FROM ``` -`authtoken` and `infobiphost` are given by Infobip ; `from` is the sender. +where: + - `AUTH_TOKEN` is your Infobip auth token + - `INFOBIP_HOST` is your Infobip host + - `FROM` is the sender Resources --------- diff --git a/src/Symfony/Component/Notifier/Bridge/LinkedIn/README.md b/src/Symfony/Component/Notifier/Bridge/LinkedIn/README.md index 67d30b863d..907b5cfc8b 100644 --- a/src/Symfony/Component/Notifier/Bridge/LinkedIn/README.md +++ b/src/Symfony/Component/Notifier/Bridge/LinkedIn/README.md @@ -11,6 +11,10 @@ DSN example LINKEDIN_DSN='linkedin://ACCESS_TOKEN:USER_ID@default' ``` +where: + - `ACCESS_TOKEN` is your LinkedIn access token + - `USER_ID` is your LinkedIn user id + Resources --------- diff --git a/src/Symfony/Component/Notifier/Bridge/Mobyt/README.md b/src/Symfony/Component/Notifier/Bridge/Mobyt/README.md index 88fa03f3ad..f992b3e1ed 100644 --- a/src/Symfony/Component/Notifier/Bridge/Mobyt/README.md +++ b/src/Symfony/Component/Notifier/Bridge/Mobyt/README.md @@ -3,13 +3,19 @@ Mobyt Notifier Provides [Mobyt](https://www.mobyt.it/en/) integration for Symfony Notifier. -DSN should be as follow: +DSN example +----------- ``` -mobyt://USER_KEY:ACCESS_TOKEN@default?from=FROM +// .env file +MOBYT_DSN=mobyt://USER_KEY:ACCESS_TOKEN@default?from=FROM&type_quality=TYPE_QUALITY ``` -`USER_KEY` and `ACCESS_TOKEN` are given by Mobyt ; `FROM` is the sender name. +where: + - `USER_KEY` is your Mobyt user key + - `ACCESS_TOKEN` is your Mobyt access token + - `TYPE_QUALITY` is the quality : `N` for high, `L` for medium, `LL` for low (default: `L`) + - `FROM` is the sender Resources --------- diff --git a/src/Symfony/Component/Notifier/Bridge/Zulip/README.md b/src/Symfony/Component/Notifier/Bridge/Zulip/README.md index b934146398..1c5052fee9 100644 --- a/src/Symfony/Component/Notifier/Bridge/Zulip/README.md +++ b/src/Symfony/Component/Notifier/Bridge/Zulip/README.md @@ -3,6 +3,19 @@ Zulip Notifier Provides Zulip integration for Symfony Notifier. +DSN example +----------- + +``` +// .env file +ZULIP_DSN=zulip://EMAIL:TOKEN@default?channel=Channel +``` + +where: + - `EMAIL` is your Zulip email + - `TOKEN` is your Zulip token + - `Channel` is the channel + Resources ---------