civicrm-dist-manager

This application defines download.civicrm.org.

Installation (Option 1, nix-shell)

System requirements:

• git
• nix

Procedure:

git clone https://github.com/civicrm/civicrm-dist-manager
cd civicrm-dist-manager
nix-shell                 ## Open subshell with key tools
composer install          ## Download PHP libraries
# Optional: If you don't want to use localhost:8000, then edit .loco/loco.yml.
loco run                  ## Start nginx and php-fpm

(You will also need app/config/gcloud.json -- described below.)

Installation (Option 2, manual)

System requirements:

• git
• php 7.4
• composer
• nginx

Procedure:

git clone https://github.com/civicrm/civicrm-dist-manager
cd civicrm-dist-manager
composer install          ## Download PHP libraries

Finally, add this new folder to your nginx configuration. See nginx/site-example.conf and nginx/common.conf for recommendations.

(You will also need app/config/gcloud.json -- described below.)

Google Cloud credentials

You need to create app/config/gcloud.json in order to read data about available builds and releases.

• If you don't have access to Google Cloud configuration UI, then you can ask someoneon civicrm-infra team for read-access key.
• If you have access to Google Cloud configuration UI, then you can create credentials:
  • Login to https://console.cloud.google.com/iam-admin/projects
  • Select "Project => CiviCRM"
  • Select "Service Accounts"
  • Click "Create a Service Account"
    • The account does not need any special permissions. It just needs read-access to public resources.
    • You'll want to create key (JSON).
  • Copy the JSON file to app/config/gcloud.json
• There is a copy of this on the production system.

Test suite

The tests are implemented with PHPUnit. Simply go to the project root and run:

phpunit8

Route: GET /civicrm-{version}-{cms}.{ext} (Redirect)

This allows you download a specific version of CiviCRM.

It works a bit different from normal Symfony routing -- the file app/LegacyRouter.php is hardwired into the AppKernel. There's probably a better way to do this.

Route: GET /latest (HTML)

Display a web page listing the (synthetic) download links.

Route: GET /latest/civicrm-{stability}-{cms}.{ext} (Redirect)

Use this end-point to download the latest stable, rc, or nightly archive.

For example:

• http://localhost/latest/civicrm-NIGHTLY-drupal6.tar.gz
• http://localhost/latest/civicrm-STABLE-drupal.tar.gz
• http://localhost/latest/civicrm-STABLE-wordpress.zip
• http://localhost/latest/civicrm-STABLE-standalone.zip
• http://localhost/latest/civicrm-RC-joomla.zip

Route: GET /latest/branch/{branch}/{ts}/civicrm-{stability}-{cms}-{ts}.{ext} (Redirect)

Use this end-point to download a particular build of a particular branch.

For example:

• http://localhost/latest/branch/master/201801140252/civicrm-4.7.31-drupal-201801140252.tar.gz
• http://localhost/latest/branch/4.6/201801140252/civicrm-4.6.35-wordpress-201801140252.zip

Route: GET /release/

Browse list of stable/public releases.

Route: GET /release/{version}

Inspect a specific release.

Route: GET /esr/(.*) (HTML or Redirect)

Browse the extended security release folder.

Directories are displayed as HTML pages; files are provided as authenticated redirects.

Route: GET /joomla.xml (XML)

Route: GET /joomla5.xml (XML)

XML feed of public/stable releases of civicrm-*-joomla.zip and civicrm-*-joomla5.zip (respectively).

See also: https://docs.joomla.org/Deploying_an_Update_Server

Route: GET /check (Web service)

Use this end-point to check for metadata about an upgrade based on a desired stability level (nightly, rc, or stable).

For example:

• http://localhost/check?stability=nightly will return a list of tarballs produced for the master branch. These are not intended for production use.
• http://localhost/check?stability=stable will return a list of tarballs for the most recent release. Thse are intended for production use.
• http://localhost/check?stability=rc will return a list of tarballs for the most recent release-candidate. (Alternatively, if the RC has been superceded by the final/stable release, then it will return that.)