stancel.git-download-suitecrm

git-download-suitecrm

=========

This is an Ansible role that helps you download and install a specific version of SuiteCRM.

Requirements

Make sure you already have MySQL, MariaDB, or Percona Server, and a web server (Apache or Nginx) set up and running. The setup assumes you are using a Debian-based Linux (like Ubuntu or Debian) and that your web server’s document root is /var/www/html. You can change these settings if needed.

Role Variables

Choose which version of SuiteCRM you want to download and install. There is no default version set.

git_download_suitecrm_tagged_release_version: "v7.10.9"

The default Git repository from which to download SuiteCRM. You can change this if you want to use a different repo.

git_download_suitecrm_git_repo: "https://github.com/salesagility/SuiteCRM.git"

If you're using your own repository and want to use a specific branch rather than a tagged release, specify the branch name and comment out the previous variable. The default is an empty string.

git_download_suitecrm_git_branch: "my-super-special-branch"

Specify the name of the database to create for the application. The default is "suitecrm".

git_download_suitecrm_db_name: "suitecrm"

Set the database user that the application will use. No default value is provided.

git_download_suitecrm_db_user: "suitecrmDbUser"

Set the password for the database user. No default value is provided.

git_download_suitecrm_db_password: "some-really-secure-password"

This is the root password for your MySQL, MariaDB, or Percona Server instance, needed to create the database and user.

git_download_suitecrm_mysql_root_password: "your MySQL root password"

The location where the application files will be stored on your web server. The default is /var/www/html, assuming you’re using Apache on Debian or Ubuntu.

The first part of the path represents the root directory of your web server:

git_download_suitecrm_web_files_path: "/var/www"

The second part is the directory for the application inside the root:

git_download_suitecrm_web_directory_for_application: "/html"

Be careful with the starting /.

The Linux username used by your web server. The default is www-data, which assumes you're using Apache on Debian or Ubuntu.

git_download_suitecrm_web_user: "www-data"

The Linux group used by your web server. The default is www-data.

git_download_suitecrm_web_group: "www-data"

To manage packages with apt, you can choose to disable package installation:

git_download_suitecrm_manage_packages: true

Settings for php.ini. These let you enable or disable certain configurations, which is helpful if your server has different values set. The default for all is true.

git_download_suitecrm_configure_mysqli_allow_local_infile: true
git_download_suitecrm_configure_memory_limit: true
git_download_suitecrm_configure_post_max_size: true
git_download_suitecrm_configure_upload_max_filesize: true
git_download_suitecrm_configure_max_input_time: true
git_download_suitecrm_configure_max_execution_time: true
git_download_suitecrm_configure_php_timezone: true

To install Composer. Default is true; set to false if Composer is already installed.

git_download_suitecrm_install_composer: true

Determine whether this installation is "new", "upgrade", or "restore". Both "new" and "upgrade" will download files from Git. "Restore" skips Git downloads and expects a later role to restore files. Default is "new".

git_download_suitecrm_installation_type: "new"

Identify the purpose of this instance: "dev", "qa", or "prod". Only "prod" environments will deploy the SuiteCRM schedulers. Default is "prod".

git_download_suitecrm_environment_type: "prod"

Dependencies

None

Example Playbook

You can copy and edit defaults/main.yml to your own vars/main.yml:

- hosts: your_new_crm_server
  vars_files:
    - vars/main.yml
  roles:
    - stancel.git-download-suitecrm

Alternatively, you can directly pass the variables in your playbook:

- hosts: your_new_crm_server 
  vars:
    git_download_suitecrm_tagged_release_version: "v7.10.9"
    git_download_suitecrm_db_user: "suitecrmDbUser"
    git_download_suitecrm_db_password: "some-really-secure-password"
    git_download_suitecrm_mysql_root_password: "your MySQL root password"
  roles:
    - stancel.git-download-suitecrm