Skip to content
Snippets Groups Projects
Commit 54f61d6b authored by totten's avatar totten
Browse files

Merge branch 'master-newline' into 'master'

Normalize line-endings

See merge request !13
parents a8ceb38b 1b28b587
No related branches found
No related tags found
1 merge request!13Normalize line-endings
*.md text eol=lf
This diff is collapsed.
This diff is collapsed.
## Coming Soon ## Coming Soon
!!! note "" !!! note ""
This page is a placeholder for content being migrated in from the old Wiki. This page is a placeholder for content being migrated in from the old Wiki.
## Coming Soon ## Coming Soon
!!! note "" !!! note ""
This page is a placeholder for content being created to help configure filesystem permissions for CiviCRM. This page is a placeholder for content being created to help configure filesystem permissions for CiviCRM.
This diff is collapsed.
This diff is collapsed.
## Scope of this guide ## Scope of this guide
This guide is for people installing a [CiviCRM](https://civicrm.org) instance for an organization. It will take you through downloading and installing CiviCRM on one of the supported Content Management Systems. It is not intended to provide information on installing the CMS itself. This guide is for people installing a [CiviCRM](https://civicrm.org) instance for an organization. It will take you through downloading and installing CiviCRM on one of the supported Content Management Systems. It is not intended to provide information on installing the CMS itself.
### Installation Guide vs other guides ### Installation Guide vs other guides
We also have a [User Guide](https://docs.civicrm.org/user/en/latest) which covers all the functionality available through CiviCRM's web-based interface and a [SysAdmin Guide](https://docs.civicrm.org/sysadmin/en/latest) which covers more advanced administration. We also have a [User Guide](https://docs.civicrm.org/user/en/latest) which covers all the functionality available through CiviCRM's web-based interface and a [SysAdmin Guide](https://docs.civicrm.org/sysadmin/en/latest) which covers more advanced administration.
The two guides have some overlapping scope when it comes to setup and configuration. In general, we try to cover actions in the User Guide which the user can perform from within CiviCRM's user interface. Actions that require work outside of the CiviCRM interface (e.g. file-system or shell access) are covered in the System Administrator Guide. The two guides have some overlapping scope when it comes to setup and configuration. In general, we try to cover actions in the User Guide which the user can perform from within CiviCRM's user interface. Actions that require work outside of the CiviCRM interface (e.g. file-system or shell access) are covered in the System Administrator Guide.
## Editing this guide ## Editing this guide
* This guide is made with MkDocs and stored in a [GitLab repository](https://lab.civicrm.org/documentation/docs/installation). * This guide is made with MkDocs and stored in a [GitLab repository](https://lab.civicrm.org/documentation/docs/installation).
* See the ["Writing Documentation"](https://docs.civicrm.org/dev/en/latest/documentation)" page in the Developer Guide for specific details on editing this guide. * See the ["Writing Documentation"](https://docs.civicrm.org/dev/en/latest/documentation)" page in the Developer Guide for specific details on editing this guide.
## Credits ## Credits
This guide is collaboratively written by the CiviCRM community, with facilitation from the [Documentation Working Group](https://civicrm.org/working-groups/documentation). This guide is collaboratively written by the CiviCRM community, with facilitation from the [Documentation Working Group](https://civicrm.org/working-groups/documentation).
## Scope of this guide and alternative installation methods ## Scope of this guide and alternative installation methods
This guide covers standard installation of CiviCRM for production use. For installing a development environment, refer to the [section on Buildkit in the Developer Documentation](https://docs.civicrm.org/dev/en/latest/tools/buildkit/). This guide covers standard installation of CiviCRM for production use. For installing a development environment, refer to the [section on Buildkit in the Developer Documentation](https://docs.civicrm.org/dev/en/latest/tools/buildkit/).
## Before installing ## Before installing
1. Ensure that your system meets the [requirements](../general/requirements.md). 1. Ensure that your system meets the [requirements](../general/requirements.md).
1. Install Joomla by referring to the [Joomla Installation Guide](https://docs.joomla.org/J3.x:Installing_Joomla) if needed. 1. Install Joomla by referring to the [Joomla Installation Guide](https://docs.joomla.org/J3.x:Installing_Joomla) if needed.
!!! note "Path for Joomla" !!! note "Path for Joomla"
The rest of these instructions assume that you have Joomla installed in `/var/www/JOOMLA_ROOT`. Adjust paths as needed. The rest of these instructions assume that you have Joomla installed in `/var/www/JOOMLA_ROOT`. Adjust paths as needed.
## Download and Un-tar CiviCRM Code {:#download} ## Download and Un-tar CiviCRM Code {:#download}
All CiviCRM code and packages used by CiviCRM (such as PEAR libraries) are included in the compressed CiviCRM distribution files ('tarballs'). Follow these steps to download and install the codebase: All CiviCRM code and packages used by CiviCRM (such as PEAR libraries) are included in the compressed CiviCRM distribution files ('tarballs'). Follow these steps to download and install the codebase:
* Download the appropriate tarball file from the [CiviCRM website](https://civicrm.org/download) within your browser. Tarball file-names include the CiviCRM version. For example, `civicrm-x.x.x-joomla.zip`. If you have command line access to your server, use `wget` and the URL of the file to pull a copy directly to your server. Then you can skip the next step. * Download the appropriate tarball file from the [CiviCRM website](https://civicrm.org/download) within your browser. Tarball file-names include the CiviCRM version. For example, `civicrm-x.x.x-joomla.zip`. If you have command line access to your server, use `wget` and the URL of the file to pull a copy directly to your server. Then you can skip the next step.
* Upload this file to a folder in your root Joomla directory. Recommended location: `JOOMLA_ROOT/tmp/`. * Upload this file to a folder in your root Joomla directory. Recommended location: `JOOMLA_ROOT/tmp/`.
* Unzip the package, which will create a directory called: `com_civicrm`. On cPanel, you can use the File Manager's Extract function to unzip the file you uploaded. * Unzip the package, which will create a directory called: `com_civicrm`. On cPanel, you can use the File Manager's Extract function to unzip the file you uploaded.
Note: when installing a new version over an old one, please first check [troubleshooting resources](#troubleshooting) below. Note: when installing a new version over an old one, please first check [troubleshooting resources](#troubleshooting) below.
## Run the Installer {:#installer} ## Run the Installer {:#installer}
* Login to your Joomla Administrator site. * Login to your Joomla Administrator site.
* Go to **Extensions >> Install/Uninstall**. * Go to **Extensions >> Install/Uninstall**.
* Use **Install from Directory** and enter the full path to the un-zipped com_civicrm directory, which should be something like: `JOOMLA_ROOT/tmp/com_civicrm` . In most Joomla installations, the root directory and /tmp/ folder will already populate the "install from directory" field. You must simply add the /com_civicrm/ subfolder at the end. Click Install. If that doesn't work: * Use **Install from Directory** and enter the full path to the un-zipped com_civicrm directory, which should be something like: `JOOMLA_ROOT/tmp/com_civicrm` . In most Joomla installations, the root directory and /tmp/ folder will already populate the "install from directory" field. You must simply add the /com_civicrm/ subfolder at the end. Click Install. If that doesn't work:
* put the full file system path to the `com_civicrm`, something like `/var/www/JOOMLA_ROOT/tmp/com_civicrm/`. * put the full file system path to the `com_civicrm`, something like `/var/www/JOOMLA_ROOT/tmp/com_civicrm/`.
* You should see "Component successfully installed" message. * You should see "Component successfully installed" message.
!!! warning !!! warning
If you get the following error when installing or upgrading CiviCRM for Joomla - you can downloading the alternate Joomla install file - `civicrm-x.x.x-joomla-alt.zip` - which doesn't require built-in unzip functionality on your server. Then repeat the install steps starting with [running the installer](#installer). If you get the following error when installing or upgrading CiviCRM for Joomla - you can downloading the alternate Joomla install file - `civicrm-x.x.x-joomla-alt.zip` - which doesn't require built-in unzip functionality on your server. Then repeat the install steps starting with [running the installer](#installer).
> Your PHP version is missing zip functionality. Please ask your system administrator / hosting provider to recompile PHP with zip support. > Your PHP version is missing zip functionality. Please ask your system administrator / hosting provider to recompile PHP with zip support.
Note that missing PHP Zip functionality *will* prevent CiviCRM from installing extensions via the GUI. Note that missing PHP Zip functionality *will* prevent CiviCRM from installing extensions via the GUI.
## Create CiviCRM Contacts for Existing Joomla Users {:#contacts-users} ## Create CiviCRM Contacts for Existing Joomla Users {:#contacts-users}
Once installed, CiviCRM keeps your Joomla Users synchronized with corresponding CiviCRM contact records. The 'rule' is that there will be a matched contact record for each Joomla user record. Conversely, only contacts who are authenticated users of your site will have corresponding Joomla user records. Once installed, CiviCRM keeps your Joomla Users synchronized with corresponding CiviCRM contact records. The 'rule' is that there will be a matched contact record for each Joomla user record. Conversely, only contacts who are authenticated users of your site will have corresponding Joomla user records.
When CiviCRM is installed on top of an existing Joomla site, a special CiviCRM Administrative feature allows you to automatically create CiviCRM contacts for all existing Joomla users: When CiviCRM is installed on top of an existing Joomla site, a special CiviCRM Administrative feature allows you to automatically create CiviCRM contacts for all existing Joomla users:
* Login to your Joomla site with an administrator-level login * Login to your Joomla site with an administrator-level login
* Click the **Components > CiviCRM > CiviCRM Home** link in the main navigation block * Click the **Components > CiviCRM > CiviCRM Home** link in the main navigation block
* Click **Administer > Users and Permissions > Synchronize Users-to-Contacts** * Click **Administer > Users and Permissions > Synchronize Users-to-Contacts**
## Troubleshooting Resources {:#troubleshooting} ## Troubleshooting Resources {:#troubleshooting}
* If the CiviCRM component does not install correctly (for example you get a blank screen instead of the confirmation page), delete the `~/components/com_civicrm` and `~/administrator/components/com_civicrm` and `~/media/civicrm directories` manually and then try each of the following before attempting to reinstall: * If the CiviCRM component does not install correctly (for example you get a blank screen instead of the confirmation page), delete the `~/components/com_civicrm` and `~/administrator/components/com_civicrm` and `~/media/civicrm directories` manually and then try each of the following before attempting to reinstall:
* In your `php.ini` file or in `.htaccess` file in the Joomla root folder (if your server allows it), increase the `max_execution_time` to `600` and memory limit to more than 64M. Add the following to the `.htaccess` file in your Joomla root folder * In your `php.ini` file or in `.htaccess` file in the Joomla root folder (if your server allows it), increase the `max_execution_time` to `600` and memory limit to more than 64M. Add the following to the `.htaccess` file in your Joomla root folder
<!-- markdownlint-disable MD046 --> <!-- markdownlint-disable MD046 -->
``` htaccess ``` htaccess
php_value memory_limit 128M php_value memory_limit 128M
php_value register_globals off php_value register_globals off
php_value max_execution_time 600 php_value max_execution_time 600
``` ```
If you can't change the `.htaccess` file you can add a php.ini (or `.user.ini`) file in Joomla root folder or all directories, depending on your web server or hosting company. If you can't change the `.htaccess` file you can add a php.ini (or `.user.ini`) file in Joomla root folder or all directories, depending on your web server or hosting company.
``` ini ``` ini
memory_limit = 128M memory_limit = 128M
register_globals = off register_globals = off
max_execution_time = 600 max_execution_time = 600
``` ```
<!-- markdownlint-enable MD046 --> <!-- markdownlint-enable MD046 -->
* CiviCRM is packaged with all the libraries (PEAR etc) that it uses. However a misconfigured or overly restrictive `open_basedir` directive on your web server might interfere with CiviCRM's ability to access some required files or directories. To turn `open_basedir` off, add this to your `vhost.conf` file: `php_admin_value open_basedir none` or ask your host to either turn it off or ensure that it is not preventing access to required directories (e.g. if you move configuration files or temp folders outside your web root). The configuration of sub domains might cause related issues: try installing in the main domain root or a sub folder instead. * CiviCRM is packaged with all the libraries (PEAR etc) that it uses. However a misconfigured or overly restrictive `open_basedir` directive on your web server might interfere with CiviCRM's ability to access some required files or directories. To turn `open_basedir` off, add this to your `vhost.conf` file: `php_admin_value open_basedir none` or ask your host to either turn it off or ensure that it is not preventing access to required directories (e.g. if you move configuration files or temp folders outside your web root). The configuration of sub domains might cause related issues: try installing in the main domain root or a sub folder instead.
* If CiviCRM screens are not displaying properly and/or javascript widgets are not functioning, check your CiviCRM Resource URL (Administer >> System Settings >> Resource URLs). For Joomla installs, it should be something like: `http://example.org/administrator/components/com_civicrm/civicrm` * If CiviCRM screens are not displaying properly and/or javascript widgets are not functioning, check your CiviCRM Resource URL (Administer >> System Settings >> Resource URLs). For Joomla installs, it should be something like: `http://example.org/administrator/components/com_civicrm/civicrm`
* Review the [Troubleshooting](../general/troubleshooting.md) page for help with problems you may encounter during the installation. * Review the [Troubleshooting](../general/troubleshooting.md) page for help with problems you may encounter during the installation.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment