Skip to content

Latest commit

 

History

History
executable file
·
158 lines (118 loc) · 5.43 KB

index.md

File metadata and controls

executable file
·
158 lines (118 loc) · 5.43 KB
Raw

Conductor Core Documentation

This module offers common core functionality for Conductor.

Installation

composer require conductor/core

Basic Usage

You should create a project with this command:

composer create-project laminas/laminas-expressive-skeleton myconductortool

Run ./myconductortool/vendor/bin/conductor with no arguments to see all available commands. We recommend that you add myconductortool/vendor/bin to your path.

Below are a few of the most common Conductor modules we suggest:

  1. Application Orchestration - Application installation, configuration, backups, builds, code deployments, maintenance mode, syncing of environments.

The Conductor supports many platforms. Here are a few common platforms:

The Conductor can interact with a number of different filesystems. Here are a few common ones:

The Conductor currently only supports MySQL, but may support others in the future:

How to Encrypt Configuration Values:

The Conductor supports encryption of all configuration values.

Update your config/config.php with the following:

<?php
 
use ConductorCore\Crypt\Crypt;
use ConductorCore\YamlFileProvider;
use Laminas\ConfigAggregator\ArrayProvider;
use Laminas\ConfigAggregator\ConfigAggregator;
use Laminas\ConfigAggregator\PhpFileProvider;
 
if (file_exists(__DIR__ . '/env.php')) {
    $environmentConfig = include __DIR__ . '/env.php';
}
 
$environment = $environmentConfig['environment'] ?? 'development';
$cryptKey = $environmentConfig['crypt_key'] ?? null;
 
// To enable or disable caching, set the `ConfigAggregator::ENABLE_CACHE` boolean in
// `config/autoload/local.php`.
$cacheConfig = [
    'config_cache_path' => 'data/config-cache.php',
];
 
$aggregator = new ConfigAggregator(
    [
        \ConductorCore\ConfigProvider::class,
        \Laminas\Router\ConfigProvider::class,
        \Laminas\Validator\ConfigProvider::class,
        // Include cache configuration
        new ArrayProvider($cacheConfig),
        // Default App module config
        App\ConfigProvider::class,
        // Load application config in a pre-defined order in such a way that local settings
        // overwrite global settings. (Loaded as first to last):
        //   - `global.php`
        //   - `*.global.php`
        //   - `environments/*/*.php`
        //   - `local.php`
        //   - `*.local.php`
        // @todo Add environment config here
        new PhpFileProvider('config/autoload/{,*.}global.php'),
        Crypt::decryptExpressiveConfig(new YamlFileProvider('config/app/{,*.}yaml'), $cryptKey),
        Crypt::decryptExpressiveConfig(new YamlFileProvider('config/app/environments/' . $environment . '/{,*.}yaml'), $cryptKey),
        new PhpFileProvider('config/autoload/{,*.}local.php'),
        // Load development config if it exists
        new PhpFileProvider('config/development.config.php'),
        new ArrayProvider(['environment' => $environment, 'crypt_key' => $cryptKey]),
    ], $cacheConfig['config_cache_path']
);
 
return $aggregator->getMergedConfig();

Create a file config/env.php with the following contents:

<?php

return [
    'environment' => 'development',
    'crypt_key' => 'yourcryptkeyhere',
];

The config/env.php file should be excluded from version control. In git, you can do so by running:

echo 'config/env.php' >> .gitignore;

Generate an encryption key and save it by running:

./vendor/bin/conductor crypt:generate-key

Get the encrypted value for a string by writing it to a file, then running:

./vendor/bin/conductor crypt:encrypt --file yourplaintextfile.txt

Or, get the encrypted value for a string by running this directly:

./vendor/bin/conductor crypt:encrypt yourplaintextstring

Replace the plain text string in your configuration with the returned ciphertext including the wrapping ENC[] tag.

Known Issues

Forking SSL Issue

If you encounter this error or similar while running conductor app:deploy --snapshot mysnapshot --assets or conductor app:snapshot mysnapshot --assets, read below:

cURL error 35: A PKCS #11 module returned CKR_DEVICE_ERROR, indicating that a problem has occurred with the 
token or slot. (see http://curl.haxx.se/libcurl/c/libcurl-errors.html)

NSS has a bug in older versions which causes this issue when forking a PHP process. A patch was added to force NSS to reinitialize on PHP process fork. If you see this error, you are running an older version of NSS or curl compiled with older NSS.

You can work around this issue by adding this line to your config/config.php after the namespace definitions.

putenv("NSS_STRICT_NOFORK=DISABLED");

Alternatively, you can also run this in all environments where file syncing via Conductor is done.

export NSS_STRICT_NOFORK=DISABLED