ohseesoftware/caddy-config-php

Caddy v2 API helper library.

v2.2.1 2022-01-30 17:37 UTC

Requires

• guzzlehttp/guzzle: ^6.4

Requires (Dev)

• php-coveralls/php-coveralls: ^2.2
• phpunit/phpunit: ^8.4
• squizlabs/php_codesniffer: *

MIT

• Owen Conti

README

Caddy v2 API helper for PHP.

Caddy v2 allows you to update your Caddy configuration via a JSON API. This package is a simple helper library to update parts of your configuration.

Functionality for updating all aspects of the configuration will be added over time.

Usage

To get started, create an instance of OhSeeSoftware\CaddyConfig\Client, ensuring to pass your Caddy network address as the first argument:

$client = new OhSeeSoftware\CaddyConfig\Client('localhost:2019');

From there, you can use the $client instance to make API requests to your Caddy instance.

The idea behind the wrapper is that you can have a Client singleton class, and then use the $client->request() method to create new Request instances. You should create a new Request instance per HTTP request you send to your Caddy server.

API Methods

Client

__constructor()

Creates a new instance of the Client class.

Arguments:

• $caddyHost - string: The address where the Caddy config endpoint is listening.

setCaddyHost()

Allows you to change the Caddy host after creating the Client instance.

Arguments:

• $caddyHost - string: The address where the Caddy config endpoint is listening.

request()

Returns a new Request instance which you use to make configuration requests.

No arguments.

Request

Use the Request class to compose your request to send to Caddy. Here's an example of how you can add a new host to a server:

$client = new OhSeeSoftware\CaddyConfig\Client('localhost:2019');
$client->request()
  ->http()
  ->server('srv0')
  ->route(0)
  ->match(0)
  ->addHost('example.com');

__constructor()

Creates a new instance of the Request class.

Arguments:

• $caddyHost - string: The address where the Caddy config endpoint is listening.

addHost()

Sends a request to Caddy to add the given host.

Arguments:

• $host - string: The host to add.

Returns:

• Response - The response from Caddy wrapped in a Response instance.

http()

Adds the http path, "/apps/http", to the request URI.

No arguments.

Returns:

• Request - The request instance (allows chaining).

server()

Adds the server path, "/servers/{server}", to the request URI.

Arguments:

• $server - string: The name of the server to target.

Returns:

• Request - The request instance (allows chaining).

route()

Adds the route path, "/routes/{routeIndex}", to the request URI.

Arguments:

• $routeIndex - int: The route to target.

Returns:

• Request - The request instance (allows chaining).

match()

Adds the match path, "/match/{matchIndex}", to the request URI.

Arguments:

• $matchIndex - int: The match to target.

Returns:

• Request - The request instance (allows chaining).

sendRequest()

Sends the built request to the Caddy server.

Arguments:

• $method - string: The method for the request.
• $body - array|nuullable: The request body to send to Caddy.

Returns:

• Response - A new instance of a Response instance.

Response

__constructor()

Creates a new instance of the Response class.

Arguments:

• $response - ResponseInterface: Instance of a ResponseInterface (created by Guzzle).

getBody()

Returns the response body as a string.

No arguments.

isSuccessful()

Returns a boolean indicating if the request was successful. Status codes of 200 or 201 are considered successful, everything else is not.

No arguments.

License

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