This section describes how Akeeba Release Maker will connect to Akeeba Release System on your site.
The section is a dictionary (key-value array). It has the following keys.
Required: No.
Type: String. Only joomla is supported at the moment.
Default: joomla
The type of JSON API implementation on your site.
The only valuid option is joomla which suports ARS 7.x and later using the Joomla API application available in Joomla 4.0 and later.
This key is optional and can be omitted. The default value is joomla.
Required: Yes.
Type: String.
Akeeba Release System endpoint URL. Use your site's homepage URL plus /api. For example https://www.example.com/api.
Required: No.
Type: String. One of php or curl.
The HTTP connector which will be used when communicating to Akeeba Release System. If not set the default value of php will be used.
There are two options:
curl(deprecated). Uses the PHP cURL extension. This connector does not relay the ARS error messages. We also found it to not be working reliably with some sites on Apple computers with Apple Silicon processors.php(default, recommended). Uses the native HTTP stream wrappers to access ARS. It will also relay ARS error messages where applicable.
Required: Yes.
Type: String.
The Joomla API Token for a Super User on your site. See also the Authentication section below.
Required: No.
Type: String.
Optional. Absolute path to a file containing on or more PEM-encoded TLS certificate to be considered trusted Certification Authorities (CA) when making TLS connections. This will be merged with the default cacert.pem retrieved from cURL's site.
It is typically used to make releases to servers using self-signed certificates, e.g. to your application server when it's behind CloudFlare and uses a CloudFlare issued TLS certificate, or a test or intranet site using a self-signed TLS certificate.
This will be used in all Akeeba Release Maker communications to external servers, not just when contacting your Joomla site where ARS is installed. Therefore you can use this file to provide the TLS certificate of an FTPS server if the Common Name used in the certificate does not match the domain name you are connecting to, as is very common with commercial hosting.
Example: '/home/myuser/my_certificate.pem'
When Akeeba Release Maker is creating or updating an ARS Release and its Items it's using ARS' JSON API via the Joomla API application. These requests happen outside the context of your browser and in a separate Joomla user session each. As a result, Joomla and ARS don't know who you are.
Joomla API Token. Akeeba Release Maker uses the Joomla API application (ARS 7 and later, Joomla 4 and later). You need the Joomla API token for a Super User on your site. Please note that Joomla 4.0 grants access to the API application only to Super Users. Always use HTTPS with a valid, commercially-signed TLS certificate on your site to prevent man in the middle attacks.