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.

Sign up for GitHub

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

Update Deploying Docker guide to Compose v2 #4276

Merged
merged 1 commit into from
Oct 18, 2024
Merged

Update Deploying Docker guide to Compose v2 #4276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 7 additions & 5 deletions docs/_docs/getting-started/deploy-docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ other than a modern version of Docker.
| 4.5GB RAM | 16GB RAM |
| 2 CPU cores | 4 CPU cores |

> These requirements can be disabled by setting the 'system.requirement.check.enabled' property or the 'SYSTEM_REQUIREMENT_CHECK_ENABLED' environment variable to 'false'.
> These requirements can be disabled by setting the 'system.requirement.check.enabled' property or the 'SYSTEM_REQUIREMENT_CHECK_ENABLED' environment variable to 'false'.

### Container Requirements (Front End)

Expand All @@ -29,12 +29,15 @@ other than a modern version of Docker.

### Quickstart (Docker Compose)

> The easiest way to use Docker Compose is by installing Docker Desktop, since Compose comes bundled as a plugin.
> See the official [Docker Compose installation guide](https://docs.docker.com/compose/install/) for alternative installation methods.

```bash
# Downloads the latest Docker Compose file
curl -LO https://dependencytrack.org/docker-compose.yml

# Starts the stack using Docker Compose
docker-compose up -d
docker compose up -d
```

### Quickstart (Docker Swarm)
Expand Down Expand Up @@ -69,11 +72,9 @@ docker run -d -m 8192m -p 8080:8080 --name dependency-track -v dependency-track:

The preferred method for production environments is to use docker-compose.yml with a corresponding
database container (Postgres, MySQL, or Microsoft SQL). The following is an example YAML file that
can be used with `docker-compose` or `docker stack deploy`.
can be used with `docker compose` or `docker stack deploy`.

```yaml
version: '3.7'

#####################################################
# This Docker Compose file contains two services
# Dependency-Track API Server
Expand Down Expand Up @@ -123,6 +124,7 @@ services:
#
# Optional OpenID Connect (OIDC) Properties
# - ALPINE_OIDC_ENABLED=true
# - ALPINE_OIDC_CLIENT_ID=
# - ALPINE_OIDC_ISSUER=https://auth.example.com/auth/realms/example
# - ALPINE_OIDC_USERNAME_CLAIM=preferred_username
# - ALPINE_OIDC_TEAMS_CLAIM=groups
Expand Down
2 changes: 0 additions & 2 deletions src/main/docker/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
version: '3.7'

#####################################################
# This Docker Compose file contains two services
# Dependency-Track API Server
Expand Down
Loading