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

addresses documentation problems raised in issue 35 #36

Merged
merged 1 commit into from
Dec 4, 2024

Conversation

Paraphraser
Copy link
Contributor

Responses to #35:

  1. Revises docker run example:

    • places container in host mode
    • runs container detached (so it does not appear to stall)
    • passes the user and group IDs for the local user (so persistent storage is owned by the local user)
    • changes default mechanism for net-filter rules to iptables-nft
    • places image reference on a separate line
  2. Revises docker compose service definition:

    • removes deprecated version clause, substituting the "here comes YAML" --- signature
    • changes default mechanism for net-filter rules to iptables-nft
  3. Re-writes explanation of ZEROTIER_ONE_USE_IPTABLES_NFT to make it clear that true is usually the correct option for all implementations (not just Raspberry Pi). Also adds explicit test to confirm that the container's net-filters are getting into the host's tables.

Opportunistic changes:

  1. Updates URLs for ZeroTier Knowledge Base article (avoids redirects when following those links).

  2. Clarifies that it is the ZeroTier Knowledge Base article which implements a half-router, and summarises the additional capabilities of zerotier-router.

  3. Adds cross-reference to IOTstack documentation (IMO this is more comprehensive than anything in the ZeroTier Knowledge Base).

  4. Removes extraneous 0x09 characters.

Fixes #35

Responses to zyclonite#35:

1. Revises `docker run` example:

	* places container in host mode
	* runs container detached (so it does not appear to stall)
	* passes the user and group IDs for the local user (so persistent
	  storage is owned by the local user)
	* changes default mechanism for net-filter rules to `iptables-nft`
	* places image reference on a separate line

2. Revises `docker compose` service definition:

	* removes deprecated `version` clause, substituting the
	  "here comes YAML" `---` signature
	* changes default mechanism for net-filter rules to `iptables-nft`

3. Re-writes explanation of `ZEROTIER_ONE_USE_IPTABLES_NFT` to make it
   clear that `true` is usually the correct option for all implementations
   (not just Raspberry Pi). Also adds explicit test to confirm that the
   container's net-filters are getting into the host's tables.

Opportunistic changes:

1. Updates URLs for ZeroTier Knowledge Base article (avoids redirects
   when following those links).

2. Clarifies that it is the ZeroTier Knowledge Base article which
   implements a half-router, and summarises the additional capabilities
   of `zerotier-router`.

3. Adds cross-reference to IOTstack documentation (IMO this is more
   comprehensive than anything in the ZeroTier Knowledge Base).

4. Removes extraneous `0x09` characters.

Fixes zyclonite#35

Signed-off-by: Phill Kelley <[email protected]>
Copy link
Owner

@zyclonite zyclonite left a comment

Choose a reason for hiding this comment

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

lgtm

@zyclonite zyclonite merged commit 8551038 into zyclonite:main Dec 4, 2024
10 of 18 checks passed
@Paraphraser Paraphraser deleted the 20241128-router-doc-main branch December 8, 2024 22:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Stuck on Starting v6 Control Plane
2 participants