Skip to content
This repository has been archived by the owner on Oct 7, 2023. It is now read-only.

Commit

Permalink
readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
markpash committed Dec 18, 2021
1 parent 77c3814 commit bf15a75
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# tailscale-sidecar

[![Publish docker image](https://github.com/markpash/tailscale-sidecar/actions/workflows/push-image.yml/badge.svg)](https://github.com/markpash/tailscale-sidecar/actions/workflows/push-image.yml)

This is barely tested software, I don't guarantee it works but please make an issue if you use it and find a bug. Pull requests are welcome.
[![checks](https://github.com/markpash/tailscale-sidecar/actions/workflows/checks.yml/badge.svg)](https://github.com/markpash/tailscale-sidecar/actions/workflows/checks.yml)

This program is designed to expose services onto a tailscale network without needing root. Using the `tsnet` package provided by tailscale, we can listen on a port on a tailscale IP and then proxy the stream to a destination. The use-case for me was running this as a sidecar container in nomad to expose services onto my tailscale network, without needing root or routing.

Expand All @@ -14,6 +12,8 @@ Docker image available:
docker pull ghcr.io/markpash/tailscale-sidecar:latest
```

Versions of this software track the versions of upstream tailscale. Any features added to this software will be released when the next version of tailscale is released.

## Usage

To use this program, it needs to be executed with a few environment variables. They are as follows:
Expand Down

0 comments on commit bf15a75

Please sign in to comment.