Usage

Assuming that you have Docker installed, you can start Structurizr Lite with the following commands:

docker pull structurizr/lite
docker run -it --rm -p 8080:8080 -v PATH:/usr/local/structurizr structurizr/lite

Be sure to replace PATH with the full path to the directory containing your workspace.dsl or workspace.json file. For example, if your workspace file is located in /Users/simon/structurizr, the commands would be:

docker pull structurizr/lite
docker run -it --rm -p 8080:8080 -v /Users/simon/structurizr:/usr/local/structurizr structurizr/lite

Once started, your workspace is available to view at http://localhost:8080 in your web browser.

Offset

Setting an environment variable named STRUCTURIZR_WORKSPACE_PATH provides a way to tell Structurizr Lite that your workspace definition can be found in a sub-directory of the Docker mount. This can be useful in conjunction with the workspace extension feature; for example:

  • /Users/simon/structurizr/system-landscape.dsl
  • /Users/simon/structurizr/software-system-1/workspace.dsl (extends ../system-landscape.dsl)
  • /Users/simon/structurizr/software-system-2/workspace.dsl (extends ../system-landscape.dsl)

To start Structurizr Lite against the workspace for "software system 1", you can use the following command:

docker run -it --rm -p 8080:8080 -v /Users/simon/structurizr:/usr/local/structurizr -e STRUCTURIZR_WORKSPACE_PATH=software-system-1 structurizr/lite