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.

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

README improvements #162

Merged
merged 3 commits into from
Jan 31, 2023
Merged

README improvements #162

merged 3 commits into from
Jan 31, 2023

Conversation

anarcat
Copy link
Contributor

@anarcat anarcat commented Jan 30, 2023

I couldn't figure out how to use this module when I looked at the
README. It was quickly going into pretty arcane stuff like "inet
filter" and "ip nat table" which might make sense for the module
authors or people used to nftables/iptables, but are pretty
implementation specific when coming from another networking
background.

Instead, we just explain more clearly what the module does, and
how. We also provide more examples, including some that might seem
obvious ("you need to include nftables first") but were not obvious to
me at all.

I also add a warning about firewalld being stopped which seems
important as well.

Closes: #158

I couldn't figure out how to use this module when I looked at the
README. It was quickly going into pretty arcane stuff like "inet
filter" and "ip nat table" which might make sense for the module
authors or people used to nftables/iptables, but are pretty
implementation specific when coming from another networking
background.

Instead, we just explain more clearly what the module does, and
how. We also provide *more* examples, including some that might seem
obvious ("you need to include nftables first") but were not obvious to
me at all.

I also add a warning about firewalld being stopped which seems
important as well.

Closes: voxpupuli#158
Copy link
Member

@smortex smortex left a comment

Choose a reason for hiding this comment

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

As someone who has not seriously looked into nftables yet, this makes sense 💯

I don't know what the nfc command is, but it certainly looks like a
typo. Also, the flag to include a directory is `-I` here, not `-L`.
@nbarrientos nbarrientos added the documentation Improvements or additions to documentation label Jan 31, 2023
@nbarrientos
Copy link
Collaborator

Thanks for the patch!

@nbarrientos nbarrientos merged commit 67cf797 into voxpupuli:master Jan 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

failing to setup a basic firewall
5 participants