Skip to content

Commit 99fce48

Browse files
javiereguiluzjaviereguiluz
committed
minor #20667 [Notifier] Reformat the tables that list the service integrations (javiereguiluz)
This PR was squashed before being merged into the 7.2 branch. Discussion ---------- [Notifier] Reformat the tables that list the service integrations We did this for the SMS services, but let's do it for the others too (e.g. I need it to fix #20662). Commits ------- 659937b [Notifier] Reformat the tables that list the service integrations
2 parents 142ad48 + 659937b commit 99fce48

File tree

1 file changed

+69
-41
lines changed

1 file changed

+69
-41
lines changed

‎notifier.rst‎

Lines changed: 69 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -350,30 +350,50 @@ The chat channel is used to send chat messages to users by using
350350
:class:`Symfony\\Component\\Notifier\\Chatter` classes. Symfony provides
351351
integration with these chat services:
352352

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

378398
.. versionadded:: 7.1
379399

@@ -569,18 +589,26 @@ The push channel is used to send notifications to users by using
569589
:class:`Symfony\\Component\\Notifier\\Texter` classes. Symfony provides
570590
integration with these push services:
571591

572-
=============== ==================================== ==============================================================================
573-
Service Package DSN
574-
=============== ==================================== ==============================================================================
575-
`Engagespot`_ ``symfony/engagespot-notifier`` ``engagespot://API_KEY@default?campaign_name=CAMPAIGN_NAME``
576-
`Expo`_ ``symfony/expo-notifier`` ``expo://Token@default``
577-
`Novu`_ ``symfony/novu-notifier`` ``novu://API_KEY@default``
578-
`Ntfy`_ ``symfony/ntfy-notifier`` ``ntfy://default/TOPIC``
579-
`OneSignal`_ ``symfony/one-signal-notifier`` ``onesignal://APP_ID:API_KEY@default?defaultRecipientId=DEFAULT_RECIPIENT_ID``
580-
`PagerDuty`_ ``symfony/pager-duty-notifier`` ``pagerduty://TOKEN@SUBDOMAIN``
581-
`Pushover`_ ``symfony/pushover-notifier`` ``pushover://USER_KEY:APP_TOKEN@default``
582-
`Pushy`_ ``symfony/pushy-notifier`` ``pushy://API_KEY@default``
583-
=============== ==================================== ==============================================================================
592+
=============== =======================================================================================
593+
Service
594+
=============== =======================================================================================
595+
`Engagespot`_ **Install**: ``composer require symfony/engagespot-notifier`` \
596+
**DSN**: ``engagespot://API_KEY@default?campaign_name=CAMPAIGN_NAME``
597+
`Expo`_ **Install**: ``composer require symfony/expo-notifier`` \
598+
**DSN**: ``expo://TOKEN@default``
599+
`Novu`_ **Install**: ``composer require symfony/novu-notifier`` \
600+
**DSN**: ``novu://API_KEY@default``
601+
`Ntfy`_ **Install**: ``composer require symfony/ntfy-notifier`` \
602+
**DSN**: ``ntfy://default/TOPIC``
603+
`OneSignal`_ **Install**: ``composer require symfony/one-signal-notifier`` \
604+
**DSN**: ``onesignal://APP_ID:API_KEY@default?defaultRecipientId=DEFAULT_RECIPIENT_ID``
605+
`PagerDuty`_ **Install**: ``composer require symfony/pager-duty-notifier`` \
606+
**DSN**: ``pagerduty://TOKEN@SUBDOMAIN``
607+
`Pushover`_ **Install**: ``composer require symfony/pushover-notifier`` \
608+
**DSN**: ``pushover://USER_KEY:APP_TOKEN@default``
609+
`Pushy`_ **Install**: ``composer require symfony/pushy-notifier`` \
610+
**DSN**: ``pushy://API_KEY@default``
611+
=============== =======================================================================================
584612

585613
To enable a texter, add the correct DSN in your ``.env`` file and
586614
configure the ``texter_transports``:
@@ -645,11 +673,11 @@ The desktop channel is used to display local desktop notifications on the same
645673
host machine using :class:`Symfony\\Component\\Notifier\\Texter` classes. Currently,
646674
Symfony is integrated with the following providers:
647675

648-
=============== ==================================== ==============================================================================
649-
Provider Package DSN
650-
=============== ==================================== ==============================================================================
651-
`JoliNotif`_ ``symfony/joli-notif-notifier`` ``jolinotif://default``
652-
=============== ==================================== ==============================================================================
676+
=============== ================================================ ==============================================================================
677+
Provider Install DSN
678+
=============== ================================================ ==============================================================================
679+
`JoliNotif`_ ``composer require symfony/joli-notif-notifier`` ``jolinotif://default``
680+
=============== ================================================ ==============================================================================
653681

654682
.. versionadded:: 7.2
655683

0 commit comments

Comments
 (0)