2016-03-18 21:54:20 +00:00
# Gravitational Teleport
2015-03-02 20:08:58 +00:00
2016-04-02 23:36:01 +00:00
|Project Links|
|---|
| [Teleport Website ](http://gravitational.com/teleport ) |
| [Documentation ](http://gravitational.com/teleport/docs/quickstart/ ) |
2016-03-18 21:54:20 +00:00
## Introduction
2015-10-06 23:31:51 +00:00
2016-03-22 04:50:23 +00:00
Gravitational Teleport ("Teleport") is a tool for remotely accessing isolated clusters of
2016-03-24 03:01:44 +00:00
Linux servers via SSH or HTTPS.
Unlike traditional key-based access, Teleport enables teams to easily adopt the following
practices:
2015-10-06 23:31:51 +00:00
2016-03-18 21:54:20 +00:00
- Avoid key distribution and [trust on first use ](https://en.wikipedia.org/wiki/Trust_on_first_use ) issues by using auto-expiring keys signed by a cluster certificate authority (CA).
- Enforce 2nd factor authentication.
- Connect to clusters located behind firewalls without direct Internet access via SSH bastions.
2016-03-22 04:50:23 +00:00
- Record and replay SSH sessions for knowledge sharing and auditing purposes.
- Collaboratively troubleshoot issues through session sharing.
- Discover online servers and Docker containers within a cluster with dynamic node labels.
2015-10-06 23:31:51 +00:00
2016-03-22 04:50:23 +00:00
Teleport is built on top of the high-quality [Golang SSH ](https://godoc.org/golang.org/x/crypto/ssh )
implementation and it is fully compatible with OpenSSH.
2015-10-06 23:31:51 +00:00
2016-03-24 19:36:44 +00:00
## Installing and Running
2016-06-17 19:47:41 +00:00
Download the [latest binary release ](https://github.com/gravitational/teleport/releases ),
unpack the .tar.gz and run `sudo make install` . This will copy Teleport binaries into
`/usr/local/bin` and the web assets to `/usr/local/share/teleport` .
2016-03-24 19:36:44 +00:00
Then you can run Teleport as a single-node cluster:
```
teleport start
```
2016-06-14 23:52:32 +00:00
## Building Teleport
You need to have Golang v1.5 or newer.
Clone this repository into `$GOPATH/gravitational/teleport` and run `make` .
2016-06-17 06:50:12 +00:00
You'll have to create `/var/lib/teleport` directory and then you can start
Teleport as a single-node cluster in development mode: `build/teleport start -d`
2016-06-14 23:52:32 +00:00
If you want to release your own Teleport version, edit this [Makefile ](Makefile ), update
`VERSION` and `SUFFIX` constants, then run `make setver` to update [version.go ](version.go )
If you want to cut another binary release tarball, run `make release` .
2016-06-17 06:50:12 +00:00
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.
2016-06-14 23:52:32 +00:00
## Why did We Build Teleport?
2016-01-17 23:16:53 +00:00
2016-03-18 21:54:20 +00:00
Mature tech companies with significant infrastructure footprints tend to implement most
2016-03-22 04:50:23 +00:00
of these patterns internally. Teleport allows smaller companies without
significant in-house SSH expertise to easily adopt them, as well. Teleport comes with an
accesible Web UI and a very permissive [Apache 2.0 ](https://github.com/gravitational/teleport/blob/master/LICENSE )
license to facilitate adoption and use.
2016-01-17 23:16:53 +00:00
2016-03-22 04:52:42 +00:00
Being a complete standalone tool, Teleport can be used as a software library enabling
trust management in complex multi-cluster, multi-region scenarios across many teams
within multiple organizations.
2016-03-18 21:54:20 +00:00
## More Information
2015-10-06 23:31:51 +00:00
2016-03-18 21:54:20 +00:00
* [Quick Start Guide ](docs/quickstart.md )
* [Teleport Architecture ](docs/architecture.md )
* [Admin Manual ](docs/admin-guide.md )
* [User Manual ](docs/user-manual.md )
* [FAQ ](docs/faq.md )
2015-10-06 23:31:51 +00:00
2016-03-18 21:54:20 +00:00
## Contributing
2015-10-06 23:31:51 +00:00
2016-03-22 04:53:57 +00:00
The best way to contribute is to create issues or pull requests right here on Github. You can also reach the Gravitational team through their [website ](http://gravitational.com/ )
2015-10-06 23:31:51 +00:00
2016-04-30 03:10:32 +00:00
2016-03-18 21:54:20 +00:00
## Status
2016-03-10 03:39:15 +00:00
2016-03-18 21:54:20 +00:00
**Teleport is not ready to be used in production yet**. Teleport is undergoing a comprehensive
independent security audit.
2015-11-09 01:20:10 +00:00
2016-03-18 21:54:20 +00:00
## Who Built Teleport?
2015-11-09 01:20:10 +00:00
2016-03-18 21:54:20 +00:00
Teleport was created by [Gravitational Inc ](https://gravitational.com ). We have built Teleport
by borrowing from our previous experiences at Rackspace. It has been extracted from [Gravity ](http://gravitational.com/vendors.html ), our system for helping our clients to deploy
2016-03-22 04:50:23 +00:00
and remotely manage their SaaS applications on many cloud regions or even on-premise.