sandwave-io/freenas

A PHP SDK for the FreeNAS RESTful API (v2)

1.0.0 2020-07-21 08:58 UTC

Requires

• php: ^7.1
• ext-json: *
• guzzlehttp/guzzle: ^6.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16
• phpstan/phpstan: ^0.12.25
• phpunit/phpunit: ^7.5
• uptimeproject/php-cs-fixer-config: ^1.1

MIT

• Jesse Kramer

README

FreeNAS RESTful API (v2) - PHP SDK

This package is built upon the v2.0 of the FreeNAS API.

• FreeNAS API v2.0 REST documentation

How to use

composer require sandwave-io/freenas-php

$freenas = new \SandwaveIo\FreeNAS\RestClient(
    'https://my-freenas-install.io/api/v2.0/', // base url
    'root',                  // user
    'SuperSecretPassword123' // password
);

// This example shows how to create a dataset, and a user that has access rights to that dataset.

$dataset = $freenas->createDataset(
    'store01',    // pool
    'my-dataset', // dataset
    20 * 1024**3  // size in bytes
);

$user = $freenas->createUser(
    1001,                        // uid
    'my-user',                   // username
    $dataset->getMountPoint(),   // homedir
    'SuperSecretUserPassword123' // password
);

How to contribute

Feel free to create a PR if you have any ideas for improvements. Or create an issue.

• When adding code, make sure to add tests for it (phpunit).
• Make sure the code adheres to our coding standards (use php-cs-fixer to check/fix).
• Also make sure PHPStan does not find any bugs.

vendor/bin/php-cs-fixer fix

vendor/bin/phpstan analyze

vendor/bin/phpunit --coverage-text

These tools will also run in GitHub actions on PR's and pushes on master.