Git Product home page Git Product logo

docs's Introduction

docs.zerotier.com

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

make start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Commits to main are automatically deployed to https://docs-dev.zerotier.com

To promote to production:

drone build promote zerotier/docs $DRONE_BUILD_NUMBER production

Note: You'll need the drone CLI installed and in the PATH, as well as a couple of environment variables set in order to run the drone CLI. ZeroTier employees can check out http://drone.ci.lab/account for details.

Spelling / Typos

yarn run lint

This is currently configured to not stop the build in CI. || true

You can add more words to ignore in the file custom-words.txt

You can ignore words in an individual markdown file like this: Make sure it's inside the front matter

---
title: Terraform (Multicloud)
# cSpell:words Hinojosa Gizienski
---

or inline

[//]: # (cspell:disable-next-line )

or add to the regexes in cspell.json. Have fun!

docs's People

Contributors

aaronjohnson avatar arinc9 avatar arktronic avatar bostick avatar danitheturtle avatar dependabot[bot] avatar erikh avatar github-actions[bot] avatar glimberg avatar joseph-henry avatar laduke avatar rcoder avatar someara avatar thiagola92 avatar zalmanlew avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

Proposed redirects

https://docs.zerotier.com/zerotier/microsegmentation, https://docs.zerotier.com/microsegmentation
https://docs.zerotier.com/zerotier/ztintro, https://docs.zerotier.com/zerotier
https://docs.zerotier.com/getting-started/getting-started, https://docs.zerotier.com/
https://docs.zerotier.com/zerotier/manual, https://docs.zerotier.com/protocol
https://docs.zerotier.com/zerotier/moons, https://docs.zerotier.com/roots
https://docs.zerotier.com/zerotier/multipath, https://docs.zerotier.com/multipath
https://docs.zerotier.com/zerotier/rules, https://docs.zerotier.com/rules
https://docs.zerotier.com/zerotier/troubleshooting, https://docs.zerotier.com/faq
https://docs.zerotier.com/zerotier/zerotier.conf, https://docs.zerotier.com/config
https://docs.zerotier.com/central/sso, https://docs.zerotier.com/sso
https://docs.zerotier.com/sockets/tutorial.html, https://docs.zerotier.com/sockets
https://docs.zerotier.com/self-hosting/introduction, https://docs.zerotier.com/selfhost
https://docs.zerotier.com/self-hosting/network-controllers, https://docs.zerotier.com/controller
https://docs.zerotier.com/devices/asustor, https://docs.zerotier.com/asustor
https://docs.zerotier.com/devices/freenas, https://docs.zerotier.com/freenas
https://docs.zerotier.com/devices/mikrotik, https://docs.zerotier.com/mikrotik
https://docs.zerotier.com/devices/openwrt, https://docs.zerotier.com/openwrt
https://docs.zerotier.com/devices/opnsense, https://docs.zerotier.com/opnsense
https://docs.zerotier.com/devices/qnap, https://docs.zerotier.com/qnap
https://docs.zerotier.com/devices/synology, https://docs.zerotier.com/synology
https://docs.zerotier.com/devices/teltonika, https://docs.zerotier.com/teltonika-networks
https://docs.zerotier.com/devices/ubiquiti, https://docs.zerotier.com/ubiquiti
https://docs.zerotier.com/devices/western-digital, https://docs.zerotier.com/wd
https://docs.zerotier.com/terraform/multicloud-quickstart, https://docs.zerotier.com/terraform-multicloud
https://docs.zerotier.com/terraform/quickstart, https://docs.zerotier.com/terraform
https://docs.zerotier.com/packages/snap, https://docs.zerotier.com/snap
https://docs.zerotier.com/zeronsd/quickstart, https://docs.zerotier.com/dns
https://docs.zerotier.com/central/v1, https://docs.zerotier.com/central/v1
https://docs.zerotier.com/service/v1, https://docs.zerotier.com/service/v1

These should go live right after the re-org is published.

@joylarkin if you see anything missing add it to the list but I think this covers all existing pages. If you linked to a specific section on a page like article#section that might be broken since I've simplified section names.

Exit node documentation

The exit node documentation page seems incomplete
https://github.com/zerotier/docs/edit/main/docs/exitnode.md

The Configure your network section just ends with "Central > Network >"

Also, the command sudo iptables-save is part the title of a code block. Should it not be in the code block? That section of code block, tip, code block with a command in the title just looks confusing.

Would be good the instructions covered more exit node OSes. Can an exit node only work on a Linux OS? Or are OPNSense, Windows, Android, etc... compatible as well?

Broken docs on setting up exit VPN node

Hello, i was researching on the topic, found the docs at https://docs.zerotier.com/exitnode/ and while "enough" weren't acceptable for my usecase, specifically ipv6 routing. I went on to research on history and found.

ecde02a#diff-cf89d22ba248ef2a3963d6c318b323cf49d2a077c100c4598d6e01a564ca7717

While from a nerdy point of view it really butchered it, I can see how it became more accessible to noobies and significantly shortened in scope.
However I'd like to ask for permission from @joseph-henry before going around and reworking it a bit, saving some of the best bits from the original. I would like to comply to contributors guidelines and help create a nice overview of what can it be done.

Please let me know on suggestions and places to improve as I suggest a PR :)
Thanks!

document bandwidth considerations

are there any practical considerations that would limit bandwidth when using ZeroTier as a gateway in a typical deployment? a certain number of always on devices streaming 100Mbps traffic for example

CPU speed and ISP bandwidth

we need some documentation that explains that because it is true but it's inadequate to help a customer

broken security call out box link on The Protocol page

On the security call out box on this page, https://docs.zerotier.com/protocol/#213cryptographyaname2_1_3a
the link is broken.

I looked in the page markdown file and the call out box uses a relative link reference [security] which links to https://docs.zerotier.com/protocol/security and not https://docs.zerotier.com/security

Screenshot 2023-11-30 at 10 13 09 AM

Note: a sales prospect found the broken link and complained about it. (I am submitting this fix before the sales team sees the complaint.)

update me

docusaurus is out of date and it's making it hard to do stuff.

Renaming "Protocol Design Whitepaper"

Within the ZeroTier marketing website, there is currently a link to "Manual" under the Support menu. This link points to a doc entitled “Protocol Design Whitepaper” posted as one of a series of documents on docs.zerotier.com. Hyperlinks in multiple docs also reference to this document as "the Manual". To alleviate the confusion about the document as part of the onboarding experience, the GTM team would like to see the following changes made:

  1. Within the marketing website, change "Manual" to "Getting Started" and change the hyperlink to point to the Getting Started document on docs.zerotier.com
  2. Either rename the "Protocol Design Whitepaper" document to something like “ZeroTier Design Manual”, or change all references to "Manual" in the other documents to "Design Whitepaper" or something more applicable.

SVG version of ZeroTier icon?

Hello there! 👋

I'm the maintainer of homelab-svg-assets and would like to add the ZeroTier icon to my project. However, I didn't see any brand guidelines or a vector (SVG) version of the icon. Could you please provide one or both of these?

Thanks, and keep up the good work!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.