Set up Currents in self-hosted environments using Docker Compose.

• Docker Compose Setup
• Docker Compose Configuration Reference
• AWS IAM User Setup
• Support Policy

⚠️ Important! You must be authenticated as an AWS IAM user to pull images from Current’s Private AWS ECR repositories. Contact Currents team with your AWS IAM user details to request access.

Looking for Kubernetes deployment? See Currents K8S Setup.

cd on-prem
./scripts/setup.sh
docker compose up -d

See Docker Compose Development Guide — architecture, scripts, and contribution guidelines.

Releases are tied to Currents container image tags, which use date-based versioning: YYYY-MM-DD-NNN.

Note: 2026-01-14-001 is used as an example version throughout these steps. Replace it with the actual version you're releasing (format: YYYY-MM-DD-NNN).

git checkout -b release-on-prem/2026-01-14-001

Edit on-prem/VERSION and on-prem/.env.example with the image tag.

• Move items from "Unreleased" to a new version section
• Add release date and summary of changes

git add on-prem/VERSION on-prem/.env.example on-prem/CHANGELOG.md
git commit -m "release: on-prem 2026-01-14-001"
git push -u origin HEAD

gh pr create --title "release: on-prem 2026-01-14-001" --body "Release on-prem 2026-01-14-001"

CI will run validation and smoke tests. Wait for checks to pass, then get the PR reviewed and merged.

Important: Always tag from main after the PR is merged to ensure the tag points to the merged commit.

git checkout main && git pull
git tag on-prem/2026-01-14-001
git push origin on-prem/2026-01-14-001

Create a release on GitHub for the tag:

1. Go to Releases
2. Select the tag on-prem/2026-01-14-001
3. Set the title to on-prem/2026-01-14-001
4. Add release notes linking to the CHANGELOG

Tags are namespaced by tool to allow for future additions:

List all on-prem releases:

git tag -l 'on-prem/*'