Skip to content

Commit 784bc9a

Browse files
committed
Update documentation and changelog for #46
1 parent 4a503ab commit 784bc9a

2 files changed

Lines changed: 14 additions & 5 deletions

File tree

CHANGES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
* Improve handling of environment file specification (#63)
44
* Stop running container on SIGINT (#62)
5+
* `xcetool image run --server` prints server and viewer urls (#46)
56

67
## Changes in 0.1.1
78

docs/xcetool.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,19 @@ a CWL file defining a corresponding application package.
1919

2020
This subcommand runs an xcengine container image. An image can also be run using the
2121
`docker run` command, but `xcetool image run` provides some additional convenience
22-
(e.g. easy configuration of the HTTP port).
23-
24-
If you give the `--server` flag, `xcetool` will run the container indefinitely as an
25-
xcube server. You can stop the container and force `xcetool` to exit by pressing
26-
ctrl-C on the command line (or by sending it an interrupt signal in some other way).
22+
(e.g. easy configuration of a server HTTP port).
23+
24+
If you use the `--server` option with `xcetool image run`, the image will be run in
25+
xcube server mode: after the code from the input notebook is used to generate datasets,
26+
those datasets will be made available in an xcube server instance. You can also use
27+
the `--port` option to select the HTTP port where the xcube server should be exposed.
28+
The server also includes an interactive web viewer component. On start-up, `xcetool`
29+
will print the URLs of the xcube server and viewer to the standard output.
30+
31+
If you give the `--server` or `--port` options, `xcetool` will run the container
32+
indefinitely as an xcube server and viewer instance. You can stop the container and
33+
force `xcetool` to exit by pressing ctrl-C on the command line (or by sending it an
34+
interrupt signal in some other way).
2735

2836
### `xcetool make-script`
2937

0 commit comments

Comments
 (0)