Skip to content

Commit

Permalink
Added proper comments to teleport package
Browse files Browse the repository at this point in the history
So we're playing nicer with godoc
  • Loading branch information
kontsevoy committed Jan 4, 2017
1 parent 3934909 commit 02464f6
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 1 deletion.
26 changes: 26 additions & 0 deletions doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/*
Gravitational Teleport is a modern SSH server for remotely accessing clusters
of Linux servers via SSH or HTTPS. It is intended to be used instead of sshd.
Teleport enables teams to easily adopt the best SSH practices like:
- No need to distribute keys: Teleport uses certificate-based access with
automatic expiration time.
- Enforcement of 2nd factor authentication.
- Cluster introspection: every Teleport node becomes a part of a cluster
and is visible on the Web UI.
- Record and replay SSH sessions for knowledge sharing and auditing purposes.
- Collaboratively troubleshoot issues through session sharing.
- Connect to clusters located behind firewalls without direct Internet
access via SSH bastions.
- Ability to integrate SSH credentials with your organization identities
via OAuth (Google Apps, Github).
- Keep the full audit log of all SSH sessions within a cluster.
Teleport web site:
https://gravitational.com/teleport/
Teleport on Github:
https://github.com/gravitational/teleport
*/
package teleport
3 changes: 3 additions & 0 deletions version.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
/* DO NOT EDIT THIS FILE. IT IS GENERATED BY 'make setver'*/

package teleport

const (
Version = "1.3.2-beta"
)

// Gitref variable is automatically set to the output of git-describe
// during the build process
var Gitref string
4 changes: 3 additions & 1 deletion version.mk
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
GITREF=`git describe --dirty --long --tags`

# $(VERSION_GO) will be written to version.go
VERSION_GO="/* DO NOT EDIT THIS FILE. IT IS GENERATED BY 'make setver'*/\n\
VERSION_GO="/* DO NOT EDIT THIS FILE. IT IS GENERATED BY 'make setver'*/\n\n\
package teleport\n\
const( Version = \"$(VERSION)\" )\n\
// Gitref variable is automatically set to the output of "git-describe" \n\
// during the build process\n\
var Gitref string\n"

# $(GIT_GO) will be written to gitref.go
Expand Down

0 comments on commit 02464f6

Please sign in to comment.