forked from OHIF/Viewers
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: Docker build and run were not working (OHIF#3081)
* fix: Use single quotes instead of backticks when specifying the environment variable that should be substituted for the envsubst command. GitHub issue: OHIF#3079 Removed duplicate calls to envsubst. Default nginx listen port is now 80. Adde markdown documentation. * fix: Fixed some typos and wording in markdown documentation. GitHub issue: OHIF#3079 Co-authored-by: Joe Boccanfuso <joe.boccanfuso@radicalimaging.com>
- Loading branch information
Showing
7 changed files
with
53 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,5 @@ | ||
server { | ||
listen ${PORT}; | ||
# listen 3000; | ||
location / { | ||
root /usr/share/nginx/html; | ||
index index.html index.htm; | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
sidebar_position: 4 | ||
--- | ||
|
||
# Docker | ||
|
||
The OHIF source code provides a Dockerfile to create and run a Docker image that containerizes an [nginx](https://www.nginx.com/) web server serving the OHIF Viewer. | ||
|
||
:::info Good to Know | ||
The OHIF Viewer Docker image for the `v3-stable` branch is not yet published. The available image in [Docker Hub](https://hub.docker.com/r/ohif/viewer) is based on the `master` branch. | ||
::: | ||
|
||
## Prequisites | ||
The machine on which to build and run the Docker container must have: | ||
1. All of the [requirements](./build-for-production.md#build-for-production) for building a production version of OHIF. | ||
2. A checked out branch of the OHIF Viewer. | ||
3. [Docker](https://docs.docker.com/get-docker/) installed. | ||
|
||
## Building the Docker Image | ||
The docker image can be built from a terminal window as such: | ||
1. Switch to the OHIF Viewer code root directory. | ||
2. Issue the following docker command. Note that what follows `-t` flag is the `{name}:{tag}` for the Docker image and is arbitrary when creating a local Docker image. | ||
|
||
```sh | ||
docker build . -t ohif-viewer-image | ||
``` | ||
|
||
## Running the Docker Container | ||
Once the Docker image has been built, it can be run as a container from the command line as in the block below. Note that the last argument to the command is the name of the Docker image and the table below describes the other arguments. | ||
|
||
|Flag|Description| | ||
|----|-----------| | ||
|-d|Run the container in the background and print the container ID| | ||
|-p {host-port}:{nginx-port}/tcp|Publish the `nginx` listen port on the given host port| | ||
|--name|An arbitrary name for the container.| | ||
|
||
|
||
```sh | ||
docker run -d -p 3000:80/tcp --name ohif-viewer-container ohif-viewer-image | ||
``` | ||
|
||
### Configuring the `nginx` Listen Port | ||
|
||
The Dockerfile and entry point use the `${PORT}` environment variable as the port that the `nginx` server uses to serve the web server. The default value for `${PORT}` is `80`. One way to set this environment variable is to use the `-e` switch when running the container with `docker run`. The block below gives an example where the listen port is set to `8080` and publised on the host as `3000`. | ||
|
||
```sh | ||
docker run -d -e PORT=8080 -p 3000:8080/tcp --name ohif-viewer-container ohif-viewer-image | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 6 | ||
sidebar_position: 7 | ||
--- | ||
|
||
# Google Cloud Healthcare | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 4 | ||
sidebar_position: 5 | ||
--- | ||
|
||
# Nginx + Image Archive | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 5 | ||
sidebar_position: 6 | ||
--- | ||
|
||
# User Account Control | ||
|