From 250b993304dfe36ff160b73138d3434344b92171 Mon Sep 17 00:00:00 2001 From: Paul Osinski <42211303+paulOsinski@users.noreply.github.com> Date: Thu, 23 Jan 2025 14:27:14 -0500 Subject: [PATCH] Readme docs - followup PR (#11525) * follow on to readme update * remove broken /pricing link * chg local_settings refs ldap-authentication.md --------- Co-authored-by: Paul Osinski --- README.md | 2 +- docs/content/en/open_source/api-v2-docs.md | 9 +++------ docs/content/en/open_source/ldap-authentication.md | 12 ++++++------ 3 files changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 25d4070a63..6ca297579b 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ of DefectDojo as we begin work on v3. Please see our [contributing guidelines](r information. Check out our latest update on v3 [here](https://github.com/DefectDojo/django-DefectDojo/discussions/8974). ## Pro Edition -[Upgrade to DefectDojo Pro](https://www.defectdojo.com/pricing) today to take your DevSecOps to 11. DefectDojo Pro is +[Upgrade to DefectDojo Pro](https://www.defectdojo.com/) today to take your DevSecOps to 11. DefectDojo Pro is designed to meet you wherever you are on your security journey and help you scale, with enhanced dashboards, additional smart features, tunable deduplication, and support from DevSecOps experts. diff --git a/docs/content/en/open_source/api-v2-docs.md b/docs/content/en/open_source/api-v2-docs.md index 3627d3e426..04939c9837 100644 --- a/docs/content/en/open_source/api-v2-docs.md +++ b/docs/content/en/open_source/api-v2-docs.md @@ -5,13 +5,10 @@ draft: false weight: 2 --- - - - DefectDojo\'s API is created using [Django Rest Framework](http://www.django-rest-framework.org/). The documentation of each endpoint is available within each DefectDojo installation at -[`/api/v2/doc/`](https://demo.defectdojo.org/api/v2/) and can be accessed by choosing the API v2 +[`/api/v2/oa3/swagger-ui`](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/)) and can be accessed by choosing the API v2 Docs link on the user drop down menu in the header. ![image](../../images/api_v2_1.png) @@ -45,7 +42,7 @@ For example: : ### Alternative authentication method -If you use [an alternative authentication method](../social-authentication/) for users, you may want to disable DefectDojo API tokens because it could bypass your authentication concept. \ +If you use [an alternative authentication method](../archived_docs/integrations/social-authentication/) for users, you may want to disable DefectDojo API tokens because it could bypass your authentication concept. \ Using of DefectDojo API tokens can be disabled by specifying the environment variable `DD_API_TOKENS_ENABLED` to `False`. Or only `api/v2/api-token-auth/` endpoint can be disabled by setting `DD_API_TOKEN_AUTH_ENDPOINT_ENABLED` to `False`. @@ -128,7 +125,7 @@ The json object result is: : {{< /highlight >}} See [Django Rest Framework\'s documentation on interacting with an -API](http://www.django-rest-framework.org/topics/api-clients/) for +API](https://www.django-rest-framework.org/) for additional examples and tips. ## Manually calling the API diff --git a/docs/content/en/open_source/ldap-authentication.md b/docs/content/en/open_source/ldap-authentication.md index e97758e02e..e6ee863f9c 100644 --- a/docs/content/en/open_source/ldap-authentication.md +++ b/docs/content/en/open_source/ldap-authentication.md @@ -17,7 +17,7 @@ We will need to modify a grand total of 4-5 files, depending on how you want to - Dockerfile.django-* - Dockerfile.nginx-* - requirements.txt - - settings.dist.py + - local_settings.py - docker-compose.yml *(Optional)* @@ -36,8 +36,8 @@ ldap-utils \ Please check for the latest version of these requirements at the time of implementation on pypi.org and use those if you can. -- [https://pypi.org/project/python-ldap/](python-ldap) -- [https://pypi.org/project/django-auth-ldap/](django-auth-ldap) +- [python-ldap](https://pypi.org/project/python-ldap/) +- [django-auth-ldap](https://pypi.org/project/django-auth-ldap/) Otherwise add the following to requirements.txt: @@ -47,9 +47,9 @@ django-auth-ldap==4.1.0 ``` -#### settings.dist.py +#### local_settings.py -Find the settings file (hint: `/dojo/settings/settings.dist.py`) and add the following: +Find the settings file (hint: check in `/dojo/settings/settings.py` for instructions for how to use `/dojo/settings/local_settings.py`, if the file does not already exist) and add the following: At the top of the file: ```python @@ -116,7 +116,7 @@ Read the docs for Django Authentication with LDAP here: https://django-auth-ldap #### docker-compose.yml -In order to pass the variables to the settings.dist.py file via docker, it's a good idea to add these to the docker compose file. +In order to pass the variables to the local_settings.py file via docker, it's a good idea to add these to the docker compose file. You can do this by adding the following variables to the environment section for the uwsgi image: ```yaml