> ## Documentation Index
> Fetch the complete documentation index at: https://tunnelfleet.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install the TunnelFleet agent on your VPS with the one-line install script.

TunnelFleet installs an agent on your VPS. The agent provisions VPN protocols, manages users, and reports status back to the dashboard.

## Requirements

| Requirement      | Details                                        |
| ---------------- | ---------------------------------------------- |
| Operating system | Ubuntu **22.04 LTS** or **24.04 LTS**          |
| Access           | Root SSH access                                |
| Network          | Public IP reachable from the internet          |
| Resources        | Enough CPU/RAM for Docker-based VPN containers |

<Tip>
  Use a fresh VPS when possible. TunnelFleet works best when it can configure Docker, firewall rules, and protocol containers without conflicting services on the same ports.
</Tip>

## Install command

When you create a server, TunnelFleet shows a unique install command:

```bash theme={null}
wget -O tunnelfleet.sh "https://tunnelfleet.com/install/YOUR_TOKEN"; bash tunnelfleet.sh
```

Run it over SSH as root:

```bash theme={null}
ssh root@YOUR_SERVER_IP
wget -O tunnelfleet.sh "https://tunnelfleet.com/install/YOUR_TOKEN"; bash tunnelfleet.sh
```

<Warning>
  Each install URL includes a one-time token for that server. Do not share it publicly. Generate a new server entry in the dashboard if the token is exposed.
</Warning>

## What the installer does

1. Registers the server with TunnelFleet
2. Installs the TunnelFleet agent
3. Pulls and starts protocol containers for your selection (WireGuard, OpenVPN TCP, OpenVPN UDP)
4. Opens required firewall ports
5. Creates the default VPN user `tunnelfleet`
6. Points a hostname at your server under `*.server.tunnelfleet.com`

## Provisioning phases

The dashboard tracks progress through:

1. **Waiting** — waiting for the install script to start
2. **Preparing** — agent and host dependencies
3. **Installing protocols** — WireGuard / OpenVPN containers
4. **Configuring firewall** — opening protocol ports
5. **Finalising** — DNS and default user

When complete, the server status becomes ready and the agent shows as online.

## Re-running or repairing

If a protocol fails or ports change:

1. Open the server → **Protocols**
2. Use **Repair** to re-run install, configure, firewall, and verify phases

You usually do not need to re-run the full host install script for protocol repairs.

## After installation

* Confirm the agent is online on the server overview
* Open **Users** to manage VPN credentials
* Open **Observe** to stream protocol logs
* Download client configs and [connect](/docs/getting-started/download-configuration)

## Uninstall / remove

To stop managing a server from TunnelFleet:

* **Archive** — stops VPN containers but keeps DNS for faster restore
* **Delete** — permanently removes the server from TunnelFleet (including DNS cleanup)

Your VPS itself is not deleted. You retain SSH access and can clean up leftover packages manually if needed.