Skip to content

Commit 6bb8a0b

Browse files
Fix/published ports not accessible in host mode (#502)
* Update README.md To resolve the problem of published ports being discarded in the host network mode, delete the "--network='host'" option. * Update README.md I have included extra documentation on the docker network mode and also added relevant local commands to make it easier to follow. * Reformat Docker run sections --------- Co-authored-by: Michael Chin <mchin188@yahoo.com>
1 parent 697d936 commit 6bb8a0b

File tree

1 file changed

+32
-13
lines changed

1 file changed

+32
-13
lines changed

docker/README.md

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
2-
31
Run `%load_ext graph_notebook.magics` at the top of a notebook to enable gremlin magic like `%%gremlin`
42

53
Default password is `admin`.
64

75
## Example Runs
6+
7+
### On Linux:
8+
- Note that these commands invoke [host networking mode](https://docs.docker.com/network/host/). This mode is only compatible with Linux, and may cause issues if run on a Mac or Windows host.
9+
810
```sh
9-
docker run --network="host" -p 8888:8888 -t graph-notebook
11+
docker run --network="host" -p 8888:8888 -t graph-notebook
1012

1113
# Sharing directories
12-
docker run --network="host" -p 8889:8889 -p 8888:8888 -v $(pwd)/out:/working
14+
docker run --network="host" -p 8889:8889 -p 8888:8888 -v $(pwd)/out:/working
15+
1316

1417
# For connecting with IAM Auth
1518
docker run -p 8888:8888 \
@@ -20,11 +23,32 @@ docker run -p 8888:8888 \
2023
graph-notebook
2124
```
2225

23-
Example Notebooks are placed in the `Example Notebooks` sub-directory
26+
### On Mac/Windows:
27+
28+
```sh
29+
docker run -p 8888:8888 -t graph-notebook
30+
31+
# Sharing directories
32+
docker run -p 8889:8889 -p 8888:8888 -v $(pwd)/out:/working
33+
34+
# For connecting with IAM Auth
35+
docker run -p 8888:8888 \
36+
-e AWS_ACCESS_KEY_ID \
37+
-e AWS_SECRET_ACCESS_KEY \
38+
-e AWS_SESSION_TOKEN \
39+
-e AWS_REGION="us-east-1" \
40+
graph-notebook
41+
```
42+
43+
44+
## Post-Launch Configuration
45+
46+
Example Notebooks are placed in the `Example Notebooks` sub-directory.
2447

2548
Within the Jupyter Notebook you must configure the Notebook settings to account for `localhost` or `remote` connections.
2649

27-
### Example Localhost Connection:
50+
### Example Localhost Connection
51+
2852
```ipynb
2953
%%graph_notebook_config
3054
{
@@ -40,7 +64,8 @@ Within the Jupyter Notebook you must configure the Notebook settings to account
4064
}
4165
```
4266

43-
### Example Neptune Proxy Connection:
67+
### Example Neptune Proxy Connection
68+
4469
```ipynb
4570
{
4671
"host": "clustername.cluster-ididididid.us-east-1.neptune.amazonaws.com",
@@ -54,8 +79,6 @@ Within the Jupyter Notebook you must configure the Notebook settings to account
5479
}
5580
```
5681

57-
58-
5982
## Configurable Properties
6083

6184
| Parameter | Description |
@@ -77,7 +100,3 @@ Within the Jupyter Notebook you must configure the Notebook settings to account
77100
| PROVIDE_EXAMPLES | Whether or not to automatically copy example notebooks over when a volume is being shared. |
78101
| GRAPH_NOTEBOOK_PROXY_HOST | Host that will proxy requests to Neptune. Will not proxy if not provided. |
79102
| GRAPH_NOTEBOOK_PROXY_PORT | Port for proxy host. |
80-
81-
82-
83-

0 commit comments

Comments
 (0)