Skip to content

Update Quick Start guide in README for Docker Compose #14335

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

Merged
mtesauro merged 3 commits into from
Feb 24, 2026
Merged

Update Quick Start guide in README for Docker Compose #14335

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2247db3
Update Quick Start guide in README for Docker Compose
Maffooch Feb 17, 2026
96a18dd
Update README.md
Maffooch Feb 23, 2026
9ca4c21
Merge branch 'bugfix' into readme-updates-to-quick-start-guide
mtesauro Feb 24, 2026
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
23 changes: 9 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,25 +40,19 @@ and reset every day. Do not put sensitive data in the demo. An easy way to test
## Quick Start for Docker Compose

```sh
# Clone the project
git clone https://github.com/DefectDojo/django-DefectDojo
cd django-DefectDojo
git clone https://github.com/DefectDojo/django-DefectDojo && cd django-DefectDojo && docker compose up
```

# Check if your installed toolkit is compatible
./docker/docker-compose-check.sh
This quick start guide will do the following

# Building Docker images
docker compose build
- Clone the repository and change directories
- Start the application
- Obtain admin credentials in the initializer logs. The first initialization can take up to 3 minutes to run.

# Run the application
# (see https://github.com/DefectDojo/django-DefectDojo/blob/dev/readme-docs/DOCKER.md for more info)
docker compose up -d

# Obtain admin credentials. The initializer can take up to 3 minutes to run.
# Use docker compose logs -f initializer to track its progress.
docker compose logs initializer | grep "Admin password:"
```
if running DefectDojo in detached mode via `docker compose up -d`, obtain admin credentials from the initializer logs with the command below. Please note, the initializer can take up to 3 minutes to run.

`docker compose logs initializer | grep "Admin password:"`

## Documentation

Expand All @@ -70,6 +64,7 @@ docker compose logs initializer | grep "Admin password:"
* [LDAP](https://docs.defectdojo.com/en/open_source/ldap-authentication/)
* [Supported tools](https://docs.defectdojo.com/en/connecting_your_tools/parsers/)
* [How to Write Documentation Locally](/docs/README.md)
* [Development](readme-docs/DOCKER.md#run-with-docker-compose-in-development-mode-with-hot-reloading)

## Supported Installation Options

Expand Down