innmind/server-control

Allows to control the server from php

5.2.3 2024-09-18 10:12 UTC

Requires

• php: ~8.2
• innmind/filesystem: ~7.0
• innmind/immutable: ~4.15|~5.0
• innmind/stream: ~4.0
• innmind/time-continuum: ^3.1,<3.3|^3.4.1
• innmind/time-warp: ^3.0
• innmind/url: ~4.0
• psr/log: ~3.0

Requires (Dev)

• innmind/black-box: ~5.5
• innmind/coding-standard: ~2.0
• phpunit/phpunit: ~10.2
• vimeo/psalm: ~5.12

MIT

• Baptiste Langlade

README

Give access to giving instructions to the server.

Important: to correctly use this library you must validate your code with vimeo/psalm

Installation

composer require innmind/server-control

Usage

use Innmind\Server\Control\{
    ServerFactory,
    Server\Command,
    Server\Process\Output\Type,
    Server\Process\Pid,
    Server\Signal,
    Server\Volumes\Name,
};
use Innmind\TimeContinuum\Earth\Clock;
use Innmind\TimeWarp\Halt\Usleep;
use Innmind\Stream\Streams;
use Innmind\Url\Path;
use Innmind\Immutable\Str;

$server = ServerFactory::build(
    new Clock,
    Streams::fromAmbientAuthority(),
    new Usleep,
);
$server
    ->processes()
    ->execute(
        Command::foreground('bin/console')
            ->withArgument('debug:router')
    )
    ->output()
    ->foreach(static function(Str $data, Type $type): void {
        $type = match ($type) {
            Type::error => 'ERR : ',
            Type::output => 'OUT : ',
        };

        echo $type.$data->toString();
    });
$server
    ->processes()
    ->kill(
        new Pid(42),
        Signal::kill,
    );
$server->volumes()->mount(new Name('/dev/disk2s1'), Path::of('/somewhere')); // the path is only interpreted for linux
$server->volumes()->unmount(new Name('/dev/disk2s1'));
$server->reboot();
$server->shutdown();

Scripts

Sometimes you may want to run a set of commands on your server. You can easily do so like this:

use Innmind\Server\Control\Server\Script;

$script = Script::of(
    'apt-get install php-fpm -y',
    'service nginx start',
);
$script($server);

If any command fails, it will stop the script and raise an exception.

Remote server control

use Innmind\Server\Control\Servers\Remote;
use Innmind\Url\Authority\{
    Host,
    Port,
    UserInformation\User,
};

$server = new Remote(
    $server,
    User::of('john'),
    Host::of('example.com'),
    Port::of(42),
);
$server->processes()->execute(Command::foreground('ls'));

This will run ssh -p 42 [e-mail] ls.

Important: specifying environment variables or an input stream will not be taken into account on the remote server.

Logging

use Innmind\Server\Control\Servers\Logger;
use Psr\Log\LoggerInterface;

$server = Logger::psr($server, /** an instance of LoggerInterface */);