Download the PHP package plinker/nginx without Composer

PlinkerRPC - Nginx

The aim of this component is to build web forwards/reverse proxy to LXD/LXC containers on the host (or external upstreams), not as a server{} block configurator.

The component uses nginx as a reverse proxy, it relies on php7-fpm being installed and will overwrite /etc/nginx/nginx.conf! So if you already have nginx installed then dont use this component as it will most likely break your stuff.

Install

Require this package with composer using the following command:

Then navigate to ./vendor/plinker/nginx/scripts and run bash install.sh.

Client

Creating a client instance is done as follows:

<?php
require 'vendor/autoload.php';

/**
 * Initialize plinker client.
 *
 * @param string $server - URL to server listener.
 * @param string $config - server secret, and/or a additional component data
 */
$client = new \Plinker\Core\Client(
    'http://example.com/server.php',
    [
        'secret' => 'a secret password',
        // database connection
        'database' => [
            'dsn'      => 'sqlite:./.plinker/database.db',
            'host'     => '',
            'name'     => '',
            'username' => '',
            'password' => '',
            'freeze'   => false,
            'debug'    => false,
        ]
    ]
);

// or using global function
$client = plinker_client('http://example.com/server.php', 'a secret password', [
    // database connection
    'database' => [
        'dsn'      => 'sqlite:./.plinker/database.db',
        'host'     => '',
        'name'     => '',
        'username' => '',
        'password' => '',
        'freeze'   => false,
        'debug'    => false,
    ]
]);

Methods

Once setup, you call the class though its namespace to its method.

Setup

Applies build tasks to plinker/tasks queue.

Call

$client->nginx->setup([
    'build_sleep' => 5,
    'reconcile_sleep' => 5,
]);

Response

Update Package

Runs composer update to update package.

Call

$client->nginx->update_package();

Response

Add

Add a web proxy rule.

Call

$client->nginx->addBlock([
    'label' => 'My website nginx route',
    'ownDomain' => [
        'example.com',
        'www.example.com'
    ],
    'ownUpstream' => [
        ['ip' => '10.158.250.5', 'port' => '80']
    ],
    'letsencrypt' => 1,
    'enabled' => 1
]);

Response

Update Block

Update a web proxy rule.

Call

client->nginx->update('name = ?', ['b2f78de7-5994-4c21-9c55-76cefe327a67'], [
    'label' => $test_route_label,
    'ownDomain' => [
        'updated-example.com',
        'www.updated-example.com'
    ],
    'ownUpstream' => [
        ['ip' => '10.158.250.5', 'port' => '80']
    ],
    'letsencrypt' => 0,
    'enabled' => 1
]);

Response

Remove

Remove web proxy rule.

Call

ruleById(1)   - $client->nginx->remove('id = ?', [1]);
ruleByName(1) - $client->nginx->remove('name = ?', ['guidV4-value'])

Response

Reset

Remove all web proxy rules.

Call

$client->nginx->reset();     // remove just rules
$client->nginx->reset(true); // remove rules and tasks (purge)

Response

Fetch

Fetch currently configured web proxy rules from database.

Call

all           - $client->nginx->fetch();
ruleById(1)   - $client->nginx->fetch('id = ?', [1]);
ruleByName(1) - $client->nginx->fetch('name = ?', ['guidV4-value'])

Response

Count

Fetch count of currently configured web proxy rules from database.

Call

all           - $client->nginx->count();
ruleById(1)   - $client->nginx->count('id = ?', [1]);
ruleByName(1) - $client->nginx->count('name = ?', ['guidV4-value'])

Response

Rebuild

Rebuild web proxy rule.

Call

ruleById(1)   - $client->nginx->rebuild('id = ?', [1]);
ruleByName(1) - $client->nginx->rebuild('name = ?', ['guidV4-value'])

Response

Status

Enumarate and return status of nginx connections.

Call

$client->nginx->status();

Response

Testing

There are no tests setup for this component.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please contact me via https://cherone.co.uk instead of using the issue tracker.

Credits

• Lawrence Cherone
• All Contributors

Development Encouragement

If you use this project and make money from it or want to show your appreciation, please feel free to make a donation https://www.paypal.me/lcherone, thanks.

Sponsors

Get your company or name listed throughout the documentation and on each github repository, contact me at https://cherone.co.uk for further details.

License

The MIT License (MIT). Please see License File for more information.

See the organisations page for additional components.