Download the PHP package pdir/contao-workmate-agent-bundle without Composer

On this page you can find all versions of the php package pdir/contao-workmate-agent-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package contao-workmate-agent-bundle

Contao Workmate agent bundle

Agent of Workmate (the maintenance tool of pdir) for Contao projects (Contao 4.13 and 5.x, PHP 7.4+).

Before and after a Contao update Workmate calls the agent, which

  1. creates a database backup with the Contao backup manager (like contao:backup:create, uncompressed),
  2. writes it to _db/latest.sql,
  3. commits _db/latest.sql, composer.json and composer.lock (only these files, other changes are not committed)
  4. and pushes the commit (git push origin HEAD).

Installation

Workmate installs the agent per click over the Contao Manager API (project → "Agent installieren"):

Manual installation:

Requirements on the server

Env variables (.env.local):

Variable
WORKMATE_AGENT_AUTHOR_NAME required, author name of the commits, e.g. Agentur Beispiel
WORKMATE_AGENT_AUTHOR_EMAIL required, author email of the commits, e.g. [email protected]
WORKMATE_AGENT_TOKEN_HASH optional, hash of the token, takes precedence over composer.json
WORKMATE_AGENT_GIT optional, git binary, e.g. /usr/bin/git
WORKMATE_AGENT_SSH_KEY optional, SSH key for the push, e.g. /home/user/.ssh/id_rsa_gitlab

Check

Checks the project, PHP, Git and GitLab, nothing is changed (only git push --dry-run) unless --fix is passed. Run it as the PHP user in the project directory:

Exit code 0 = ready, 1 = errors.

API

POST /_workmate/agent, header X-Workmate-Token: <token>, JSON response {"ok": true, …} or {"ok": false, "error": "…"}.

action
check agent version, branch, remote, whether the working tree is clean and _db/latest.sql is ignored, commit author (null if not set)
commit backup, _db/latest.sql, commit with message, push

Tests

License

LGPL-3.0-or-later, see LICENSE.


All versions of contao-workmate-agent-bundle with dependencies

PHP Build Version
Package Version
No informations.
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package pdir/contao-workmate-agent-bundle contains the following files

Loading the files please wait ...