Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for shortener services #191

Merged
merged 13 commits into from
Jan 9, 2024
Binary file added docs/configuration/images/shortener-bitly.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions docs/configuration/shortener.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.. vale off

URL shortener service
RCheesley marked this conversation as resolved.
Show resolved Hide resolved
#################
RCheesley marked this conversation as resolved.
Show resolved Hide resolved

RCheesley marked this conversation as resolved.
Show resolved Hide resolved
.. 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
7 changes: 7 additions & 0 deletions docs/links/bitly_api_settings.py
Original file line number Diff line number Diff line change
@@ -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)})