Merge branch '5.x' into bump-dependencies

.gitpod.yml

@@ -12,23 +12,4 @@ vscode:
     - lextudio.restructuredtext
     - trond-snekvik.simple-rst
     - errata-ai.vale-server
-    - eamodio.gitlens
-
-github:
-  prebuilds:
-    # enable for the master/default branch (defaults to true)
-    master: true
-    # enable for all branches in this repo (defaults to false)
-    branches: true
-    # enable for pull requests coming from this repo (defaults to true)
-    pullRequests: true
-    # enable for pull requests coming from forks (defaults to false)
-    pullRequestsFromForks: true
-    # add a check to pull requests (defaults to true)
-    addCheck: false
-    # add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
-    addComment: false
-    # add a "Review in Gitpod" button to the pull request's description (defaults to false)
-    addBadge: true
-    # add a label once the prebuild is ready to pull requests (defaults to false)
-    addLabel: false
+    - eamodio.gitlens

docs/links/Vtiger.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Vtiger" 
+link_text = "Vtiger" 
+link_url = "https://www.vtiger.com/" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/amazon_account.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Create an AWS account" 
+link_text = "Create an AWS account" 
+link_url = "https://docs.aws.amazon.com/AmazonS3/latest/userguide/setting-up-s3.html#sign-up-for-aws-gsg" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/amazon_tier.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "pricing tiers for S3" 
+link_text = "pricing tiers for S3" 
+link_url = "https://aws.amazon.com/s3" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/gpassarelli_github.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "@gpassarelli" 
+link_text = "@gpassarelli" 
+link_url = "https://github.com/gpassarelli" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/hubspot.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "HubSpot CRM" 
+link_text = "HubSpot CRM" 
+link_url = "https://www.hubspot.com/products/crm" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/hubspot_app.py

@@ -0,0 +1,8 @@
+from . import link
+
+link_name = "HubSpot API key" 
+link_text = "HubSpot API key" 
+link_url = "https://app.hubspot.com" 
+
+link.xref_links.update({link_name: (link_text, link_url)})
+

docs/links/hubspot_doc.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Source" 
+link_text = "Source" 
+link_url = "https://legacydocs.hubspot.com/docs/methods/companies/get_companies_modified" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/iam_user_signin.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Sign in as IAM user" 
+link_text = "Sign in as IAM user" 
+link_url = "https://docs.aws.amazon.com/AmazonS3/latest/userguide/setting-up-s3.html#signing-in-iam-user-gsg" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/plugins_documentation.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Plugins developer documentation" 
+link_text = "Plugins developer documentation" 
+link_url = "https://developer.mautic.org/#plugins" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/setup_amazon_bucket.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Set up your bucket" 
+link_text = "Set up your bucket" 
+link_url = "https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-bucket.html" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/setup_iam_user.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Set up an IAM user" 
+link_text = "Set up an IAM user" 
+link_url = "https://docs.aws.amazon.com/AmazonS3/latest/userguide/setting-up-s3.html#create-an-iam-user-gsgD" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/zoho_api_console.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Zoho API Console" 
+link_text = "Zoho API Console" 
+link_url = "https://api-console.zoho.com" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/links/zoho_crm.py

@@ -0,0 +1,7 @@
+from . import link
+
+link_name = "Zoho CRM" 
+link_text = "Zoho CRM" 
+link_url = "https://www.zoho.com/crm/" 
+
+link.xref_links.update({link_name: (link_text, link_url)})

docs/plugins/amazon.rst

@@ -3,4 +3,77 @@
 Amazon S3
 #########
 
-.. vale on
+.. vale on
+
+The Amazon S3 Plugin allows you to host your :doc:`Assets</components/assets>` on an Amazon S3 bucket instead of hosting them on your local server. When creating an Asset you select from your S3 bucket, rather than your local computer.
+
+Setting up an S3 bucket
+***********************
+
+To get started, you need to sign up for an Amazon account. Ensure you are familiar with the :xref:`pricing tiers for S3` before you commit to using it.
+
+If you are new to Amazon Web Services, follow these steps to set up your Amazon S3 account. The following steps are important to ensure you aren't using your root account for day-to-day tasks:
+
+1. :xref:`Create an AWS account`
+2. :xref:`Set up an IAM user`
+3. :xref:`Sign in as IAM user`
+4. :xref:`Set up your bucket`
+
+.. note:: 
+
+     The region you select for your bucket is important from a data protection perspective and you will need to copy this value to use when you set up Mautic. Consult your privacy policy and act accordingly.
+
+Now that you have created a bucket, create a user who can access it. Instead of using the credentials for your master account which expose you to significant risk if they're ever exposed, use the credentials for this user in Mautic.
+
+1. Select your **account name** in the top right corner.
+2. Select **Security Credentials** from the drop-down list.
+3. Select **Users** > **Add User** and provide a name.
+4. Select **programmatic access**.
+
+.. image:: images/screenshot-consoleawsamazoncom-20200413-214200-0c7aeda7.png
+  :alt: Screenshot of Amazon S3
+
+5. Select Attach existing policies directly, filter for S3 by typing it in the search box, and select AmazonS3FullAccess.
+
+.. image:: images/screenshot-consoleawsamazoncom-20200413-214347-d238a53c.png
+  :alt: Screenshot of Amazon S3
+
+6. Click **Next** button to proceed through, as you don't need to assign any tags.
+7. Create a user after reviewing the information submitted.
+
+.. image:: images/screenshot-consoleawsamazoncom-20200413-214631-35da93f9.png
+  :alt: Screenshot of Amazon S3
+
+8.  Next, you can view the **Access Key ID** and the **Secret Access Key**.
+
+.. note:: 
+
+     You must make a copy of these credentials as you won't be able to access them again. Download them and/or save them securely.
+
+Setting up S3 in Mautic
+***********************
+
+With the bucket details and a user with the correct credentials, it's time to set up Mautic to use this bucket.
+
+1. Go to **Settings** > **Plugins**
+2. Click the **Amazon S3** Plugin.
+3. Click the **install/upgrade Plugins**, if you don't see the Amazon S3 Plugin.
+4. Enter the **ID**, secret from your user, and the bucket name. 
+
+.. image:: images/amazon-enabled.png
+  :width: 400
+  :align: center
+  :alt: Screenshot of Amazon Integration Form
+
+5. Enter the **bucket location** as configured in Amazon S3.
+6. Click **Save** to save your changes
+7. Click the next tab, **Features**, to ensure that the option to use a cloud provider for Assets is selected.
+
+.. image:: images/amazon-features.png
+  :alt: Screenshot of Amazon Integration Form
+
+
+8. Click **Save & Close**, and refresh the Plugins page - the Amazon S3 Plugin icon will be in color rather than ``Grayscale``, indicating that it's active.
+
+When you upload an Asset to your S3 bucket you can select it by creating a new Asset and choosing Remote Files > S3.
+

docs/plugins/clearbit.rst

@@ -1,6 +1,31 @@
-.. vale off
-
 Clearbit
-#########
+########
+
+This Plugin can:
+
+* Pull data from Clearbit via the API about Contacts and Companies into Mautic.
+
+Requirements
+************
+
+* Mautic installed on a publicly accessible URL. Due to the need for callbacks from Clearbit to Mautic, this Plugin won't work on a localhost.
+
+* Get a Clearbit API key
+
+Authorize the Plugin
+********************
+
+.. image:: images/screenshot-consoleawsamazoncom-20200413-214631-35da93f9.png
+  :alt: Screenshot of Clearbit
+
+Usage
+******
+
+A dropdown menu and a toolbar at the top are both present on the Contacts and Companies pages:
+
+.. image
+
+A confirmation window pops up when you click one of those buttons:
+
+Upon finding the information, the Contact/Company details updates shortly after.
 
-.. vale on

docs/plugins/gmail.rst

@@ -1,6 +1,47 @@
-.. vale off
-
 GMail
 ######
 
-.. vale on
+This plugin enables the Mautic Helper Chrome Extension to track emails sent to leads directly from GMail.
+
+Requirements:
+
+1. A publicly accessible Mautic installation.
+
+2. A GMail account (for email tracking).
+
+3. Mautic Helper Chrome Extension.
+
+Plugin Configuration:
+
+Follow these steps to configure the Plugin:
+
+1. Install the Mautic Plugin as usual. It'll appear on the Plugins page in Mautic.
+
+2. Click on the GMail Plugin button and enter a secret or key to validate the Mautic Helper Chrome Extension
+
+3. Install the Mautic Helper Chrome Extension from the Chrome Web Store
+
+4. Configure the extension using the options page that will automatically be displayed. (Remember to use the same secret you entered in Mautic)
+
+5. On the Chrome browser there will be a button that will notify of new events on the contacts timeline.
+
+6. To track an email sent to a lead, click the Track Email button on the Compose window in GMail
+
+7. This appends a tracking GIF to the email with the following syntax: ``[[MAUTIC_URL]]/index.php/gmail/tracking.gif?d=H4sIAAAAAAAEAIVRTW%2FCMAz9LRyCtgNVlFBpHHroWsRuk8ak7RpaUzqaGCUp0H8%2Fpy0TH4dJUZy892w921uLOvkCa8BGK2WLWi2dt6pUbM7PYPEcFainoFXdJKdBVvUy4quA9rxrNz9Q%2BCQ16HdgmeAenKewpfIU3lvfIO6nGyy75HNXO8LQAN3984R2X5tqMpkwnjOejrfg19%2FBJIHBJsskS3M1MOvOedChUA5HaPBAsp54a7UyBH%2BAw9YWECRrsMc6PHvFd2iR0NfW1QbcjUDwMjhctYqqq0YxkQU6SqMhNxi85GeoD8p0134zaBom%2By4ezlPMxTPFeCH5TLzI%2BdgizeEu5aIUQixmIubjSG5WAY8bC8kyC%2FvxSBX%2Flcvl3bT%2Fvr8k1oBgIQIAAA%3D%3D&sig=cf078d5b``
+
+8. The Mautic Plugin will then validate the information using the secret to compare signatures and then attach that email to the contact’s profile as part of their activity history. If the lead or leads don't exist, they are created automatically
+
+.. vale off
+
+URL Parameter Length Issue
+**************************
+
+.. vale on
+
+Please note that PHP setups with the Suhosin patch installed will have a default limit of 512 characters for get parameters.
+
+Although bad practice, most browsers (including IE) supports URLs up to around 2000 characters, while Apache has a default of 8000.
+
+To add support for long parameters with Suhosin add the following to ``php.ini``:
+
+``suhosin.get.max_value_length = 5000``