Set up Currents in self-hosted environments using Docker Compose.
Looking for Kubernetes deployment? See Currents K8S Setup.
Install from the latest release tag. main can hold compose file changes for images that are not released yet.
git clone https://github.com/currents-dev/docker.git currents-docker
cd currents-docker
git checkout "$(git tag -l 'on-prem/*' --sort=-v:refname | head -1)"
cd on-prem
./scripts/setup.sh
docker compose up -dSee 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-001is 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-001Edit 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 HEADgh 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
mainafter 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-001Pushing the tag runs the Publish Docs workflow, which publishes docs/ from the tag to https://currents-dev.github.io/docker. Merging to main does not publish the docs.
Create a release on GitHub for the tag:
- Go to Releases
- Select the tag
on-prem/2026-01-14-001 - Set the title to
on-prem/2026-01-14-001 - Add release notes linking to the CHANGELOG
Tags are namespaced by tool to allow for future additions:
| Tool | Tag Format | Example |
|---|---|---|
| On-Prem | on-prem/YYYY-MM-DD-NNN |
on-prem/2026-01-14-001 |
List all on-prem releases:
git tag -l 'on-prem/*'Docs for unreleased changes merge to main with those changes and go live with the next release tag. To publish a fix to the released docs sooner:
git checkout -b docs-fix/2026-01-14-001 on-prem/2026-01-14-001
git cherry-pick <commit of the fix on main>
git push -u origin HEADThen run the Publish Docs workflow on that branch from the Actions tab. If the tag predates the workflow, cherry-pick the commit that added it too. The workflow refuses main, branches not based on the latest release, and branches that change files outside docs/, .github/ and README.md.