Structurizr Lite

Overview | Documentation

Structurizr Lite is licensed to you by Structurizr Limited for use strictly in accordance with the terms of the End User License Agreement.

structurizr-lite.war (build 2828) Docker Hub

Getting started

Here's a brief guide to getting started with Structurizr Lite.

1. Create the Structurizr data directory

Structurizr Lite needs to be given access to a directory, in which a workspace.dsl or workspace.json file exists that defines your workspace. We'll refer to this directory as the "Structurizr data directory". If this directory doesn't exist when Structurizr Lite is started up, it will be created for you, along with a basic DSL file.


2. Starting Structurizr Lite

Structurizr Lite is available as a Docker image (recommended) and a Spring Boot application.

2.1 Docker

Assuming that you have Docker installed, to start Structurizr Lite, use the following command to pull the image from Docker Hub.

docker pull structurizr/lite

Then use the following command to start the Docker container, replacing PATH with the path to your Structurizr data directory:

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

For example, if your Structurizr data directory is located at /Users/simon/structurizr, the command would be:

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

Alternatively, you can use the image via Docker compose, with the following example docker-compose.yml file (again, replacing PATH with the path to your Structurizr data directory):

version: '3'
services:
  structurizr:
    container_name: structurizr
    image: structurizr/lite
    ports:
      - "8080:8080"
    volumes:
      - "PATH:/usr/local/structurizr:rw"

2.2 Spring Boot

To use the Spring Boot version, you'll need Java 11+ (required) and Graphviz (optional; if you want to use automatic layout). Download the Spring Boot .war file from the link above, and start with the following command, replacing PATH with the path to your Structurizr data directory:

java -jar structurizr-lite.war PATH

For example, if your Structurizr data directory is located at /Users/simon/structurizr, the command would be:

java -jar structurizr-lite.war /Users/simon/structurizr

Here's a starting point if you would like to build your own Docker image:

FROM eclipse-temurin:17.0.4_8-jre

RUN set -eux; \
	apt-get update; \
	apt-get install -y --no-install-recommends graphviz

ADD build/libs/structurizr-lite.war /usr/local/structurizr-lite.war

EXPOSE 8080

CMD ["java", "-jar", "/usr/local/structurizr-lite.war"]

3. Using Structurizr Lite

Navigating to http://localhost:8080 should open Structurizr Lite, where you'll be able to view any diagrams, documentation, and decision records defined in your workspace. Any changes made to the workspace.dsl or workspace.json files will be reflected when you refresh your web browser.