Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cterence/tailout
Spawn an exit node for your tailnet anywhere
https://github.com/cterence/tailout
aws cli golang tailscale vpn wireguard
Last synced: 1 day ago
JSON representation
Spawn an exit node for your tailnet anywhere
- Host: GitHub
- URL: https://github.com/cterence/tailout
- Owner: cterence
- License: apache-2.0
- Created: 2023-05-29T14:13:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-23T21:11:47.000Z (17 days ago)
- Last Synced: 2024-10-24T09:22:11.908Z (17 days ago)
- Topics: aws, cli, golang, tailscale, vpn, wireguard
- Language: Go
- Homepage:
- Size: 872 KB
- Stars: 25
- Watchers: 5
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tailout
`tailout` is a command-line tool for quickly creating a cloud-based exit node in your tailnet.
## Installation
To install `tailout`, you can download the latest release from the [releases page](https://github.com/cterence/tailout/releases).
You can also use the `go install` command:
```bash
go install github.com/cterence/tailout@latest
```
## Prerequisites
To use `tailout`, you'll need to have the following installed:
- [Tailscale](https://tailscale.com/)
- An AWS account
At the moment, `tailout` only supports AWS as a cloud provider. Support for other cloud providers will be added in the future.
## Setup
Go to your [Tailscale API key settings](https://login.tailscale.com/admin/settings/keys) and:
- Create an API key for `tailout`
- Create a file in `~/.tailout/config.yaml` with the following content:
```yaml
tailscale:
api_key: tskey-api-xxx-xxx
tailnet:
```
- Run `tailout init`, review the changes that will be done to your policy and accept
- Go back to your [Tailscale API key settings](https://login.tailscale.com/admin/settings/keys)
- Create an auth key with the following characteristics:
- Is reusable
- Is ephemeral
- Automatically adds the newly created `tag:tailout` tag to each device
- Add your auth key to the config file
Next, you will also need to set up your AWS credentials. tailout will look for default credentials, like environment variables for access keys or an AWS profile.
To easily check if your credentials are set up correctly, you can use the `aws sts get-caller-identity` command.
## Usage
Create an exit node in your tailnet:
```bash
tailout create
```
Connect to your exit node:
```bash
tailout connect
```
Get the status of your exit node:
```bash
tailout status
```
Disconnect from your exit node:
```bash
tailout disconnect
```
Delete your exit node:
```bash
tailout stop
```
## Configuration
`tailout` will look for a configuration file at the following paths:
- `/etc/tailout/config.{yml,yaml,hcl,json,toml}`
- `$HOME/.tailout/config.{yml,yaml,hcl,json,toml}`
For exemple, you could have this content in `/etc/tailout/config.yml`:
```yaml
tailscale:
api_key: tskey-api-xxx-xxx
auth_key: tskey-auth-xxx-xxx
tailnet:
region: eu-west-3
create:
shutdown: 15m
```
You can specify any of the above settings as command-line flags or environment variables prefixed by `TAILOUT_`.
For example, to specify the Tailscale API key, you can use the `--tailscale-api-key` flag or the `TAILOUT_TAILSCALE_API_KEY` environment variable.