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

Improve Documentation #6

Open
GeorgeMac opened this issue Apr 9, 2024 · 2 comments
Open

Improve Documentation #6

GeorgeMac opened this issue Apr 9, 2024 · 2 comments

Comments

@GeorgeMac
Copy link
Contributor

GeorgeMac commented Apr 9, 2024

This repo is pretty fresh, it needs more explanation and who doesn't need more docs anways.

Somethings I think need explaining more clearly:

  • The separation of the tunnel registration and the HTTP ports (does the latter need a better name, maybe proxy?)
  • Details on the tunnel groups YAML configuration format (whats it for, how to configure it)
  • Document the registration protocol

Is the README enough for now, or should I add something hosted?

If anyone out there wants more explaining, here is a good spot to ask and I will try get the docs in shape.

@jonnymccullagh
Copy link

Agree more docs please. To start is there any chance of building binaries and/or container images to make it easier to use ? go get is not the friendliest.

@GeorgeMac
Copy link
Contributor Author

Hey @jonnymccullagh absolutely!

So we already publish ghcr.io/flipt-io/reverst:latest here: https://github.com/flipt-io/reverst/pkgs/container/reverst
I will give some love to these docs this week and look into getting the CLI published via some of the usual suspect locations (GH Releases / Brew / do you have a package manager of choice?).

If you want to get the Go client then go get go.flipt.io/reverst/client should do it. Did you have issues with this?

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

No branches or pull requests

2 participants