generated from just-the-docs/just-the-docs-template
-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds Lite building from source instructions, early access builds, etc.
- Loading branch information
1 parent
9c197a7
commit 0f99d80
Showing
6 changed files
with
96 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
layout: default | ||
title: Building from source | ||
parent: Structurizr for Java | ||
nav_order: 70 | ||
permalink: /java/building | ||
--- | ||
|
||
# Building from source | ||
|
||
To build from the sources (you'll need git and Java 17+ installed): | ||
|
||
``` | ||
git clone https://github.com/structurizr/java.git structurizr-java | ||
cd structurizr-java | ||
./gradlew | ||
``` | ||
|
||
This will create a number of `.jar` files. For example: | ||
|
||
- `structurizr-client/build/libs/structurizr-client-{version}.jar` | ||
- `structurizr-core/build/libs/structurizr-core-{version}.jar` | ||
- etc | ||
|
||
You can publish these `.jar` files to your local Maven repository with the following command: | ||
|
||
``` | ||
./gradlew clean build publishToMavenLocal | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
layout: default | ||
title: Building from source | ||
parent: Structurizr Lite | ||
nav_order: 70 | ||
permalink: /lite/building | ||
--- | ||
|
||
# Building from source | ||
|
||
Part of the UI is shared between the on-premises installation, cloud service, and Structurizr Lite | ||
so you will need to additionally clone the [structurizr/ui](https://github.com/structurizr/ui) repo. | ||
|
||
## Build | ||
|
||
``` | ||
git clone https://github.com/structurizr/lite.git structurizr-lite | ||
git clone https://github.com/structurizr/ui.git structurizr-ui | ||
cd structurizr-lite | ||
./ui.sh | ||
./gradlew clean build | ||
``` | ||
|
||
If successful, you will see a file named `structurizr-lite.war` in `structurizr-onpremises/build/libs`. | ||
|
||
If you see an error message of the form `Could not find com.structurizr:structurizr-dsl:x.y.z`, you will need to | ||
[build the Structurizr for Java repo from source, and publish to your local Maven repository](/java/building). | ||
|
||
## Run | ||
|
||
To run Structurizr Lite, you can then use: | ||
|
||
``` | ||
java -jar build/libs/structurizr-lite.war /path/to/workspace | ||
``` | ||
|
||
(replace `/path/to/workspace` with the path to the folder where your `workspace.dsl` file is) | ||
|
||
## Docker | ||
|
||
To build a Docker image: | ||
|
||
``` | ||
docker build . -t mytag | ||
``` | ||
|
||
And to start a Docker container from this image (replace `/path/to/dataDirectory`): | ||
|
||
``` | ||
docker run -it --rm -p 8080:8080 -v /path/to/dataDirectory:/usr/local/structurizr mytag | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
layout: default | ||
title: Early access features | ||
parent: Structurizr Lite | ||
nav_order: 71 | ||
permalink: /lite/early-access | ||
--- | ||
|
||
# Early access features | ||
|
||
You have two options to gain early access to new/in-progress features: | ||
|
||
1. Build from source - follow the instructions at [Building from source](/lite/building). | ||
2. Use the pre-built early access builds that are available via the [Structurizr Patreon](https://patreon.com/structurizr). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters