Documentation

• Setup lists the prerequisites and decisions to make before installing.
• Quickstart walks the happy path from repository creation to the first deployed redirect.
• v8s.link is the official demo instance to compare against when setup values or runtime behavior differ.

Use the command line

• Command line interface explains the local helper and the lnk tool.
• LNK changes links, schedules, and source policy in custom/.
• Local helper opens existing short links from your terminal.

Customize an instance

• Customize maps the work after the first deployment.
• Brand covers wordmarks, slogans, badges, build-time branding, and public asset overrides.
• Footer & pages covers public legal and trust pages.
• Access control protects operational paths with Cloudflare Access.
• Analytics, Policy and blocklist, and Network protection cover traffic visibility and abuse controls.

Inspect exact behavior

• Reference documents files, runtime artifacts, security behavior, link formats, schedules, and upgrades.
• Repository layout shows where source, custom, generated, and Worker files live.
• Custom overrides maps instance-owned files to configuration surfaces.
• Public and status pages covers custom/public/, CSP expectations, and status-page placeholders.
• Upgrading an instance keeps an existing instance current.

Contribute to the web site

Contributor documentation for the Hugo web site now lives on the dedicated brand site: brand.vanityurls.link/web-site/.