mirror of
https://github.com/pomerium/pomerium.git
synced 2025-05-03 04:16:03 +02:00
ebbb6a7ff2
* docs: update references, remove docs dir Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com> * Update README.md Co-authored-by: Alex Fornuto <afornuto@pomerium.com> * Update Docs Paths * precommit Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com> * remove spellcheck Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com> * spell the check Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com> Co-authored-by: Alex Fornuto <afornuto@pomerium.com>
53 lines
2.7 KiB
Markdown
53 lines
2.7 KiB
Markdown
<a href="https://pomerium.com" title="Pomerium is a zero trust, context and identity aware access proxy."><img src="https://www.pomerium.com/wp-content/uploads/2021/08/Pomerium-H-white-bg.png" height="70" alt="pomerium logo"></a>
|
|
|
|
[](http://slack.pomerium.io)
|
|
[](https://github.com/pomerium/pomerium/actions?query=workflow%3ARelease)
|
|
[](https://goreportcard.com/report/github.com/pomerium/pomerium)
|
|
[][godocs]
|
|
[](https://github.com/pomerium/pomerium/blob/main/LICENSE)
|
|
|
|
|
|
Pomerium is an identity-aware proxy that enables secure access to internal applications. Pomerium provides a standardized interface to add access control to applications regardless of whether the application itself has authorization or authentication baked-in. Pomerium gateways both internal and external requests, and can be used in situations where you'd typically reach for a VPN.
|
|
|
|
Pomerium can be used to:
|
|
|
|
- provide a **single-sign-on gateway** to internal applications.
|
|
- enforce **dynamic access policy** based on **context**, **identity**, and **device identity**.
|
|
- aggregate access logs and telemetry data.
|
|
- a **VPN alternative**.
|
|
|
|
## Docs
|
|
|
|
For comprehensive docs, and tutorials see our [documentation].
|
|
|
|
[documentation]: https://pomerium.com/docs/
|
|
[go environment]: https://golang.org/doc/install
|
|
[godocs]: https://godoc.org/github.com/pomerium/pomerium
|
|
[quick start guide]: https://www.pomerium.com/docs/install/quickstart
|
|
|
|
## Integration Tests
|
|
|
|
To run the integration tests locally, first build a local development image:
|
|
|
|
```bash
|
|
./scripts/build-dev-docker.bash
|
|
```
|
|
|
|
Next go to the `integration/clusters` folder and pick a cluster, for example `google-single`, then use docker-compose to start the cluster. We use an environment variable to specify the `dev` docker image we built earlier:
|
|
|
|
```bash
|
|
cd integration/clusters/google-single
|
|
env POMERIUM_TAG=dev docker-compose up -V
|
|
```
|
|
|
|
Once that's up and running you can run the integration tests from another terminal:
|
|
|
|
```bash
|
|
go test -count=1 -v ./integration/...
|
|
```
|
|
|
|
If you need to make a change to the clusters themselves, there's a `tpl` folder that contains `jsonnet` files. Make a change and then rebuild the clusters by running:
|
|
|
|
```bash
|
|
go run ./integration/cmd/pomerium-integration-tests/ generate-configuration
|
|
```
|