Skip to content
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

Jump to bottom

Adding IPv6 support to documentation for Docker setups #2813

Merged
merged 5 commits into from
May 28, 2024
Merged

Adding IPv6 support to documentation for Docker setups #2813

merged 5 commits into from
May 28, 2024

Conversation

stephanie0x00
Copy link
Contributor

@stephanie0x00 stephanie0x00 commented Apr 10, 2024 •
edited
Loading

An OpenKAT setup doesn't perform scans against IPv6 addresses by default as this is the default setting of Docker. In order to perform scans against IPv6 addresses you have to manually add a configuration to a file on Debian/Ubuntu setups. This PR adds the snippets a user should configure locally in order to enable IPv6 support, as this isn't currently documented.

Changes

Added the references to enable IPv6 support to the documentation.

Issue link

n/a

Code Checklist

  • All the commits in this PR are properly PGP-signed and verified.
  • This PR only contains functionality relevant to the issue; tickets have been created for newly discovered issues.
  • I have written unit tests for the changes or fixes I made.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have performed a self-review of my code and refactored it to the best of my abilities.

Communication

  • I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
  • I have made corresponding changes to the documentation, if necessary.
  • I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.

Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

@stephanie0x00
Update containers.md
5b3dd15 
Add reference to Docker documentation to enable IPv6 support.
ammar92
ammar92 previously approved these changes Apr 20, 2024
View reviewed changes
ammar92
ammar92 reviewed Apr 20, 2024
View reviewed changes
docs/source/technical_design/containers.md Outdated
@@ -95,6 +95,10 @@ With docker compose you would run this as:
docker compose --env-file .env-prod -f docker-compose.release-example.yml exec rocky python3 manage.py setup_dev_account
```

## IPv6 support
In order to perform scans against IPv6 addresses you need to manually enabled IPv6 support in Dockerized setups. See the [Docker documentation](https://docs.docker.com/config/daemon/ipv6/) on how to do this.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In order to perform scans against IPv6 addresses you need to manually enabled IPv6 support in Dockerized setups. See the [Docker documentation](https://docs.docker.com/config/daemon/ipv6/) on how to do this.
In order to perform scans against IPv6 addresses you need to manually enable IPv6 support in Dockerized setups. See the [Docker documentation](https://docs.docker.com/config/daemon/ipv6/) on how to do this.

@ammar92
Copy link
Contributor

ammar92 commented May 7, 2024

@stephanie0x00 Any updates on this?

@stephanie0x00
Update containers.md
52a7876 
Added IPv6 snippets from docker docs.
@stephanie0x00
Copy link
Contributor Author

@ammar92 updated the docs by adding the required snippet instead of only referencing to the Docker docs, as our docker-compose.yml file already contains the IPv6 network configuration.

@stephanie0x00 stephanie0x00 marked this pull request as ready for review May 22, 2024 14:02
@stephanie0x00 stephanie0x00 requested a review from a team as a code owner May 22, 2024 14:03
@stephanie0x00 stephanie0x00 added the documentation Improvements or additions to documentation label May 23, 2024
@dekkers dekkers merged commit 58e6b06 into main May 28, 2024
6 checks passed
@dekkers dekkers deleted the docs-enable-ipv6-support branch May 28, 2024 09:23
@stephanie0x00 stephanie0x00 mentioned this pull request Jun 6, 2024
Closed
jpbruinsslot added a commit that referenced this pull request Jun 11, 2024
@jpbruinsslot
Merge branch 'main' into feature/mula/refactor-queue
8c5d7bf 
* main: (78 commits)
  Translations update from Hosted Weblate (#3048)
  Translations update from Hosted Weblate (#3018)
  Fix empty consumes of boefjes will trigger tasks in scheduler (#3017)
  Fixes text in secondary menu on scan profile detail page (#3035)
  chore: Resolves css-issues found by sonarcloud (#3034)
  Add raw AuthToken SQL migration (#3009)
  Translations update from Hosted Weblate (#3012)
  Rewrite xtdb-cli.py with "click" (#2957)
  Phase out the Repository model from the KATalogus (#2984)
  Fix merge conflicts in weblate (#3007)
  Translations update from Hosted Weblate (#2996)
  Reports: Fix select all OOIs (#2909)
  Adding IPv6 support to documentation for Docker setups (#2813)
  Translations update from Hosted Weblate (#2930)
  User documentation for reports (#2898)
  Fix task api status code response for malformed id in the scheduler (#2953)
  Add drill trace option in dnssec boefje (#2979)
  Updated packages (#2972)
  Update granian and remove workaround for fixed bug (#2980)
  Fix typing in boefjes/normalizers (#2933)
  ...
jpbruinsslot added a commit that referenced this pull request Jun 17, 2024
@jpbruinsslot
Merge branch 'main' into fix/pydantic-serialization
f095bd7 
* main: (40 commits)
  Translations update from Hosted Weblate (#3091)
  feat: 📝 add API titles (#3055)
  Fixed 2 small mistakes in documentation (#3089)
  Documentation - developer and helper functionality documentation for xtdb-cli tool (#3023)
  fix: 🔧 update db normalize setting (#2777)
  Translations update from Hosted Weblate (#3048)
  Translations update from Hosted Weblate (#3018)
  Fix empty consumes of boefjes will trigger tasks in scheduler (#3017)
  Fixes text in secondary menu on scan profile detail page (#3035)
  chore: Resolves css-issues found by sonarcloud (#3034)
  Add raw AuthToken SQL migration (#3009)
  Translations update from Hosted Weblate (#3012)
  Rewrite xtdb-cli.py with "click" (#2957)
  Phase out the Repository model from the KATalogus (#2984)
  Fix merge conflicts in weblate (#3007)
  Translations update from Hosted Weblate (#2996)
  Reports: Fix select all OOIs (#2909)
  Adding IPv6 support to documentation for Docker setups (#2813)
  Translations update from Hosted Weblate (#2930)
  User documentation for reports (#2898)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ammar92 ammar92 ammar92 left review comments

@dekkers dekkers dekkers approved these changes

Assignees

@stephanie0x00 stephanie0x00

Labels
documentation Improvements or additions to documentation
Projects
KAT
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stephanie0x00 @ammar92 @dekkers