search

opnsense / docs

OPNsense documentation
Other
114 stars 181 forks source link

How-To for Reflection and Hairpin NAT added #489

Closed Monviech closed 10 months ago

Monviech commented 12 months ago

I added a how-to nat_reflection.rst for Reflection and Hairpin NAT and tried to embed is as naturally as possible into the existing documentation. I also changed nat.rst to refer to the how-to section and improved some of the Reflection descriptions in firewall_settings.rst

I'm open to discussion and I'm sure this will take a while to review because it's a big addition.

AdSchellevis commented 11 months ago

@Monviech I left one comment, but in general I think it's a good addition certainly worth merging.

Monviech commented 10 months ago

@AdSchellevis I think the tutorial is in a good shape, I have let some people test it the past weeks and the general feedback was that it resolved their NAT problems.

Two examples: https://forum.opnsense.org/index.php?topic=36241.0 https://forum.opnsense.org/index.php?topic=36071

Would it be best practice to add my real name as author when I create sections in the doc?

AdSchellevis commented 10 months ago

@Monviech for the docs we don't really have options to annotate the copyright (although one or two how-to's contain a contributor name), I can ask @fichtner to mention you in the release notes of the product.

Monviech commented 10 months ago

@AdSchellevis Sounds good. I'll continue to write tutorials if I find some things that can be improved. :)

AdSchellevis commented 10 months ago

@Monviech ok, just let @fichtner known which name to add and I'll take a look at this PR (and merge it asap). Thanks for your contribution!

Monviech commented 10 months ago

@AdSchellevis @fichtner I'm fine with my nickname being used, for consistency. Same as with the PRs in core. I'm happy your team appreciates my efforts.

AdSchellevis commented 10 months ago

@Monviech I just took the time to merge and compile the docs, one small issue with an underline, but the text is really good, thanks a lot, these efforts are much appreciated, this is a very good outline of the problem and implementation scenario's.

Monviech commented 10 months ago

@AdSchellevis I appreciate your feedback. I'm happy you like my style of writing. The compiling issue went unnoticed by me because I use sphinx-autobuild while editing the docs so it's not always compiled fully when I edit something. I also have a lot of compile errors due to using python3 it seems.