Skip to content

advanced-ui-custom-base-path.md

Latest commit

 

History

History
62 lines (40 loc) · 2.65 KB

advanced-ui-custom-base-path.md

File metadata and controls

62 lines (40 loc) · 2.65 KB

Advanced - UI Custom Base Path

This document lists the instructions for building a PlanDev UI docker image with a custom base path. While the default path and resulting application URL are usually a good fit, some installations may choose a custom path to support deployment behind a gateway, to provide consistency with other non-PlanDev applications that the mission is using, or this could be part of a configuration that supports running multiple instances of PlanDev UI on the same machine.

Building

  1. Clone the plandev-ui repository and install dependencies. Note that Node LTS is required (currently 18.13.0).

    git clone https://github.com/NASA-AMMOS/plandev-ui.git
cd aerie-ui
npm install

    When you clone plandev-ui the default branch is develop. If you want to build an image from a specific release you have to checkout the proper tag. For example to checkout v1.0.0 do:

    git checkout tags/v1.0.0 -b v1.0.0

  2. Update svelte.config.js with the base path you want to use. Note that a leading / is required. So for example a valid base path is /plandev.

  3. Build the plandev-ui.

    npm run build

  4. Build the UI Docker image. By convention, docker images/containers use the legacy "aerie" name. For example we tag the image here with aerie-ui, but you can change this tag:

    docker build -t aerie-ui .

  5. Use the newly built image as part of your normal PlanDev Docker deployment.

Cleaning

If you ever need to re-run through these instructions make sure you always start from a clean environment. Remove all dependencies and build artifacts in aerie-ui:

rm -rf node_modules
rm -rf .svelte-kit
rm -rf build

Remove the built Docker image:

docker rmi aerie-ui

References

  1. plandev-ui Developer.md
  2. plandev-ui Deployment.md

Svelte Kit Issues

Once this issue is resolved we will no longer need this document.

  1. Dynamic basepath