Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 3.03 KB

docker.md

File metadata and controls

85 lines (57 loc) · 3.03 KB

Docker

Note: Docker might not be an ideal way to deploy STAC Browser in production. Consider using a web host, cloud storage, or a CDN.

Create a custom image

Building the Dockerfile without changing any build options:

docker build -t stac-browser:v1 .

Run the container for a specific URL:

docker run -p 8080:8080 -e SB_catalogUrl="https://earth-search.aws.element84.com/v1/" stac-browser:v1

STAC Browser is now available at http://localhost:8080

You can pass further options to STAC Browser to customize it to your needs.

The build-only options pathPrefix and historyMode can be provided as a build argument when building the Dockerfile.

For example:

docker build -t stac-browser:v1 --build-arg pathPrefix="/browser/" --build-arg historyMode=hash .

All other options, except the ones that are explicitly excluded from CLI/ENV usage, can be passed as environment variables when running the container. For example, to run the container with a pre-defined catalogUrl and catalogTitle:

docker run -p 8080:8080 -e SB_catalogUrl="https://earth-search.aws.element84.com/v1/" -e SB_catalogTitle="Earth Search" stac-browser:v1

If you want to pass all the other arguments to npm run build directly, you can modify to the Dockerfile as needed.

STAC browser is now available at http://localhost:8080/browser

Use an existing image

Since version 3.1.1, you can add an existing image from Packages to your docker-compose.yml:

services:
  stac-browser:
    image: ghcr.io/radiantearth/stac-browser:latest
    ports:
      - 8080:8080
    environment:
      SB_catalogUrl: "https://localhost:7188"

How it works

The docker image uses a multi stage build. The first stage is based on a node image and runs npm build to produce a /dist folder with static files (HTML, CSS, and JavaScript). The second stage is based on an nginx image that serves the folder with static files and deals with the build-only options such as pathPrefix. So, essentialy, in the end you get an nginx instance that serves static files.

Essential parts

  1. Dockerfile - contains information on how to build the image.
  2. docker/default.conf - nginx configuration template, where <pathPrefix> is replaced during build.
  3. docker/docker-entrypoint.sh - a start script to read the passed variables and produce the config.js file.

FAQ

Can I use ghcr.io/radiantearth/stac-browser image with the pathPrefix?

You can not. You need to build your own image because pathPrefix is a build-only option.

How do I specify buildTileUrlTemplate via docker env?

You can not. Consider modifying the dockerfile and using a custom config.js file