Skip to content

Commit 3add6de

Browse files
javiereguiluzjaviereguiluz
committed
Merge branch '7.2' into 7.3
* 7.2: [Notifier] Reformat the tables that list the service integrations
2 parents 8b5773b + 99fce48 commit 3add6de

File tree

1 file changed

+71
-42
lines changed

1 file changed

+71
-42
lines changed

‎notifier.rst‎

Lines changed: 71 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -358,31 +358,52 @@ The chat channel is used to send chat messages to users by using
358358
:class:`Symfony\\Component\\Notifier\\Chatter` classes. Symfony provides
359359
integration with these chat services:
360360

361-
======================================= ==================================== =============================================================================
362-
Service Package DSN
363-
======================================= ==================================== =============================================================================
364-
`AmazonSns`_ ``symfony/amazon-sns-notifier`` ``sns://ACCESS_KEY:SECRET_KEY@default?region=REGION``
365-
`Bluesky`_ ``symfony/bluesky-notifier`` ``bluesky://USERNAME:PASSWORD@default``
366-
`Chatwork`_ ``symfony/chatwork-notifier`` ``chatwork://API_TOKEN@default?room_id=ID``
367-
`Discord`_ ``symfony/discord-notifier`` ``discord://TOKEN@default?webhook_id=ID``
368-
`FakeChat`_ ``symfony/fake-chat-notifier`` ``fakechat+email://default?to=TO&from=FROM`` or ``fakechat+logger://default``
369-
`Firebase`_ ``symfony/firebase-notifier`` ``firebase://USERNAME:PASSWORD@default``
370-
`GoogleChat`_ ``symfony/google-chat-notifier`` ``googlechat://ACCESS_KEY:ACCESS_TOKEN@default/SPACE?thread_key=THREAD_KEY``
371-
`LINE Bot`_ ``symfony/line-bot-notifier`` ``linebot://TOKEN@default?receiver=RECEIVER``
372-
`LINE Notify`_ ``symfony/line-notify-notifier`` ``linenotify://TOKEN@default``
373-
`LinkedIn`_ ``symfony/linked-in-notifier`` ``linkedin://TOKEN:USER_ID@default``
374-
`Mastodon`_ ``symfony/mastodon-notifier`` ``mastodon://ACCESS_TOKEN@HOST``
375-
`Mattermost`_ ``symfony/mattermost-notifier`` ``mattermost://ACCESS_TOKEN@HOST/PATH?channel=CHANNEL``
376-
`Matrix`_ ``symfony/matrix-notifier`` ``matrix://HOST:PORT/?accessToken=ACCESSTOKEN&ssl=SSL``
377-
`Mercure`_ ``symfony/mercure-notifier`` ``mercure://HUB_ID?topic=TOPIC``
378-
`MicrosoftTeams`_ ``symfony/microsoft-teams-notifier`` ``microsoftteams://default/PATH``
379-
`RocketChat`_ ``symfony/rocket-chat-notifier`` ``rocketchat://TOKEN@ENDPOINT?channel=CHANNEL``
380-
`Slack`_ ``symfony/slack-notifier`` ``slack://TOKEN@default?channel=CHANNEL``
381-
`Telegram`_ ``symfony/telegram-notifier`` ``telegram://TOKEN@default?channel=CHAT_ID``
382-
`Twitter`_ ``symfony/twitter-notifier`` ``twitter://API_KEY:API_SECRET:ACCESS_TOKEN:ACCESS_SECRET@default``
383-
`Zendesk`_ ``symfony/zendesk-notifier`` ``zendesk://EMAIL:TOKEN@SUBDOMAIN``
384-
`Zulip`_ ``symfony/zulip-notifier`` ``zulip://EMAIL:TOKEN@HOST?channel=CHANNEL``
385-
====================================== ==================================== =============================================================================
361+
====================================== =====================================================================================
362+
Service
363+
====================================== =====================================================================================
364+
`AmazonSns`_ **Install**: ``composer require symfony/amazon-sns-notifier`` \
365+
**DSN**: ``sns://ACCESS_KEY:SECRET_KEY@default?region=REGION``
366+
`Bluesky`_ **Install**: ``composer require symfony/bluesky-notifier`` \
367+
**DSN**: ``bluesky://USERNAME:PASSWORD@default``
368+
`Chatwork`_ **Install**: ``composer require symfony/chatwork-notifier`` \
369+
**DSN**: ``chatwork://API_TOKEN@default?room_id=ID``
370+
`Discord`_ **Install**: ``composer require symfony/discord-notifier`` \
371+
**DSN**: ``discord://TOKEN@default?webhook_id=ID``
372+
`FakeChat`_ **Install**: ``composer require symfony/fake-chat-notifier`` \
373+
**DSN**: ``fakechat+email://default?to=TO&from=FROM`` or ``fakechat+logger://default``
374+
`Firebase`_ **Install**: ``composer require symfony/firebase-notifier`` \
375+
**DSN**: ``firebase://USERNAME:PASSWORD@default``
376+
`GoogleChat`_ **Install**: ``composer require symfony/google-chat-notifier`` \
377+
**DSN**: ``googlechat://ACCESS_KEY:ACCESS_TOKEN@default/SPACE?thread_key=THREAD_KEY``
378+
`LINE Bot`_ **Install**: ``composer require symfony/line-bot-notifier`` \
379+
**DSN**: ``linebot://TOKEN@default?receiver=RECEIVER``
380+
`LINE Notify`_ **Install**: ``composer require symfony/line-notify-notifier`` \
381+
**DSN**: ``linenotify://TOKEN@default``
382+
`LinkedIn`_ **Install**: ``composer require symfony/linked-in-notifier`` \
383+
**DSN**: ``linkedin://TOKEN:USER_ID@default``
384+
`Mastodon`_ **Install**: ``composer require symfony/mastodon-notifier`` \
385+
**DSN**: ``mastodon://ACCESS_TOKEN@HOST``
386+
`Matrix`_ **Install**: ``composer require symfony/matrix-notifier`` \
387+
**DSN**: ``matrix://HOST:PORT/?accessToken=ACCESSTOKEN&ssl=SSL``
388+
`Mattermost`_ **Install**: ``composer require symfony/mattermost-notifier`` \
389+
**DSN**: ``mattermost://ACCESS_TOKEN@HOST/PATH?channel=CHANNEL``
390+
`Mercure`_ **Install**: ``composer require symfony/mercure-notifier`` \
391+
**DSN**: ``mercure://HUB_ID?topic=TOPIC``
392+
`MicrosoftTeams`_ **Install**: ``composer require symfony/microsoft-teams-notifier`` \
393+
**DSN**: ``microsoftteams://default/PATH``
394+
`RocketChat`_ **Install**: ``composer require symfony/rocket-chat-notifier`` \
395+
**DSN**: ``rocketchat://TOKEN@ENDPOINT?channel=CHANNEL``
396+
`Slack`_ **Install**: ``composer require symfony/slack-notifier`` \
397+
**DSN**: ``slack://TOKEN@default?channel=CHANNEL``
398+
`Telegram`_ **Install**: ``composer require symfony/telegram-notifier`` \
399+
**DSN**: ``telegram://TOKEN@default?channel=CHAT_ID``
400+
`Twitter`_ **Install**: ``composer require symfony/twitter-notifier`` \
401+
**DSN**: ``twitter://API_KEY:API_SECRET:ACCESS_TOKEN:ACCESS_SECRET@default``
402+
`Zendesk`_ **Install**: ``composer require symfony/zendesk-notifier`` \
403+
**DSN**: ``zendesk://EMAIL:TOKEN@SUBDOMAIN``
404+
`Zulip`_ **Install**: ``composer require symfony/zulip-notifier`` \
405+
**DSN**: ``zulip://EMAIL:TOKEN@HOST?channel=CHANNEL``
406+
====================================== =====================================================================================
386407

387408
.. versionadded:: 7.1
388409

@@ -582,18 +603,26 @@ The push channel is used to send notifications to users by using
582603
:class:`Symfony\\Component\\Notifier\\Texter` classes. Symfony provides
583604
integration with these push services:
584605

585-
=============== ==================================== ==============================================================================
586-
Service Package DSN
587-
=============== ==================================== ==============================================================================
588-
`Engagespot`_ ``symfony/engagespot-notifier`` ``engagespot://API_KEY@default?campaign_name=CAMPAIGN_NAME``
589-
`Expo`_ ``symfony/expo-notifier`` ``expo://Token@default``
590-
`Novu`_ ``symfony/novu-notifier`` ``novu://API_KEY@default``
591-
`Ntfy`_ ``symfony/ntfy-notifier`` ``ntfy://default/TOPIC``
592-
`OneSignal`_ ``symfony/one-signal-notifier`` ``onesignal://APP_ID:API_KEY@default?defaultRecipientId=DEFAULT_RECIPIENT_ID``
593-
`PagerDuty`_ ``symfony/pager-duty-notifier`` ``pagerduty://TOKEN@SUBDOMAIN``
594-
`Pushover`_ ``symfony/pushover-notifier`` ``pushover://USER_KEY:APP_TOKEN@default``
595-
`Pushy`_ ``symfony/pushy-notifier`` ``pushy://API_KEY@default``
596-
=============== ==================================== ==============================================================================
606+
=============== =======================================================================================
607+
Service
608+
=============== =======================================================================================
609+
`Engagespot`_ **Install**: ``composer require symfony/engagespot-notifier`` \
610+
**DSN**: ``engagespot://API_KEY@default?campaign_name=CAMPAIGN_NAME``
611+
`Expo`_ **Install**: ``composer require symfony/expo-notifier`` \
612+
**DSN**: ``expo://TOKEN@default``
613+
`Novu`_ **Install**: ``composer require symfony/novu-notifier`` \
614+
**DSN**: ``novu://API_KEY@default``
615+
`Ntfy`_ **Install**: ``composer require symfony/ntfy-notifier`` \
616+
**DSN**: ``ntfy://default/TOPIC``
617+
`OneSignal`_ **Install**: ``composer require symfony/one-signal-notifier`` \
618+
**DSN**: ``onesignal://APP_ID:API_KEY@default?defaultRecipientId=DEFAULT_RECIPIENT_ID``
619+
`PagerDuty`_ **Install**: ``composer require symfony/pager-duty-notifier`` \
620+
**DSN**: ``pagerduty://TOKEN@SUBDOMAIN``
621+
`Pushover`_ **Install**: ``composer require symfony/pushover-notifier`` \
622+
**DSN**: ``pushover://USER_KEY:APP_TOKEN@default``
623+
`Pushy`_ **Install**: ``composer require symfony/pushy-notifier`` \
624+
**DSN**: ``pushy://API_KEY@default``
625+
=============== =======================================================================================
597626

598627
To enable a texter, add the correct DSN in your ``.env`` file and
599628
configure the ``texter_transports``:
@@ -658,11 +687,11 @@ The desktop channel is used to display local desktop notifications on the same
658687
host machine using :class:`Symfony\\Component\\Notifier\\Texter` classes. Currently,
659688
Symfony is integrated with the following providers:
660689

661-
=============== ==================================== ==============================================================================
662-
Provider Package DSN
663-
=============== ==================================== ==============================================================================
664-
`JoliNotif`_ ``symfony/joli-notif-notifier`` ``jolinotif://default``
665-
=============== ==================================== ==============================================================================
690+
=============== ================================================ ==============================================================================
691+
Provider Install DSN
692+
=============== ================================================ ==============================================================================
693+
`JoliNotif`_ ``composer require symfony/joli-notif-notifier`` ``jolinotif://default``
694+
=============== ================================================ ==============================================================================
666695

667696
.. versionadded:: 7.2
668697

0 commit comments

Comments
 (0)