v0.11.0

Getting Started

Last updated


This page walks through building, configuring, and running your first podrun up to deploy a compose project to remote Podman.

Prerequisites


RequirementWhereNotes
Go 1.25.1+Build hostTaken from go.mod
C compiler (CGO_ENABLED=1)Build host (API server)github.com/mattn/go-sqlite3 requires cgo
sshpass, rsync, ssh, curl, unzipLocal (CLI)CheckRelyPackages() installs them when missing
macOS or LinuxLocal (CLI)Other operating systems abort when packages are missing
SSH password loginRemote hostThe CLI connects through sshpass
Podman + podman composeRemote hostContainer runtime
rsyncRemote hostrsync over SSH runs on both ends
Write access to /home/podrunRemote hostRemote project folders are always created here

Installation


  1. git clone https://github.com/pardnchiu/PodRun.git
  2. cd PodRun
  3. go build -o podrun ./cmd/cli
  4. CGO_ENABLED=1 go build -o podrun-api ./cmd/api

For the CLI alone, use go install; the resulting binary is named cli after the package directory:
  1. go install github.com/pardnchiu/PodRun/cmd/cli@latest

Configure the Remote Connection


On startup the CLI reads three required variables from .env in the current working directory and aborts if any is missing:
  1. PODRUN_SERVER=192.168.1.100
  2. PODRUN_USERNAME=podrun
  3. PODRUN_PASSWORD=yourpassword

See Configuration for every variable.

Start the API Server


The API server reads sql/create.sql through a relative path, so run it from the repo root. The CLI always targets localhost:8080, so both must run on the same machine.
  1. cd PodRun
  2. ./podrun-api

First Deployment


Run inside a project folder that contains docker-compose.yml or docker-compose.yaml:
  1. cd ~/projects/my-app
  2. podrun up -d

In -d mode the command prints container port mappings, the Pod ID and name, and the local hostname and IP. Day-to-day commands:
  1. podrun ps
  2. podrun logs -f
  3. podrun down
  4. podrun clear

Next Steps


中文