Local evaluation

This path creates an isolated local installation with TLS, an administrator account, an enrolled runner, and a local OCI registry. It uses published platform images; it does not compile the server or runner. For a shared installation, use server installation and runner installation.

For a guided server-and-runner setup on Linux or macOS, see the installer local profile. This guide retains the repository-based evaluation workflow, including its local registry.

Prepare your workstation

Install Git, Docker with Compose, Task, mkcert, and uv. The Task commands use the repository's Python tooling environment, requiring Python 3.12+; uv can provision it. Docker Desktop must use Linux containers. Trust mkcert's local CA once:

mkcert -install
git clone https://github.com/pyplines/pyplines.git
cd pyplines

Use the selected release's repository checkout when reproducing a historical setup. If platform images require authentication, run docker login ghcr.io with an account allowed to pull them.

Select actual published platform/tooling versions as described in requirements, then start:

task release:up PLATFORM_VERSION="$PLATFORM_VERSION" TOOLING_VERSION="$TOOLING_VERSION"

The helper provisions local certificates, pulls and checks both platform images, bootstraps the first administrator, and enrolls and approves a runner. The tooling selection records the version to install on your workstation; it does not install the released CLI for you.

Connect with the released CLI

uv venv --python 3.12 .release-test/venv
uv pip install --python .release-test/venv/bin/python "pyplines-cli==$TOOLING_VERSION"
source .release-test/venv/bin/activate
pyplines version
pyplines login https://localhost:29443 --username admin
pyplines runner list

At the password prompt, use the value in .release-test/admin-password. This file and the enrollment material are private local files; do not commit them. If you change the administrator password, update that file before using the appliance helper again.

mkcert installs the local CA in system trust. If your client does not use that trust store, configure pyplines config set tls.ca_file "$PWD/.release-test/certs/ca.crt". Do not disable TLS verification.

Run a workflow

Continue with Verify the installation. The local registry starts empty: ask an Action maintainer to publish a known Action, or follow the optional example Action publishing steps there. Platform installation does not populate an official Action catalog.

Stop and restart

task release:logs
task release:down
task release:up

Stop following logs with Ctrl-C. down preserves volumes and saved identity. A later up reuses the saved versions and credentials. The helper checks for unfinished Runs when the API is reachable; settle them before maintenance.

Use task release:reset only to erase this disposable evaluation installation. It asks for confirmation, removes its state and volumes, and cannot undo effects an Action already performed outside the installation.

This appliance is separate from task up, which builds the source-development installation on different ports. For upgrades of a shared installation, follow Upgrade the platform.