diff --git a/docs/configuration/images/shortener-bitly.png b/docs/configuration/images/shortener-bitly.png new file mode 100644 index 00000000..9bbc46fe Binary files /dev/null and b/docs/configuration/images/shortener-bitly.png differ diff --git a/docs/configuration/shortener.rst b/docs/configuration/shortener.rst new file mode 100644 index 00000000..114b953e --- /dev/null +++ b/docs/configuration/shortener.rst @@ -0,0 +1,25 @@ +URL shortener service +##################### +.. attention:: + + Mautic 5 introduces a new shortening feature, replacing the previous legacy shortening system found in the settings. If you utilized the shortening service in Mautic 4, upon upgrading to Mautic 5, please follow the steps below to reconfigure it. + +The new URL shortener service allows developers to create Plugins for any shortener service, with any type of authorization. By default, Mautic does not provide a URL shortener service Plugin; you must install it either from the Marketplace or manually. + + +Example of setup Bitly plugin +============================= + +1. Install the Bitly bundle from the Marketplace or using Composer: + +.. code-block:: bash + + composer require webmecanik/mautic-bitly-bundle + +2. Obtain an access key from :xref:`Bitly API settings` and set up/enable the Bitly plugin. + +3. Navigate to Configuration > System Settings > Shortener Service and designate Bitly as the default shortener service. + +.. image:: images/shortener-bitly.png + :width: 600 + :alt: Screenshot of Bitly enabled for SMS \ No newline at end of file diff --git a/docs/links/bitly_api_settings.py b/docs/links/bitly_api_settings.py new file mode 100644 index 00000000..27f476df --- /dev/null +++ b/docs/links/bitly_api_settings.py @@ -0,0 +1,7 @@ +from . import link + +link_name = "Bitly API settings" +link_text = "Bitly API settings" +link_url = "https://app.bitly.com/settings/api" + +link.xref_links.update({link_name: (link_text, link_url)})