Skip to content

Latest commit

 

History

History
79 lines (50 loc) · 2.7 KB

README.md

File metadata and controls

79 lines (50 loc) · 2.7 KB
Raw
logo

DEEP-OC-satsr

Build Status

This is a container that will simply run the DEEP as a Service API component, with satsr (src: satsr).

Running the container

Directly from Docker Hub

To run the Docker container directly from Docker Hub and start using the API simply run the following command:

$ docker run -ti -p 5000:5000 -p 6006:6006 -p 8888:8888 deephdc/deep-oc-satsr

This command will pull the Docker container from the Docker Hub deephdc repository and start the default command (deepaas-run --listen-ip=0.0.0.0).

Running via docker-compose

docker-compose.yml allows you to run the application with various configurations via docker-compose.

N.B! docker-compose.yml is of version '2.3', one needs docker 17.06.0+ and docker-compose ver.1.16.0+, see https://docs.docker.com/compose/install/

If you want to use Nvidia GPU, you need nvidia-docker and docker-compose ver1.19.0+ , see nvidia/FAQ

Building the container

If you want to build the container directly in your machine (because you want to modify the Dockerfile for instance) follow the following instructions:

Building the container:

  1. Get the DEEP-OC-satsr repository (this repo):

    $ git clone https://github.com/deephdc/DEEP-OC-satsr

  2. Build the container:

    $ cd DEEP-OC-satsr
$ docker build -t deephdc/deep-oc-satsr .

  3. Run the container:

    $ docker run -ti -p 5000:5000 -p 6006:6006 -p 8888:8888 deephdc/deep-oc-satsr

    You can also run Jupyter Lab inside the container:

    $ docker run -ti -p 5000:5000 -p 6006:6006 -p 8888:8888 deephdc/deep-oc-satsr /bin/bash
$root@47a6604ef008:/srv# jupyter lab --allow-root

These three steps will download the repository from GitHub and will build the Docker container locally on your machine. You can inspect and modify the Dockerfile in order to check what is going on. For instance, you can pass the --debug=True flag to the deepaas-run command, in order to enable the debug mode.

Connect to the API

Once the container is up and running, browse to http://localhost:5000/ui to get the OpenAPI (Swagger) documentation page.