https://github.com/alex-guoba/docker-diagrams
Generate architecture diagrams by docker compose files.
https://github.com/alex-guoba/docker-diagrams
diagrams-as-code docker-compose
Last synced: 2 months ago
JSON representation
Generate architecture diagrams by docker compose files.
- Host: GitHub
- URL: https://github.com/alex-guoba/docker-diagrams
- Owner: alex-guoba
- License: other
- Created: 2025-02-19T03:35:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-22T12:03:09.000Z (over 1 year ago)
- Last Synced: 2026-02-12T22:46:53.271Z (4 months ago)
- Topics: diagrams-as-code, docker-compose
- Language: Go
- Homepage:
- Size: 206 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker Digrams - Generate Diagrams from Docker Compose files
## Intro
Docker Diagrams is a tool that generates diagrams from Docker Compose files.
## Features
1. supports Docker Compose files compliant with Docker Compose specification
2. supports multiple environment variables in Docker Compose files
## Installation
```bash
go install github.com/alex-guoba/docker-diagrams
```
## Usage
### Generate diagram
Make sure you have a Docker Compose file in your current directory.
```bash
docker-diagrams
```
### Generate diagram with custom options
```bash
docker-diagrams -i= -e=
```
Docker-Diagrams will create a folder in the output directory( default to 'go-diagrams') with the graphviz DOT file and any image assets.
Create an ouput image with any graphviz compatible renderer:
```bash
dot -Tpng .png
```
## Exampe
```bash
docker-diagrams -i ./testcase/docker-compose.yml -e testcase/.env.dev
cd go-diagrams
dot -Tpng docker-compose.dot output.png
```
## Opiptions
```
-e string
path to environment file (default ".env")
-i string
path to docker compose file (default "docker-compose.yml")
```