Skip to content

Commit 250b993

Browse files
paulOsinskiPaul Osinski
andauthored
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 <paul.m.osinski@gmail.com>
1 parent 6e86d45 commit 250b993

3 files changed

Lines changed: 10 additions & 13 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ of DefectDojo as we begin work on v3. Please see our [contributing guidelines](r
113113
information. Check out our latest update on v3 [here](https://github.com/DefectDojo/django-DefectDojo/discussions/8974).
114114

115115
## Pro Edition
116-
[Upgrade to DefectDojo Pro](https://www.defectdojo.com/pricing) today to take your DevSecOps to 11. DefectDojo Pro is
116+
[Upgrade to DefectDojo Pro](https://www.defectdojo.com/) today to take your DevSecOps to 11. DefectDojo Pro is
117117
designed to meet you wherever you are on your security journey and help you scale, with enhanced dashboards, additional
118118
smart features, tunable deduplication, and support from DevSecOps experts.
119119

docs/content/en/open_source/api-v2-docs.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,10 @@ draft: false
55
weight: 2
66
---
77

8-
9-
10-
118
DefectDojo\'s API is created using [Django Rest
129
Framework](http://www.django-rest-framework.org/). The documentation of
1310
each endpoint is available within each DefectDojo installation at
14-
[`/api/v2/doc/`](https://demo.defectdojo.org/api/v2/) and can be accessed by choosing the API v2
11+
[`/api/v2/oa3/swagger-ui`](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/)) and can be accessed by choosing the API v2
1512
Docs link on the user drop down menu in the header.
1613

1714
![image](../../images/api_v2_1.png)
@@ -45,7 +42,7 @@ For example: :
4542

4643
### Alternative authentication method
4744

48-
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. \
45+
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. \
4946
Using of DefectDojo API tokens can be disabled by specifying the environment variable `DD_API_TOKENS_ENABLED` to `False`.
5047
Or only `api/v2/api-token-auth/` endpoint can be disabled by setting `DD_API_TOKEN_AUTH_ENDPOINT_ENABLED` to `False`.
5148

@@ -128,7 +125,7 @@ The json object result is: :
128125
{{< /highlight >}}
129126

130127
See [Django Rest Framework\'s documentation on interacting with an
131-
API](http://www.django-rest-framework.org/topics/api-clients/) for
128+
API](https://www.django-rest-framework.org/) for
132129
additional examples and tips.
133130

134131
## Manually calling the API

docs/content/en/open_source/ldap-authentication.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ We will need to modify a grand total of 4-5 files, depending on how you want to
1717
- Dockerfile.django-*
1818
- Dockerfile.nginx-*
1919
- requirements.txt
20-
- settings.dist.py
20+
- local_settings.py
2121
- docker-compose.yml *(Optional)*
2222

2323

@@ -36,8 +36,8 @@ ldap-utils \
3636

3737
Please check for the latest version of these requirements at the time of implementation on pypi.org and use those if you can.
3838

39-
- [https://pypi.org/project/python-ldap/](python-ldap)
40-
- [https://pypi.org/project/django-auth-ldap/](django-auth-ldap)
39+
- [python-ldap](https://pypi.org/project/python-ldap/)
40+
- [django-auth-ldap](https://pypi.org/project/django-auth-ldap/)
4141

4242
Otherwise add the following to requirements.txt:
4343

@@ -47,9 +47,9 @@ django-auth-ldap==4.1.0
4747
```
4848

4949

50-
#### settings.dist.py
50+
#### local_settings.py
5151

52-
Find the settings file (hint: `/dojo/settings/settings.dist.py`) and add the following:
52+
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:
5353

5454
At the top of the file:
5555
```python
@@ -116,7 +116,7 @@ Read the docs for Django Authentication with LDAP here: https://django-auth-ldap
116116

117117
#### docker-compose.yml
118118

119-
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.
119+
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.
120120

121121
You can do this by adding the following variables to the environment section for the uwsgi image:
122122
```yaml

0 commit comments

Comments
 (0)