Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: added docker-compose to readme.md #280

Closed
wants to merge 6 commits into from
Closed
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ Subcommands:
Options:
--help, -h -> Usage info
```
It supports hot-reloading, so your changes in the dsl will be reflected immediately.

### Version

Expand Down Expand Up @@ -243,6 +244,29 @@ Generatr container. So
is needed to expose the container's port 8080 to the host (web browser). In the example above, the
`-p 8080:8080` argument tells Docker to bind the local machine / host's port 8080 to the container's port 8080.

#### Simplify using Docker-Compose
Using Docker-Compose we can simplify the process.
dirkgroot marked this conversation as resolved.
Show resolved Hide resolved
Add a docker-compose.yml next to your workspace.dsl.
Add contents
```
version: '3'
services:
structurizr-site-generatr:
image: ghcr.io/avisi-cloud/structurizr-site-generatr
volumes:
- .:/var/model
# command: generate-site -w workspace.dsl
dirkgroot marked this conversation as resolved.
Show resolved Hide resolved
command: serve -w workspace.dsl
working_dir: /var/model
ports:
- 8080:8080
```
from your workspace folder, run
```
docker-compose up
```
This will host your pages at `localhost:8080`

## Customizing the generated website

The site generator use the
Expand Down