FOSSBilling Documentation

This repository contains the official documentation for FOSSBilling, built with Starlight (Astro).

Development

npm install
npm run dev

The site will be available at http://localhost:4321.

Before opening a PR, run:

npm run format
npm run check
npm run build

Commands

Command	Action
npm install	Install dependencies
npm run dev	Start local dev server at localhost:4321
npm run check	Run Astro checks against the project
npm run build	Build the production site to ./dist/
npm run preview	Preview the build locally before deploying
npm run format	Format Astro, CSS, TS, JS, and JSON files
npm run format:check	Verify formatting without writing changes

For Cloudflare deployments with Wrangler, run npm run build first so ./dist/ exists before wrangler deploy.

Pull requests to main are also validated in CI with formatting checks, astro check, and a production build.

Structure

src/
├── content/
│   └── docs/          # Documentation pages (MDX/Markdown)
└── assets/            # Static assets
public/
└── img/               # Images referenced in documentation

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

Licensing

Code, configuration, and build tooling in this repository are licensed under the GNU Affero General Public License v3.0 or later. See LICENSE.

Documentation content is licensed under Creative Commons Attribution-ShareAlike 4.0 International. See LICENSE-docs.

Unless otherwise noted, the documentation license applies to:

• src/content/docs/**
• src/assets/**
• public/img/docs/**
• public/img/guides/**

Logos, wordmarks, trademarks, and other brand assets are not licensed under CC BY-SA 4.0. Third-party marks remain subject to their respective owners' rights, including assets under public/img/logos/**.

Links

• FOSSBilling GitHub
• Starlight Documentation
• Astro Documentation