Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,17 @@
r"https://support.twilio.com/*",
# This is a demo URL and should not be checked
r"https://api-ssl.bitly.com/*",
#This domain blocks the checker.
# This domain blocks the checker (403 Client Error).
r"https://linuxize.com/*",
# The GitHub Search UI requires users to be authenticated with session cookies, which we can't set up programmatically
r"https://github.com/search*",
# Requires authentication.
r"https://www.maxmind.com/en/accounts/current*",
# The URLs below broken and should be replaced by working ones.
r"https://staffwww.fullcoll.edu/sedwards/Nano/NanoKeyboardCommands.html",
r"https://blog.maxmind.com/search-results*"
# 403 client error from these domains
r"https://www.maxmind.com/en/home",
r"https://www.maxmind.com/en/geolite2/signup",
r"https://support.maxmind.com/hc/en-us/search*",
r"https://dev.mysql.com/doc/refman/5.7/en/regexp.html",
# 400 client error from this domain
r"https://developers.facebook.com/products/facebook-login/",
]
2 changes: 1 addition & 1 deletion docs/links/linux_file_folder_ownership.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "Linux file and folder ownership documentation"
link_text = "file and folder ownership"
link_url = "https://www.thegeekdiary.com/understanding-basic-file-permissions-and-ownership-in-linux/"
link_url = "https://www.digitalocean.com/community/tutorials/how-to-set-permissions-linux"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/maxmind_ccpa.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "MaxMind website"
link_text = "MaxMind website"
link_url = "https://blog.maxmind.com/search-results?q=ccpa"
link_url = "https://support.maxmind.com/hc/en-us/search?utf8=%E2%9C%93&query=ccpa"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/nano_kb_commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "Nano keyboard commands"
link_text = "Nano keyboard commands"
link_url = "https://staffwww.fullcoll.edu/sedwards/Nano/NanoKeyboardCommands.html"
link_url = "https://www.nano-editor.org/dist/latest/cheatsheet.html"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/transifex.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "Transifex"
link_text = "Transifex"
link_url = "https://www.transifex.com/mautic/mautic/"
link_url = "https://explore.transifex.com/mautic/mautic/"

link.xref_links.update({link_name: (link_text, link_url)})
2 changes: 1 addition & 1 deletion docs/links/transifex_language_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

link_name = "transifex-language-list"
link_text = "list of languages"
link_url = "https://www.transifex.com/mautic/mautic/"
link_url = "https://explore.transifex.com/mautic/mautic/"

link.xref_links.update({link_name: (link_text, link_url)})
7 changes: 3 additions & 4 deletions docs/plugins/social_login.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

Social login
############

Expand Down Expand Up @@ -26,13 +25,13 @@ Before you can use social login, each social media Plugin needs authorization. H
:width: 400
:alt: Screenshot of a callback URL input field.

2. **Add Your API Keys**: copy the API Key - Client Key - and API Secret - Client Secret - from the social platform. Paste these keys into the relevant fields in the Mautic Plugin configuration.```
2. **Add Your API Keys**: copy the API Key - Client Key - and API Secret - Client Secret - from the social platform. Paste these keys into the relevant fields in the Mautic Plugin configuration.

.. image:: images/API_key.png
:width: 400
:alt: Screenshot of an API Key input field.

1. **Authorize the Plugin**: in the Mautic Plugin configuration, click **Authorize**. You must **turn on** the Plugin - do this by toggling the option to “Yes”. Finally, save your configuration to complete the setup.
3. **Authorize the Plugin**: in the Mautic Plugin configuration, click **Authorize**. You must **turn on** the Plugin - do this by toggling the option to “Yes”. Finally, save your configuration to complete the setup.

.. Tip:: You can manage each social network under its respective tab in Mautic's Plugin settings. Make sure each network is fully authorized by adding the required API credentials.

Expand All @@ -54,7 +53,7 @@ Having configured the social Plugins, you can add social login buttons to your M
.. note::
Only the buttons for Plugins you've authorized work in the Form. Ensure you've configured all Integrations correctly for a smooth User experience.

Step 3: configuring features and mapping Contact fields```
Step 3: configuring features and mapping Contact fields
*******************************************************

After configuration and authorization of the Plugin, you can customize how Mautic handles the incoming social profile data. Under the **Contact Field Mapping** tab in the Plugin settings, map the fields from the User's social profile - for example Email, Name - to the appropriate Mautic Contact fields.
Expand Down
13 changes: 9 additions & 4 deletions docs/troubleshooting/file_ownership_permissions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,20 @@ File and folder permissions specify who and what can read, write, modify, and ac

User
====

A User is the owner of the file. By default, the person who created a file becomes its owner. Hence, a User is also sometimes called an **owner**.

Group
=====

A Group can contain multiple Users. All Users belonging to a Group have the same access permissions to the file. Groups simplify permissions - all Users in a specific Group inherit the permissions assigned to that Group, rather than having to assign permissions to each User individually.

Other
=====

Any other User who has access to a file comes into 'Other', meaning they have neither created the file, nor belong to a Group that owns the file. Practically, this means 'the rest of the world'. Hence, this is also referred to as **permissions for the world**.

Linux distinguishes between these three User types to prevent Users accessing, editing, or deleting files they shouldn't be able to change. Read more about :xref:`Linux file and folder ownership documentation`
Linux distinguishes between these three User types to prevent Users accessing, editing, or deleting files they shouldn't be able to change. Read more about :xref:`Linux file and folder ownership documentation`.

Permissions and ownership settings are critical to ensuring the security of your server and Mautic instance, so it's important to get them right. If your files don't have the appropriate permissions in place, it's easier for hackers to intrude on your files and gain access to your Mautic instance. Setting your file permissions correctly may not save you from all attacks, but it helps make your Mautic instance a bit more secure.

Expand All @@ -39,7 +42,7 @@ Mautic needs access to read and write files in the Mautic directory to enable ce

Problems with permissions and ownership generally occur because:

* You've uploaded Mautic or made changes to files and folders as a different User to the one that Mautic uses to run - for example you uploaded files using an FTP account with the username ``bob`` but your web server executes scripts as a User called ``www-data``.
* You've uploaded Mautic or made changes to files and folders as a different User to the one that Mautic uses to run - for example you uploaded files using an FTP account with the username ``bob`` but your web server executes scripts as a User called ``www-data``
* The User that Mautic uses to run doesn't have the appropriate permissions on the files and folders - for example, ``bob`` isn't able to create directories, or read files
* You ran an update as a different User to that which Mautic uses to run - resulting in some files and folders having their ownership changed

Expand All @@ -50,11 +53,13 @@ Resetting the permissions of your files and folders requires running some comman

Solution for hosting providers that offer cPanel access
=======================================================

A script to fix permissions & ownership, on files & directories, for cPanel accounts. You could ask your hosting provider to run that script to reset the permissions to the correct values. Find this handy script here: :xref:`cPanel fix permissions script`.

Identifying the problem
=======================
Log into your server using SSH, and change to the Mautic directory using the command

Log into your server using SSH, and change to the Mautic directory using the command:

.. code:: bash

Expand Down Expand Up @@ -96,7 +101,7 @@ To find out which User Apache is running as, run the following command and take

ps aux | grep apache2

Use this information to find the Groups with the following command
Use this information to find the Groups with the following command:

.. code:: bash

Expand Down