Download the PHP package jwread/olivetin-bindings-php without Composer
On this page you can find all versions of the php package jwread/olivetin-bindings-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jwread/olivetin-bindings-php
More information about jwread/olivetin-bindings-php
Files in jwread/olivetin-bindings-php
Package olivetin-bindings-php
Short Description PHP client for the OliveTin Connect RPC API — start actions with bearer API-key style credentials
License Apache-2.0
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 olivetin-bindings-php
OliveTin PHP API client
Small PHP bindings for the OliveTin Connect RPC HTTP JSON API. Supported calls include Init (connection and auth check), plus starting actions (fire-and-forget and wait-for-completion).
Links
- Packagist package — Composer metadata and releases
- OliveTin (upstream) — main OliveTin server repository
Compatibility
Supported PHP versions are those where the current implementation passes the
compatibility suite with failOnDeprecation enabled (no deprecated PHP APIs).
The matrix is defined in compat/matrix.json and enforced by .github/workflows/compat.yml.
| Latest | PHP 8.1 | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 | |
|---|---|---|---|---|---|---|
| olivetin-bindings-php 1.x | 1.1.0 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
composer.json requires php: >=8.1. Extensions: json, curl.
Run the full matrix locally with make compat (requires Docker for PHP versions other than your host).
Install
From the repository root containing php/:
Or add a path repository pointing at ./php and require it locally (jwread/olivetin-bindings-php:@dev).
Authentication
This client supports one credential style: an HTTP bearer token sent as:
How OliveTin interprets that token depends on your server configuration:
- With JWT auth (
authJwtHmacSecret, JWKS, or a public key), pass a valid JWT string as the token (still sent asBearer). - With trusted reverse proxies, validate your own API key at the proxy and translate successful requests into headers OliveTin trusts (
authHttpHeaderUsername, etc.). In that setup your PHP code might still sendBearer <api-key>to the proxy only—never expose OliveTin directly without TLS and proper validation.
OAuth flows, cookies, and local username/password login are intentionally not implemented here.
Usage
Base URL should be the OliveTin web root (same host/port as the UI), without the /api suffix—the client adds /api by default.
Custom API prefix
If OliveTin is mounted elsewhere than /api:
RPC coverage
| Method | Purpose |
|---|---|
init |
Bootstrap / session metadata; use to verify the server and bearer token |
startAction |
Start using binding id + optional arguments |
startActionAndWait |
Start using action id, block until finished |
Protobuf JSON uses camelCase field names (for example executionTrackingId, bindingId).
CI, docs, and releases
CI and publishing follow the same shape as jamesread/libAllure, with a few adjustments for safer defaults:
.github/workflows/compat.yml— PHP compatibility matrix fromcompat/matrix.json(1.x × PHP 8.1–8.5); runs the deprecation-strict PHPUnit suite on every push and pull request..github/workflows/release.yml— PHP matrix (composer updatewithprefer-lowest/prefer-stableon PHP 8.1–8.5), thenmake phpstan,make lint, andmake tests, pluscomposer auditon one representative cell (PHP 8.5 +prefer-stable). Thereleasejob runs only onpushtomain, checks out full history (fetch-depth: 0), and runs semantic-release from.releaserc.yaml(GitHub releases from Conventional Commits).GITHUB_TOKENvs PAT — the release step uses the workflowGITHUB_TOKENwith explicit job permissions (contents,issues,pull-requests: write), matching upstream semantic-release guidance. That is enough for releases in this repository. Use a PAT (for example libAllure’sCONTAINER_TOKEN) only if you need behaviourGITHUB_TOKENcannot provide (examples: releasing from another repo, bypassing branch protection without “GitHub Actions” bypass rules, or triggering downstream workflows that ignoreGITHUB_TOKENevents)..github/workflows/doxygen.yml— builds HTML API docs with Doxygen (Doxyfile, output underapi-docs/) and deploys them to GitHub Pages whenmainis pushed (enable Pages with the GitHub Actions source in the repo settings). Thegithub-pagesenvironment must exist (GitHub creates it on first Pages deploy); restricted deployment protections may require approval on the first run.
Local equivalents:
License
Apache-2.0 (same family as OliveTin).
All versions of olivetin-bindings-php with dependencies
ext-json Version *
ext-curl Version *