Skip to content

Commit 2247db3

Browse files
committed
Update Quick Start guide in README for Docker Compose
1 parent 6cbc85e commit 2247db3

1 file changed

Lines changed: 7 additions & 17 deletions

File tree

README.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -40,25 +40,14 @@ and reset every day. Do not put sensitive data in the demo. An easy way to test
4040
## Quick Start for Docker Compose
4141

4242
```sh
43-
# Clone the project
44-
git clone https://github.com/DefectDojo/django-DefectDojo
45-
cd django-DefectDojo
46-
47-
# Check if your installed toolkit is compatible
48-
./docker/docker-compose-check.sh
49-
50-
# Building Docker images
51-
docker compose build
52-
53-
# Run the application
54-
# (see https://github.com/DefectDojo/django-DefectDojo/blob/dev/readme-docs/DOCKER.md for more info)
55-
docker compose up -d
56-
57-
# Obtain admin credentials. The initializer can take up to 3 minutes to run.
58-
# Use docker compose logs -f initializer to track its progress.
59-
docker compose logs initializer | grep "Admin password:"
43+
git clone https://github.com/DefectDojo/django-DefectDojo && cd django-DefectDojo && docker compose up
6044
```
6145

46+
This quick start guide will do the following
47+
48+
- Clone the repository and change directories
49+
- Start the application
50+
- Obtain admin credentials in the initializer logs. The first initialization can take up to 3 minutes to run.
6251

6352
## Documentation
6453

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

7464
## Supported Installation Options
7565

0 commit comments

Comments
 (0)