mirror of
https://github.com/pomerium/pomerium.git
synced 2025-06-08 22:03:29 +02:00
65 lines
2.8 KiB
Markdown
65 lines
2.8 KiB
Markdown
# Releases
|
|
|
|
## Binaries
|
|
|
|
Official binaries for OSX, Windows, and Linux can be found on our [Github Releases](https://github.com/pomerium/pomerium/releases) page.
|
|
|
|
## Docker
|
|
|
|
Pomerium is also distributed as a [minimal](https://github.com/GoogleContainerTools/distroless) [docker container](https://www.docker.com/resources/what-container). You can find Pomerium's images on [dockerhub](https://hub.docker.com/r/pomerium/pomerium). Pomerium can be pulled in several flavors and architectures.
|
|
|
|
- `:vX.Y.Z`: which will pull the a [specific tagged release](https://github.com/pomerium/pomerium/tags).
|
|
```bash
|
|
$ docker run pomerium/pomerium:v0.1.0 --version
|
|
v0.1.0+53bfa4e
|
|
```
|
|
|
|
* `:latest`: which will pull the [most recent tagged release](https://github.com/pomerium/pomerium/releases).
|
|
|
|
```bash
|
|
$ docker pull pomerium/pomerium:latest && docker run pomerium/pomerium:latest --version
|
|
v0.2.0+87e214b
|
|
```
|
|
|
|
- `:master` : which will pull an image in sync with git's [master](https://github.com/pomerium/pomerium/tree/master) branch.
|
|
|
|
## Source
|
|
|
|
If you'd like to run Pomerium on an [operating system or architecture](https://gist.github.com/asukakenji/f15ba7e588ac42795f421b48b8aede63) not officially released by Pomerium, or simply prefer to compile from source, you can do so by checking out the latest code and compiling as follows.
|
|
|
|
```bash
|
|
git clone git@github.com:pomerium/pomerium.git
|
|
cd pomerium
|
|
make
|
|
./bin/pomerium --version
|
|
```
|
|
|
|
## Release Cycle
|
|
|
|
The current release cycle is aligned on a monthly basis. Pre-`1.0.0` we target a `MINOR` release on or around the **first day of each month**. We try to hit the targets as closely as possible, while still delivering a quality release.
|
|
|
|
## Versioning
|
|
|
|
Pomerium uses [Semantic Versioning](https://semver.org/). In practice this means for a given version number **vMAJOR**.**MINOR**.**PATCH** (e.g. `v0.1.0`):
|
|
|
|
- **MAJOR** indicates a incompatible API changes,
|
|
- **MINOR** indicates a new functionality in a backwards-compatible manner, and
|
|
- **PATCH** indicates a backwards-compatible bug fixe.
|
|
|
|
As Pomerium is still pre-`v1.0.0`, breaking changes between releases should be expected.
|
|
|
|
To see difference between releases, please refer to the changelog and upgrading documents.
|
|
|
|
## Versioned Docs
|
|
|
|
For convenience, we maintain hosted documentation for each tagged release. The format for which is `https://{MAJOR}-{MINOR}-{PATCH}.docs.pomerium.io`. For example:
|
|
|
|
- [github@master](https://master.docs.pomerium.io/)
|
|
- [v0.6.0](https://0-6-0.docs.pomerium.io/)
|
|
- [v0.5.0](https://0-5-0.docs.pomerium.io/)
|
|
- [v0.4.0](https://0-4-0.docs.pomerium.io/)
|
|
- [v0.3.0](https://0-3-0.docs.pomerium.io/)
|
|
- [v0.2.0](https://0-2-0.docs.pomerium.io/)
|
|
- [v0.1.0](https://0-1-0.docs.pomerium.io/)
|
|
- [v0.0.5](https://0-0-5.docs.pomerium.io/)
|
|
- [v0.0.4](https://0-0-4.docs.pomerium.io/)
|