README
¶
linkmeup
Linkmeup ("link-me-up") is a tool to help you access web applications (HTTPS protocol) in private Giant Swarm installations, with the help of Teleport.
Prerequisites
- You need
tshinstalled. Installation instructions - You must have logged in via
tsh login --auth ... --proxy ... CLUSTER. Giant Swarm users find the correct command in the intranet.
Configuration
Linkmeup requires a config file. It will look for a file called linkmeup.yaml in $HOME/.config and in the current working directory. Look at linkmeup.example.yamlfor an explanation of the format.
Giant Swarm users find the latest config in the intranet.
Installation
With Go installed, you can install the tool like this:
go install github.com/giantswarm/linkmeup@latest
Usage
Simply run linkmeup in the terminal.
Use the automatic proxy configuration address http://localhost:999/proxy.pac in your browser or operating system settings. This will instruct clients to use the proxy servers only for the specific host names configured.
Hit Ctrl + C to stop the program.
Limitations
- In some cases, linkmeup may cause the opening of several browser tabs for Teleport re-authentication. We still have to investigate if we can avoid this.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
pacserver
Package pacserver implements a simple PAC (Proxy Auto-Configuration) server.
|
Package pacserver implements a simple PAC (Proxy Auto-Configuration) server. |
|
proxy
Package proxy configures a SOCKS5 proxy that is actually an SSH tunnel.
|
Package proxy configures a SOCKS5 proxy that is actually an SSH tunnel. |
|
tshstatus
Package tshstatus provides a way to execute the `tsh status` command and get the result as structured data.
|
Package tshstatus provides a way to execute the `tsh status` command and get the result as structured data. |
|
tui
Package tui provides a terminal user interface for linkmeup.
|
Package tui provides a terminal user interface for linkmeup. |