Skip to content

Commit

Permalink
Readme Update (#4967)
Browse files Browse the repository at this point in the history 
* Readme Update
  • Loading branch information
@benarent
benarent authored Nov 25, 2020
1 parent e75d158 commit 0f38826
Showing 1 changed file with 33 additions and 30 deletions.
63 changes: 33 additions & 30 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# Gravitational Teleport
# Teleport

Gravitational Teleport is a modern security gateway for remotely accessing:
* Clusters of Linux servers via SSH or SSH-over-HTTPS in a browser.
* Kubernetes clusters.
Teleport is a unified access plane for infrastructure:

* [Clusters of Linux servers](https://goteleport.com/teleport/docs/quickstart/) via SSH or SSH-over-HTTPS in a browser
* [Kubernetes clusters](https://goteleport.com/teleport/docs/kubernetes-ssh/)
* [Web Applications](https://goteleport.com/teleport/docs/application-access/)
* [Databases - (Postgres Preview)](https://goteleport.com/teleport/docs/preview/teleport-database-access/)

It is intended to be used instead or together with `sshd` for organizations who
need:

* SSH audit with session recording/replay.
* Kubernetes API Access with audit and `kubectl exec` recording/replay.
* Easily manage trust between teams, organizations and data centers.
* Have SSH or Kubernetes access to behind-firewall clusters without any open ports.
* Application, SSH or Kubernetes access to behind-firewall clusters without any open ports.
* Role-based access control (RBAC) for SSH protocol.
* Unified RBAC for SSH and Kubernetes.

Expand All @@ -19,9 +22,9 @@ because it facilitates easy adoption of the best infrastructure security
practices like:

- No need to distribute keys: Teleport uses certificate-based access with automatic certificate expiration time.
- 2nd factor authentication (2FA) for SSH and Kubernetes.
- 2nd factor authentication (2FA) for Apps, SSH and Kubernetes.
- Collaboratively troubleshoot issues through session sharing.
- Single sign-on (SSO) for SSH/Kubernetes and your organization identities via
- Single sign-on (SSO) for Applications, SSH/Kubernetes and your organization identities via
Github Auth, OpenID Connect or SAML with endpoints like Okta or Active Directory.
- Cluster introspection: every SSH node and its status can be queried via CLI and Web UI.

Expand All @@ -31,8 +34,8 @@ implementation and it is _fully compatible with OpenSSH_ and can be used with

|Project Links| Description
|---|----
| [Teleport Website](https://gravitational.com/teleport) | The official website of the project |
| [Documentation](https://gravitational.com/teleport/docs/quickstart/) | Admin guide, user manual and more |
| [Teleport Website](https://goteleport.com/teleport) | The official website of the project |
| [Documentation](https://goteleport.com/teleport/docs/quickstart/) | Admin guide, user manual and more |
| [Demo Video](https://www.youtube.com/watch?v=DUlTAlEJr5w) | 5-minute video overview of the UI. |
| [Teleconsole](https://www.teleconsole.com) | The free service to "invite" SSH clients behind NAT, built on top of Teleport |
| [Blog](https://gravitational.com/blog/) | Our blog where we publish Teleport news |
Expand Down Expand Up @@ -60,9 +63,9 @@ and run it under `$USER`, in this case you will not be able to login as someone
### Deploy Teleport
If you wish to deploy Teleport inside a Docker container:
```
# This command will pull the Teleport container image for version 4.3
# Replace 4.3 with the version you need:
$ docker pull quay.io/gravitational/teleport:4.3
# This command will pull the Teleport container image for version 5.0
# Replace 5.0 with the version you need:
$ docker pull quay.io/gravitational/teleport:5.0
```
View latest tags on [Quay.io | gravitational/teleport](https://quay.io/repository/gravitational/teleport?tab=tags)

Expand Down Expand Up @@ -94,7 +97,7 @@ NOTE: The Go compiler is somewhat sensitive to amount of memory: you will need
at least 1GB of virtual memory to compile Teleport. 512MB instance without swap
will not work.

NOTE: This will build the latest version of Teleport, regardless of whether it is stable. If you want to build the latest stable release, `git checkout` to that tag (e.g. `git checkout v4.3.0`) before running `make full`.
NOTE: This will build the latest version of Teleport, regardless of whether it is stable. If you want to build the latest stable release, `git checkout` to that tag (e.g. `git checkout v5.0.0`) before running `make full`.

### Rebuilding Web UI

Expand Down Expand Up @@ -127,7 +130,7 @@ Refer to [the webapps README](https://github.com/gravitational/webapps/blob/mast

TL;DR version:

```
```bash
make docs
make run-docs
```
Expand All @@ -144,37 +147,37 @@ some common tasks:

Latest version:

```
```bash
go get github.com/new/dependency
# Update the source to actually use this dependency, then run:
make update-vendor
```

Specific version:

```
```bash
go get github.com/new/dependency@version
# Update the source to actually use this dependency, then run:
make update-vendor
```

#### Set dependency to a specific version

```
```bash
go get github.com/new/dependency@version
make update-vendor
```

#### Update dependency to the latest version

```
```bash
go get -u github.com/new/dependency
make update-vendor
```

#### Update all dependencies

```
```bash
go get -u all
make update-vendor
```
Expand Down Expand Up @@ -205,42 +208,42 @@ magically _teleported_. And Teleport was born!

## More Information

* [Quick Start Guide](https://gravitational.com/teleport/docs/quickstart)
* [Teleport Architecture](https://gravitational.com/teleport/docs/architecture)
* [Admin Manual](https://gravitational.com/teleport/docs/admin-guide)
* [User Manual](https://gravitational.com/teleport/docs/user-manual)
* [FAQ](https://gravitational.com/teleport/docs/faq)
* [Quick Start Guide](https://goteleport.com/teleport/docs/quickstart)
* [Teleport Architecture](https://goteleport.com/teleport/docs/architecture)
* [Admin Manual](https://goteleport.com/teleport/docs/admin-guide)
* [User Manual](https://goteleport.com/teleport/docs/user-manual)
* [FAQ](https://goteleport.com/teleport/docs/faq)

## Support and Contributing

We offer a few different options for support. First of all, we try to provide clear and comprehensive documentation. The docs are also in Github, so feel free to create a PR or file an issue if you think improvements can be made. If you still have questions after reviewing our docs, you can also:

* Join the [Teleport Community](https://community.gravitational.com/c/teleport) to ask questions. Our engineers are available there to help you.
* If you want to contribute to Teleport or file a bug report/issue, you can do so by creating an issue here in Github.
* If you are interested in Teleport Enterprise or more responsive support during a POC, we can also create a dedicated Slack channel for you during your POC. You can [reach out to us through our website](https://gravitational.com/teleport/) to arrange for a POC.
* If you are interested in Teleport Enterprise or more responsive support during a POC, we can also create a dedicated Slack channel for you during your POC. You can [reach out to us through our website](https://goteleport.com/teleport/) to arrange for a POC.

## Is Teleport Secure and Production Ready?

Teleport has completed several security audits from the nationally recognized
technology security companies. [Some](https://gravitational.com/blog/teleport-release-2-2/) of
technology security companies. [Some](https://goteleport.com/blog/teleport-release-2-2/) of
[them](https://gravitational.com/blog/teleport-security-audit/) have been made public.
We are comfortable with the use of Teleport from a security perspective.

You can see the list of companies who use Teleport in production on the Teleport
[product page](https://gravitational.com/teleport#customerlist).
[product page](https://goteleport.com/case-study/).

However, Teleport is still a relatively young product so you may experience
usability issues. We are actively supporting Teleport and addressing any
issues that are submitted to this repo. Ask questions, send pull requests,
report issues and don't be shy! :)

The latest stable Teleport build can be found in [Releases](https://gravitational.com/teleport/download/)
The latest stable Teleport build can be found in [Releases](https://goteleport.com/teleport/download)

## Who Built Teleport?

Teleport was created by [Gravitational Inc](https://gravitational.com). We have
Teleport was created by [Gravitational Inc](https://goteleport.com). We have
built Teleport by borrowing from our previous experiences at Rackspace. It has
been extracted from [Gravity](https://gravitational.com/gravity/), our
been extracted from [Gravity](https://goteleport.com/gravity), our
Kubernetes distribution optimized for deploying and remotely controlling complex
applications into multiple environments _at the same time_:

Expand Down

0 comments on commit 0f38826

Please sign in to comment.