diff --git a/.gitignore b/.gitignore index 9d185ed9f..48d341fc0 100644 --- a/.gitignore +++ b/.gitignore @@ -77,4 +77,6 @@ translated_docs build/ yarn.lock node_modules -i18n/* \ No newline at end of file +i18n/* +docs/.vuepress/dist/ +.firebase/ \ No newline at end of file diff --git a/README.md b/README.md index cf046b195..9d67b4d08 100644 --- a/README.md +++ b/README.md @@ -6,22 +6,20 @@ [![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) -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. - -screen example +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 diff --git a/docs/.vuepress/public/getting-started.gif b/docs/.vuepress/public/getting-started.gif deleted file mode 100644 index 9d390cf24..000000000 Binary files a/docs/.vuepress/public/getting-started.gif and /dev/null differ diff --git a/docs/guide/readme.md b/docs/guide/readme.md index 2bddff667..9c0cb9a7b 100644 --- a/docs/guide/readme.md +++ b/docs/guide/readme.md @@ -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. + ![Getting started](./get-started.gif) [download]: https://github.com/pomerium/pomerium/releases [environmental variables]: https://12factor.net/config diff --git a/package.json b/package.json index 2fc485bc0..dadfcfb9b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,9 @@ { - "scripts": { - "docs:dev": "vuepress dev docs", - "docs:build": "vuepress build docs" - } -} \ No newline at end of file + "scripts": { + "docs:dev": "vuepress dev docs", + "docs:build": "vuepress build docs" + }, + "dependencies": { + "firebase-tools": "^6.2.2" + } +}