From 64619348a7fc2711298279ffaf1d747eb2613c1a Mon Sep 17 00:00:00 2001 From: nscuro Date: Sat, 25 Apr 2026 12:31:45 +0200 Subject: [PATCH] Migrate quickstart docs Migrates the quickstart docs from https://github.com/DependencyTrack/hyades/blob/0.7.0-alpha.3/docs/getting-started/quickstart.md Signed-off-by: nscuro --- .vale.ini | 5 ++ .../vocabularies/DependencyTrack/accept.txt | 1 + docs/index.md | 2 + docs/tutorials/docker-compose.quickstart.yml | 47 +++++++++++++++++ docs/tutorials/quickstart.md | 51 +++++++++++++++++++ mkdocs.yml | 3 ++ 6 files changed, 109 insertions(+) create mode 100644 docs/tutorials/docker-compose.quickstart.yml create mode 100644 docs/tutorials/quickstart.md diff --git a/.vale.ini b/.vale.ini index 2183c1f..0e6a45d 100644 --- a/.vale.ini +++ b/.vale.ini @@ -33,6 +33,11 @@ BasedOnStyles = [docs/reference/schemas/*.md] BasedOnStyles = +# Tutorials use "we" voice and "will" to set expectations per Diataxis convention. +[docs/tutorials/*.md] +Google.We = NO +Google.Will = NO + # MkDocs abbreviation syntax (*[ABBR]: Definition) triggers false positives # for the colon capitalization rule, since `: ` is a syntax delimiter. [docs/includes/abbreviations.md] diff --git a/.vale/styles/config/vocabularies/DependencyTrack/accept.txt b/.vale/styles/config/vocabularies/DependencyTrack/accept.txt index ca0bdc3..8bb028b 100644 --- a/.vale/styles/config/vocabularies/DependencyTrack/accept.txt +++ b/.vale/styles/config/vocabularies/DependencyTrack/accept.txt @@ -48,6 +48,7 @@ PGTune Packagist Percona PgBouncer +Podman Postgres Protobuf SBOM diff --git a/docs/index.md b/docs/index.md index 00a9ab9..93a8de4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,6 +11,8 @@ that allows organizations to identify and reduce risk in the software supply cha ## Getting started +Get Dependency-Track running locally in minutes with the [quick start tutorial](tutorials/quickstart.md). + Explore the documentation using the navigation tabs: - [Tutorials](tutorials/index.md): step-by-step walkthroughs for common workflows. diff --git a/docs/tutorials/docker-compose.quickstart.yml b/docs/tutorials/docker-compose.quickstart.yml new file mode 100644 index 0000000..76e65a3 --- /dev/null +++ b/docs/tutorials/docker-compose.quickstart.yml @@ -0,0 +1,47 @@ +name: Dependency-Track + +services: + apiserver: + image: ghcr.io/dependencytrack/hyades-apiserver:snapshot + depends_on: + postgres: + condition: service_healthy + deploy: + resources: + limits: + memory: 2g + environment: + DT_DATASOURCE_URL: "jdbc:postgresql://postgres:5432/dtrack" + DT_DATASOURCE_USERNAME: "dtrack" + DT_DATASOURCE_PASSWORD: "dtrack" + ports: + - "127.0.0.1:8080:8080" + volumes: + - "apiserver-data:/data" + restart: unless-stopped + + frontend: + image: ghcr.io/dependencytrack/hyades-frontend:snapshot + environment: + API_BASE_URL: "http://localhost:8080" + ports: + - "127.0.0.1:8081:8080" + restart: unless-stopped + + postgres: + image: postgres:18-alpine + environment: + POSTGRES_DB: "dtrack" + POSTGRES_USER: "dtrack" + POSTGRES_PASSWORD: "dtrack" + healthcheck: + test: ["CMD-SHELL", "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}"] + interval: 5s + timeout: 3s + retries: 3 + volumes: + - "postgres-data:/var/lib/postgresql/data" + +volumes: + apiserver-data: {} + postgres-data: {} diff --git a/docs/tutorials/quickstart.md b/docs/tutorials/quickstart.md new file mode 100644 index 0000000..b39b81e --- /dev/null +++ b/docs/tutorials/quickstart.md @@ -0,0 +1,51 @@ +# Quick start + +In this tutorial, we will get Dependency-Track running locally using Docker Compose +and log in to the frontend for the first time. + +## What we need + +- [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/) +- [Compose v2](https://docs.docker.com/compose/install/) + +## Starting Dependency-Track + +We download the Compose file and start the stack: + +=== ":fontawesome-brands-linux: Linux / :fontawesome-brands-apple: macOS" + + ```shell + curl -O https://raw.githubusercontent.com/DependencyTrack/docs/main/docs/tutorials/docker-compose.quickstart.yml + docker compose -f docker-compose.quickstart.yml up + ``` + +=== ":fontawesome-brands-windows: Windows (PowerShell)" + + ```powershell + Invoke-WebRequest -Uri "https://raw.githubusercontent.com/DependencyTrack/docs/main/docs/tutorials/docker-compose.quickstart.yml" -OutFile "docker-compose.quickstart.yml" + docker compose -f docker-compose.quickstart.yml up + ``` + +This will pull the required images, initialize the database, and start all services. + +??? note "Compose file contents" + ```yaml + --8<-- "docs/tutorials/docker-compose.quickstart.yml" + ``` + +## Logging in + +Once the stack is up, we open the frontend at **** and log in +with the default credentials: + +| Username | Password | +|----------|----------| +| `admin` | `admin` | + +!!! note + Dependency-Track will ask us to change the password upon first login. + +## What's next + +- [Configuration](../reference/configuration/application.md): Customize the deployment +- [Scaling](../guides/administration/scaling.md): Scale for production workloads diff --git a/mkdocs.yml b/mkdocs.yml index ed95c3e..f76c719 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -70,6 +70,9 @@ markdown_extensions: - toc: permalink: true - pymdownx.details +- pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - pymdownx.snippets: auto_append: - docs/includes/abbreviations.md