Skip to content

Commit 8613a18

Browse files
devGregAMaffooch
andauthored
ReadMe Updates - New Community Portal (#14042)
* Revise README for Docker Compose V2 updates Updated README to reflect changes for Docker Compose V2 and removed outdated V1 instructions. * Revise demo links and installation options in README Updated demo environment description and installation options. * Fix Slack community link and improve wording Updated Slack community link and adjusted text for clarity. * Revise social media links and Slack community invitation Updated social media links and community invitation text. * Add files via upload * Update Slack logo link and Twitter image source * Update image sources in README.md * Fix image height in Community section of README * Add files via upload * Update image height in README.md * Revise community portal and Pro edition details Updated community engagement links and enhanced Pro edition description. * Fix formatting in installation options section * Update README.md * Update README.md --------- Co-authored-by: Cody Maffucci <46459665+Maffooch@users.noreply.github.com>
1 parent f11a362 commit 8613a18

3 files changed

Lines changed: 16 additions & 30 deletions

File tree

README.md

Lines changed: 16 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,12 @@ deduplication, remediation, and reporting.
3232

3333
Pro Edition: [pro.demo.defectdojo.com](https://pro.demo.defectdojo.com)
3434

35-
Community Edition: [demo.defectdojo.org](https://demo.defectdojo.org)
35+
OWASP Community Edition: [demo.defectdojo.org](https://demo.defectdojo.org)
3636

3737
Either demo enviornment can be logged into with username `admin` and password `1Defectdojo@demo#appsec`. Please note that the demos are publicly accessible
3838
and reset every day. Do not put sensitive data in the demo. An easy way to test DefectDojo is to upload some [sample scan reports](https://github.com/DefectDojo/django-DefectDojo/tree/master/unittests/scans).
3939

40-
## Quick Start for Compose V2
41-
42-
From July 2023 Compose V1 [stopped receiving updates](https://docs.docker.com/compose/reference/).
43-
44-
Compose V2 integrates compose functions into the Docker platform, continuing to support most of the previous
45-
docker-compose features and flags. You can run Compose V2 by replacing the hyphen (-) with a space, using
46-
`docker compose` instead of `docker-compose`.
40+
## Quick Start for Docker Compose
4741

4842
```sh
4943
# Clone the project
@@ -65,18 +59,6 @@ docker compose up -d
6559
docker compose logs initializer | grep "Admin password:"
6660
```
6761

68-
## For Docker Compose V1
69-
70-
You can run Compose V1 by calling `docker-compose` (by adding the hyphen (-) between `docker compose`).
71-
72-
Following commands are using original version so you might need to adjust them:
73-
```sh
74-
docker/docker-compose-check.sh
75-
docker/entrypoint-initializer.sh
76-
docker/setEnv.sh
77-
```
78-
79-
Navigate to `http://localhost:8080` to see your new instance!
8062

8163
## Documentation
8264

@@ -91,29 +73,29 @@ Navigate to `http://localhost:8080` to see your new instance!
9173

9274
## Supported Installation Options
9375

94-
* [SaaS](https://cloud.defectdojo.com/accounts/onboarding/plg_step_1) - New UI, addittional features, includes support & supports the project
95-
* [Docker / Docker Compose](readme-docs/DOCKER.md)
76+
* Pro - SaaS or self-hosted (via K8s or docker compose). [Speak to our team](https://defectdojo.com/contact) or [sign-up for SaaS directly](https://cloud.defectdojo.com/accounts/onboarding/plg_step_1)
77+
* OS - [docker compose](readme-docs/DOCKER.md)
9678

9779

9880
## Community, Getting Involved, and Updates
9981

100-
[<img src="https://raw.githubusercontent.com/DefectDojo/django-DefectDojo/dev/docs/assets/images/slack-logo-icon.png" alt="Slack" height="50"/>](https://owasp.org/slack/invite)
82+
[<img src="https://raw.githubusercontent.com/DefectDojo/django-DefectDojo/dev/docs/assets/images/updated-dojo-chop.png" alt="Dojo" height="50"/>](https://community-defectdojo.tightknit.community/)
83+
[<img src="https://raw.githubusercontent.com/DefectDojo/django-DefectDojo/dev/docs/assets/images/slack-logo-icon.png" alt="Slack" height="50"/>](https://join.slack.com/t/defectdojocommunity/shared_invite/zt-3l9028wlf-ezDB29D_MIh9ShXdesCHZA)
10184
[<img src="https://raw.githubusercontent.com/DefectDojo/django-DefectDojo/dev/docs/assets/images/Linkedin-logo-icon-png.png" alt="LinkedIn" height="50"/>](https://www.linkedin.com/company/defectdojo)
102-
[<img src="https://raw.githubusercontent.com/DefectDojo/django-DefectDojo/dev/docs/assets/images/Twitter_Logo.png" alt="Twitter" height="50"/>](https://twitter.com/defectdojo)
85+
[<img src="https://raw.githubusercontent.com/DefectDojo/django-DefectDojo/dev/docs/assets/images/x_logo.jpg" alt="Twitter" height="50"/>](https://x.com/defectdojo)
10386
[<img src="https://raw.githubusercontent.com/DefectDojo/django-DefectDojo/dev/docs/assets/images/YouTube-Emblem.png" alt="Youtube" height="50"/>](https://www.youtube.com/channel/UCWw9qzqptiIvTqSqhOFuCuQ)
10487

105-
[Join the OWASP Slack Community](https://owasp.org/slack/invite) and participate in the discussion! You can find us in
106-
our channel there, [#defectdojo](https://owasp.slack.com/channels/defectdojo). Follow DefectDojo on
107-
[Twitter](https://twitter.com/defectdojo), [LinkedIn](https://www.linkedin.com/company/defectdojo), and
108-
[YouTube](https://www.youtube.com/channel/UCWw9qzqptiIvTqSqhOFuCuQ) for project updates!
88+
Checkout our new [Community Portal](https://community-defectdojo.tightknit.community/) and join the DefectDojo community on [Slack](https://join.slack.com/t/defectdojocommunity/shared_invite/zt-3l9028wlf-ezDB29D_MIh9ShXdesCHZA)!
89+
90+
Follow DefectDojo on [LinkedIn](https://www.linkedin.com/company/defectdojo), [YouTube](https://www.youtube.com/channel/UCWw9qzqptiIvTqSqhOFuCuQ), and [X](https://twitter.com/defectdojo) for platform updates!
10991

11092
## Contributing
11193

11294
Please see our [contributing guidelines](readme-docs/CONTRIBUTING.md) for details and standards on contributing __before__ considering or submitting a pull request.
11395

11496
## Pro Edition
11597

116-
[Upgrade to DefectDojo Pro!](https://defectdojo.com/pricing) Pro transcends the do-it-yourself approach of open-source: A new UI, incredibile scalability, API connectors, ServiceNow, GitHub, GitLab, Azure DevOps, automatic data enrichment, prioritization, and more! See all the differentiators at the bottom of our pricing page: [defectdojo.com/pricing](https://defectdojo.com/pricing).
98+
[Upgrade to DefectDojo Pro!](https://defectdojo.com/pricing) Pro transcends the do-it-yourself approach of open-source: A new UI, risk-based vulnerability management, incredibile scalability, API connectors, ServiceNow, GitHub, GitLab, Azure DevOps, automatic data enrichment, prioritization, and more! See all the differentiators at the bottom of our pricing page: [defectdojo.com/pricing](https://defectdojo.com/pricing).
11799

118100
Alternatively, for information please email hello@defectdojo.com
119101

@@ -128,7 +110,6 @@ Core Moderators can help you with pull requests or feedback on dev ideas:
128110
* Cody Maffucci ([@Maffooch](https://github.com/maffooch) | [LinkedIn](https://www.linkedin.com/in/cody-maffucci))
129111

130112
Moderators can help you with pull requests or feedback on dev ideas:
131-
* Charles Neill ([@cneill](https://github.com/cneill) | [@ccneill](https://twitter.com/ccneill))
132113
* Blake Owens ([@blakeaowens](https://github.com/blakeaowens))
133114

134115
## Hall of Fame
@@ -148,6 +129,11 @@ Moderators can help you with pull requests or feedback on dev ideas:
148129
Aaron has been a long time contributor and user of DefectDojo. He did the second major UI overhaul and his
149130
contributions include automation enhancements, CI/CD engagements, increased metadata at the product level, and many
150131
more.
132+
* Jay Paz ([@jjpaz](https://github.com/grendel513)) – Jay was a DefectDojo
133+
maintainer for years. He performed Dojo's first UI overhaul, optomized code structure/features, and added numerous enhancements.
134+
* Charles Neill ([@ccneill](https://github.com/cneill)) – Charles served as a
135+
maintainer of DefectDojo for years and wrote some of Dojo's core functionality.
136+
151137

152138
## Security
153139

3.83 KB
Loading

docs/assets/images/x_logo.jpg

30.6 KB
Loading

0 commit comments

Comments
 (0)