self-hosted/teleport
self-hosted/teleport
1
0
Fork 0
mirror of https://github.com/gravitational/teleport synced 2024-10-21 17:53:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1024 from gravitational/rjones/docs-permit-user-env

Browse source 
Documentation for --permit-user-env.
This commit is contained in:
Russell Jones 2017-05-29 12:27:56 -07:00 committed by GitHub
parent e8514f8130 d34dd23889
commit abe4284217
1 changed files with 20 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
docs/2.0/admin-guide.md
View file

@ -91,15 +91,17 @@ But for simpler experimentation you can use command line flags to
$ teleport start --help
usage: teleport start [<flags>]
Flags:
-d, --debug Enable verbose logging to stderr
-r, --roles Comma-separated list of roles to start with [proxy,node,auth]
--advertise-ip IP to advertise to clients if running behind NAT
-l, --listen-ip IP address to bind to [0.0.0.0]
--auth-server Address of the auth server [127.0.0.1:3025]
--token One-time token to register with an auth server [none]
--nodename Name of this node, defaults to hostname
-c, --config Path to a configuration file [/etc/teleport.yaml]
--labels List of labels for this node
-d, --debug Enable verbose logging to stderr
-r, --roles Comma-separated list of roles to start with [proxy,node,auth]
--pid-file Full path to the PID file. By default no PID file will be created
--advertise-ip IP to advertise to clients if running behind NAT
-l, --listen-ip IP address to bind to [0.0.0.0]
--auth-server Address of the auth server [127.0.0.1:3025]
--token One-time token to register with an auth server [none]
--nodename Name of this node, defaults to hostname
-c, --config Path to a configuration file [/etc/teleport.yaml]
--labels List of labels for this node
--permit-user-env Enables reading of ~/.tsh/environment when creating a session
```
### Configuration Flags
@ -128,6 +130,11 @@ Let's cover some of these flags in more detail:
* `--labels` flag allows to assign a set of labels to a node. See the explanation
of labeling mechanism in the [Labeling Nodes](#labeling-nodes) section below.
* `--pid-file` flag creates a PID file if a path is given.
* `--permit-user-env` flag reads in environment variables from `~/.tsh/environment`
when creating a session.
### Configuration File
@ -259,6 +266,10 @@ ssh_service:
command: [/usr/bin/uname, -p]
period: 1h0m0s
# enables reading ~/.tsh/environment before creating a session. by default
# set to false, can be set true here or as a command line flag.
permit_user_env: false
# This section configures the 'proxy servie'
proxy_service:
# Turns 'proxy' role on. Default is 'yes'