Revert "Revert "Update service docs""

This reverts commit 7ba28c0207.
This commit is contained in:
jjaraalm
2016-12-19 13:00:48 -05:00
parent 7ba28c0207
commit 62202bbb74
3 changed files with 31 additions and 31 deletions

View File

@@ -54,7 +54,7 @@ If a service is also to be managed by the Hub, it has a few extra options:
externally. externally.
- If a command is specified for launching the Service, the Service will - If a command is specified for launching the Service, the Service will
be started and managed by the Hub. be started and managed by the Hub.
- `env: dict` - environment variables to add to the current env - `environment: dict` - additional environment variables for the Service.
- `user: str` - the name of a system user to manage the Service. If - `user: str` - the name of a system user to manage the Service. If
unspecified, run as the same user as the Hub. unspecified, run as the same user as the Hub.
@@ -99,7 +99,7 @@ c.JupyterHub.services = [
A Hub-Managed Service may also be configured with additional optional A Hub-Managed Service may also be configured with additional optional
parameters, which describe the environment needed to start the Service process: parameters, which describe the environment needed to start the Service process:
- `env: dict` - additional environment variables for the Service. - `environment: dict` - additional environment variables for the Service.
- `user: str` - name of the user to run the server if different from the Hub. - `user: str` - name of the user to run the server if different from the Hub.
Requires Hub to be root. Requires Hub to be root.
- `cwd: path` directory in which to run the Service, if different from the - `cwd: path` directory in which to run the Service, if different from the

View File

@@ -454,7 +454,7 @@ class JupyterHub(Application):
'name': 'formgrader', 'name': 'formgrader',
'url': 'http://127.0.0.1:1234', 'url': 'http://127.0.0.1:1234',
'token': 'super-secret', 'token': 'super-secret',
'env': 'environment':
} }
] ]
""" """

View File

@@ -124,8 +124,8 @@ class Service(LoggingConfigurable):
Only use this if the service should be a subprocess. Only use this if the service should be a subprocess.
If command is not specified, it is assumed to be managed If command is not specified, it is assumed to be managed
by a by a
- env: dict - environment: dict
environment variables to add to the current env Additional environment variables for the service.
- user: str - user: str
The name of a system user to become. The name of a system user to become.
If unspecified, run as the same user as the Hub. If unspecified, run as the same user as the Hub.