Skip to content

Improve Documentation #6

@GeorgeMac

Description

@GeorgeMac

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions