Introduction on ownscale Documentation

Getting Started

Mon, 01 Jan 0001 00:00:00 +0000

Getting Started#

Welcome to the ownscale documentation.

ownscale is a self-hosted control plane and web console for Headscale, an open-source implementation of the Tailscale coordination server. This section covers the core concepts you’ll run into once ownscale is installed; head to Installation first if you haven’t deployed it yet.

Organizations#

Each organization is an independent tailnet, backed by its own Headscale instance and reachable at its own subdomain (e.g. acme.<base_domain>). Users, machines, ACLs, and DNS settings are all scoped to a single organization.

Installation

Mon, 01 Jan 0001 00:00:00 +0000

Installation#

ownscale ships as a Docker Compose stack: an ownscale container (the console + API + per-organization Headscale management), a caddy container (TLS termination and reverse proxying for the console, this documentation site, and every organization’s subdomain), and one Headscale container per organization it provisions.

Prerequisites#

Docker and Docker Compose, running on the host that will serve traffic.
A domain you control, with a wildcard DNS record (*.example.com) pointing at this host. Each organization and Funnel gets its own subdomain (e.g. acme.example.com, console.example.com), so a single A/AAAA record per host isn’t enough.
- For local development, use a private, RFC 2606-reserved TLD like ownscale.test instead of a real domain – see Local development below.
An OIDC identity provider to authenticate against (Google, Okta, a self-hosted Dex instance, or any standard OIDC issuer). ownscale federates login to it rather than managing passwords itself.

Quick start#

git clone https://github.com/ownscalenet/ownscale.git
cd ownscale
cp .env.example .env # edit BASE_DOMAIN, OWNSCALE_AUTH_*, etc. -- see below
docker compose up -d --build

Once the stack is up, sign in at https://console.<base_domain>/login and create your first organization from the console.

FAQs

Mon, 01 Jan 0001 00:00:00 +0000

FAQs#

Funnel machine#

When creating a funnel, ownscale will automatically create a new user and a new machine. These will show up in your listings marked as internal resources.