3pp-mirror/pomerium
1
0
Fork 0
mirror of https://github.com/pomerium/pomerium.git synced 2025-04-30 02:46:30 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update docs and readme

Browse source
This commit is contained in:
Bobby DeSimone 2019-01-04 18:57:45 -08:00
parent 90ab756de1
commit d4818fd5e3
No known key found for this signature in database
GPG key ID: AEE4CF12FE86D07E
5 changed files with 22 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored
View file

@ -78,3 +78,5 @@ build/
yarn.lock yarn.lock
node_modules node_modules
i18n/* i18n/*
docs/.vuepress/dist/
.firebase/

9
README.md
View file

@ -6,22 +6,20 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/pomerium/pomerium)](https://goreportcard.com/report/github.com/pomerium/pomerium) [![Go Report Card](https://goreportcard.com/badge/github.com/pomerium/pomerium)](https://goreportcard.com/report/github.com/pomerium/pomerium)
[![LICENSE](https://img.shields.io/github/license/pomerium/pomerium.svg)](https://github.com/pomerium/pomerium/blob/master/LICENSE) [![LICENSE](https://img.shields.io/github/license/pomerium/pomerium.svg)](https://github.com/pomerium/pomerium/blob/master/LICENSE)
Pomerium is a tool for managing secure access to internal applications and resources. Pomerium is a tool for managing secure access to internal applications and resources
Use Pomerium to: Use Pomerium to:
- provide a unified gateway to internal corporate applications. - provide a unified gateway to internal corporate applications.
- enforce dynamic access policies based on context, identity, and device state. - enforce dynamic access policies based on context, identity, and device state.
- deploy mutually TLS (mTLS) encryption. - deploy mutual authenticated encryption (mTLS).
- aggregate logging and telemetry data. - aggregate logging and telemetry data.
To learn more about zero-trust / BeyondCorp, check out [awesome-zero-trust]. To learn more about zero-trust / BeyondCorp, check out [awesome-zero-trust].
## Get started ## Get started
For instructions on getting started with Pomerium, see our getting started docs. For instructions on getting started using Pomerium, see our [docs].
<img src="./docs/.vuepress/public/getting-started.gif" alt="screen example" align="middle" >
## Start developing ## Start developing
@ -37,3 +35,4 @@ $ ./bin/pomerium -debug
[awesome-zero-trust]: https://github.com/pomerium/awesome-zero-trust [awesome-zero-trust]: https://github.com/pomerium/awesome-zero-trust
[go environment]: https://golang.org/doc/install [go environment]: https://golang.org/doc/install
[docs]: https://www.pomerium.io

BIN
docs/.vuepress/public/getting-started.gif
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 1.8 MiB

3
docs/guide/readme.md
View file

@ -36,6 +36,9 @@
./pomerium -debug ./pomerium -debug
``` ```
1. You should now get the following when you try to access one of your `corp` routes.
![Getting started](./get-started.gif)
[download]: https://github.com/pomerium/pomerium/releases [download]: https://github.com/pomerium/pomerium/releases
[environmental variables]: https://12factor.net/config [environmental variables]: https://12factor.net/config
[env.example]: https://github.com/pomerium/pomerium/blob/master/env.example [env.example]: https://github.com/pomerium/pomerium/blob/master/env.example

3
package.json
View file

@ -2,5 +2,8 @@
"scripts": { "scripts": {
"docs:dev": "vuepress dev docs", "docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs" "docs:build": "vuepress build docs"
},
"dependencies": {
"firebase-tools": "^6.2.2"
} }
} }