mirror of
https://github.com/pomerium/pomerium.git
synced 2025-04-29 10:26:29 +02:00
Update docs and readme
This commit is contained in:
parent
90ab756de1
commit
d4818fd5e3
5 changed files with 22 additions and 15 deletions
4
.gitignore
vendored
4
.gitignore
vendored
|
@ -77,4 +77,6 @@ translated_docs
|
|||
build/
|
||||
yarn.lock
|
||||
node_modules
|
||||
i18n/*
|
||||
i18n/*
|
||||
docs/.vuepress/dist/
|
||||
.firebase/
|
|
@ -6,22 +6,20 @@
|
|||
[](https://goreportcard.com/report/github.com/pomerium/pomerium)
|
||||
[](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:
|
||||
|
||||
- provide a unified gateway to internal corporate applications.
|
||||
- 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.
|
||||
|
||||
To learn more about zero-trust / BeyondCorp, check out [awesome-zero-trust].
|
||||
|
||||
## Get started
|
||||
|
||||
For instructions on getting started with Pomerium, see our getting started docs.
|
||||
|
||||
<img src="./docs/.vuepress/public/getting-started.gif" alt="screen example" align="middle" >
|
||||
For instructions on getting started using Pomerium, see our [docs].
|
||||
|
||||
## Start developing
|
||||
|
||||
|
@ -37,3 +35,4 @@ $ ./bin/pomerium -debug
|
|||
|
||||
[awesome-zero-trust]: https://github.com/pomerium/awesome-zero-trust
|
||||
[go environment]: https://golang.org/doc/install
|
||||
[docs]: https://www.pomerium.io
|
||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 1.8 MiB |
|
@ -31,10 +31,13 @@
|
|||
|
||||
1. For a first run, I suggest setting the debug flag which provides user friendly logging.
|
||||
|
||||
```bash
|
||||
source ./env
|
||||
./pomerium -debug
|
||||
```
|
||||
```bash
|
||||
source ./env
|
||||
./pomerium -debug
|
||||
```
|
||||
|
||||
1. You should now get the following when you try to access one of your `corp` routes.
|
||||

|
||||
|
||||
[download]: https://github.com/pomerium/pomerium/releases
|
||||
[environmental variables]: https://12factor.net/config
|
||||
|
|
13
package.json
13
package.json
|
@ -1,6 +1,9 @@
|
|||
{
|
||||
"scripts": {
|
||||
"docs:dev": "vuepress dev docs",
|
||||
"docs:build": "vuepress build docs"
|
||||
}
|
||||
}
|
||||
"scripts": {
|
||||
"docs:dev": "vuepress dev docs",
|
||||
"docs:build": "vuepress build docs"
|
||||
},
|
||||
"dependencies": {
|
||||
"firebase-tools": "^6.2.2"
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Add table
Reference in a new issue