Download the PHP package plinker/lxd without Composer
On this page you can find all versions of the php package plinker/lxd. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package lxd
Short Description Control LXD through RPC
License MIT
Homepage http://github.com/plinker-rpc/lxd
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package lxd
PlinkerRPC - LXD
Control LXD through RPC which uses the local instance of LXD and lxc query to manage local or remote LXD servers.
Install
Require this package with composer using the following command:
Setup
The webserver user must be able to execute lxc commands, so add the user to sudoers file under User privilege specification:
Also add www-data to lxd group:#
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'
]
);
// or using global function
$client = plinker_client('http://example.com/server.php', 'a secret password');Basic Usage
Essentially you can do any LXD operation with the single $client->lxd->query() method, or you can use the helper methods which cover all the LXD endpoints.
Parameters & Call
| Parameter | Type | Description | Default |
|---|---|---|---|
| remote | string | LXD remote and endpoint | local |
| rest method | string | e.g GET, POST, DELETE, PUT, PATCH | GET |
| payload | object | json string | Rest json payload | |
| mutator | function | Pre-resolve mutation function |
Full Documentation
To view the complete docs for this component including all methods see: https://plinker-rpc.github.io/lxd/
Methods
Once setup, you call the class though its namespace to its method, see docs for further details.
List Containers
List containers on remote.
Parameters & Call
| Parameter | Type | Description | Default |
|---|---|---|---|
| remote | string | LXD remote | local |
| mutator | function | Mutation function |
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
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.
