tailout

KO | EN

gitlite — search

#hacktoberfest #typescript #golang #android #machine-learning #rust #deep-learning #linux #nodejs #awesome #kubernetes #vue #ios #mcp

(★ 41)

Spawn an exit node for your tailscale network anywhere

tailout Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![CI](https://github.com/cterence/tailout/actions/workflows/ci.yaml/badge.svg)](https://github.com/cterence/tailout/actions/workflows/ci.yaml)
[![Go Report Card](https://goreportcard.com/badge/github.com/cterence/tailout)](https://goreportcard.com/report/github.com/cterence/tailout)

# tailout

`tailout` is a command-line tool for quickly creating a cloud-based exit node in your tailnet.

![demo gif](https://raw.githubusercontent.com/cterence/tailout/main/docs/demo.gif)

## 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: <your tailnet name>
  ```
- 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: <your tailnet name>
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.

tailout

tailout Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

tailout

tailout Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README