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

Prepare a more detailed guide / usage example #4

Open
MOZGIII opened this issue Feb 21, 2021 · 0 comments
Open

Prepare a more detailed guide / usage example #4

MOZGIII opened this issue Feb 21, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@MOZGIII
Copy link
Owner

MOZGIII commented Feb 21, 2021

To improve on the documentation, this project should prepare a guide or more detailed usage example.

I'm thinking of a video of some kind, or an article (on a wiki, or in the form of Markdown files in this repo). It should demonstrate the installation, configuration, and runtime process, and show both the Kubernetes and the router end.

I'd appreciate help with this issue!

I can provide guidance and architectural insights, but you would need a working Kubernetes cluster at home (wherever really, but not in a cloud, unless you can set up the right environment) and a router with a PCP server on board (it is sometimes called UPnP in the UI - UPnP is a different technology, but it routers typically implement both UPnP and PCP, but use only the UPnP name in the UI). OpenWRT has been tested and is known to work.

If you'd like to help with this issue - please leave a comment below before doing any work to let other people know you are working on it!

@MOZGIII MOZGIII added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Feb 21, 2021
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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant