Skip to content

Commit

Permalink
chore(docs): make the troubleshooting guide more discoverable
Browse files Browse the repository at this point in the history
  • Loading branch information
pitkley committed May 29, 2022
1 parent 2c71723 commit 1371dad
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@
1. [Example](#overview-example)
2. [Getting started](#gettingstarted)
3. [Configuration](#configuration)
4. [IPv6 support](#ipv6support)
4. [Troubleshooting](#troubleshooting)
5. [IPv6 support](#ipv6support)
1. [Example: webserver reachable via IPv6](#ipv6support-example)
5. [Breaking changes](#breakingchanges)
6. [Breaking changes](#breakingchanges)
1. [Coming from v0.x to v1.x](#breakingchanges-v0tov1)
6. [Supported architectures](#supportedarchitectures)
7. [Supported Docker versions](#supporteddockerversions)
8. [Version bump policy](#versionbumppolicy)
9. [License](#license)
7. [Supported architectures](#supportedarchitectures)
8. [Supported Docker versions](#supporteddockerversions)
9. [Version bump policy](#versionbumppolicy)
10. [License](#license)
1. [Contribution](#license-contribution)

-----
Expand Down Expand Up @@ -167,6 +168,13 @@ The general configuration happens across six categories:
[examples]: https://github.com/pitkley/dfw/tree/main/examples
[types.rs]: https://dfw.rs/1.2.1/dfw/types/index.html

## <a name="troubleshooting"></a> Troubleshooting

If you are experiencing issues with DFW, you can consult the [troubleshooting documentation][docs-troubleshooting] for known potential obstacles.
If you don't find your issue covered, feel free to [open a GitHub issue describing your problem](https://github.com/pitkley/dfw/issues/new).

[docs-troubleshooting]: https://github.com/pitkley/dfw/blob/main/docs/TROUBLESHOOTING.md

## <a name="ipv6support"></a> IPv6 support

If you make a container publicly available, DFW will use "destination NATting" and "masquerading" to redirect incoming packets to the correct internal IP of the container, and then correctly redirect the reponses back to the original requester.
Expand Down
2 changes: 1 addition & 1 deletion docs/TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This document collects known problems that might occur when using DFW, and instructions on how to fix them.

If you are experiencing issues with DFW that you don't find represented here, feel free to [open a GitHub issue describing your problem](https://github.com/pitkley/dfw/issues/new).
If you are experiencing issues with DFW that you don't find represented here, feel free to [open a GitHub issue describing your problem](https://github.com/pitkley/dfw/issues/new), and please include the output from DFW you are seeing with the `--log-level debug` command-line argument set.

---

Expand Down

0 comments on commit 1371dad

Please sign in to comment.