Getting Started with tug.sh

Welcome to the official tug.sh documentation! This guide will walk you through your first steps on our platform, from connecting your own VPS server to deploying your first application.

What is tug.sh?

tug.sh is a modern, agent-based container management platform designed for developers who want full control over their VPS (Virtual Private Server) machines while enjoying the convenience of PaaS solutions.

Unlike complex Kubernetes clusters, tug.sh relies on simple and stable Docker mechanisms, controlled from a central dashboard via a lightweight Agent.

Prerequisites

Before you begin, ensure you have:

• An account on the tug.sh dashboard.
• A VPS server with a public IP address.
• Docker installed on the target server.
• SSH access to the server as the root user.

Installing the Agent

The tug.sh Agent is a lightweight program written in Go that runs as a systemd daemon. It maintains a persistent WebSocket (WSS) connection to our main cluster using an HMAC token.

In the dashboard, click the Connect VPS button, generate your installation command, and run it on your server:

curl -sSL https://tug.sh/install.sh | bash -s -- --token TUG_YOUR_SECRET_TOKEN

After a successful installation, the Agent will register the machine, and it will appear in your Dashboard as Running. From that point on, you can securely manage containers directly from your browser!