Getting started
Download
Where to get the Vaultigen image, Compose files and source code, how releases are versioned, and why release dates matter.
Every Vaultigen release is public. There is no download portal behind a login. Each release is published two ways:
- as a Docker image for the Docker Compose installation (recommended), and
- as source code for the manual installation.
Both contain the same application, version and release date.
Docker image and Compose files
- Image:
vaultigen/vaultigenon Docker Hub, one tag per release (for examplevaultigen/vaultigen:1.0.0), for Linux AMD64. - Configuration:
compose.yaml,env.exampleand the optionalcompose.proxy.yamlfrom thescripts/docker/folder of the release tag in the repository:
VERSION=1.0.0 # the release you want
curl -fLO https://raw.githubusercontent.com/vaultigen/vaultigen/v$VERSION/scripts/docker/compose.yaml
curl -fL https://raw.githubusercontent.com/vaultigen/vaultigen/v$VERSION/scripts/docker/env.example -o .env
The files of every release stay available under its tag, so you can always fetch the configuration that matches an older version. The template preselects the image of the same release in VAULTIGEN_IMAGE_TAG. compose.yaml normally stays the same across releases; download a new one only when the release notes say so.
Pin exact versions. There is no latest tag in the configuration, and an update happens only when you change VAULTIGEN_IMAGE_TAG yourself. Customers who pull the image need neither PHP, Composer nor Node.js.
Source code
Releases are published on GitHub as tagged versions:
- Releases: github.com/vaultigen/vaultigen/releases
- Repository: github.com/vaultigen/vaultigen
Download the source archive of a release, or clone the repository and check out the tag:
git clone https://github.com/vaultigen/vaultigen.git
cd vaultigen
git checkout v1.0.0 # replace with the release you want
Always install a tagged release in production, never the main branch. Development builds have no release date and are not meant for real data.
Versions and release dates
Every release has a version number and a release date. The release date is built into the code and shown on the changelog.
The release date matters for licensed installations: a license covers every version released on or before the last day of its update period. Before you upgrade a licensed installation, compare the release date of the new version with the “updates until” date of your license under System → License. See Updates and renewals.
Verify what you download
- Download only from the official GitHub repository and the
vaultigen/vaultigenDocker Hub repository. - Compare the tag with the version shown in the changelog.
- The release notes on GitHub list the image digest of each release. After pulling, compare it with
docker image inspect vaultigen/vaultigen:1.0.0 --format '{{index .RepoDigests 0}}'. - The image carries its version, source revision and license as standard OCI labels:
docker image inspect vaultigen/vaultigen:1.0.0 --format '{{json .Config.Labels}}'. - The lockfiles (
composer.lock,package-lock.json) are committed and reviewed; install with them, not around them.
License of the source code
The source is available under the Elastic License 2.0. You may use it in production for free with up to 10 users, with every feature included and no time limit. This lets you evaluate Vaultigen on your own infrastructure before buying a commercial license. The license does not allow offering Vaultigen as a hosted service or bypassing its license check.
Next: Installation with Docker Compose or manual installation.
Found a mistake? Tell us at [email protected].