Skip to content

Commit

Permalink
Merge pull request #191 from kuzmany/shortener-service-support
Browse files Browse the repository at this point in the history
Add support for shortener services
  • Loading branch information
RCheesley committed Jan 9, 2024
2 parents 2705a29 + 9f39fb8 commit 112d11f
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 0 deletions.
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.
25 changes: 25 additions & 0 deletions docs/configuration/shortener.rst
Original file line number Diff line number Diff line change
@@ -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
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)})

0 comments on commit 112d11f

Please sign in to comment.