Skip to content

Latest commit

 

History

6 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

slimTDS Documentation

Astro + Starlight documentation site for slimTDS — a self-hosted traffic distribution system built on Slim 4, FrankenPHP and PostgreSQL 18.

Published at https://slimtds.com/docs (English) and https://slimtds.com/docs/ru (Russian). Both locales are complete; defaultLocale is root, so English pages carry no language prefix.

Develop

bun install
bun run dev      # http://localhost:4321/docs
bun run build    # → dist/

The site is built with base: '/docs', so it is served from a sub-path rather than a domain root.

Build-time configuration

Variable Default Purpose
PUBLIC_SITE_URL https://slimtds.com Canonical origin used for sitemap and <link rel="canonical">
PUBLIC_PIXEL_SRC (unset) Optional analytics / session-recorder script URL. When unset, no third-party script tag is emitted
DOCS_VERSION (unset — badge hidden) Version badge next to the site title

PUBLIC_PIXEL_SRC is deliberately empty by default: a plain bun run build produces a site that contacts no external analytics endpoint.

Screenshots

src/assets/screenshots/ is captured against a seeded slimTDS instance:

ADMIN_PASSWORD=<password> bun run screenshots

Deploy

dist/ is a static bundle — copy it to whatever serves /docs. It carries no server runtime and no build step on the target host.

License

AGPL-3.0-or-later, matching slimTDS itself. See LICENSE.

About

Documentation site for slimTDS (Astro + Starlight, EN + RU) — served at slimtds.com/docs

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages