> A start page for your homelab. Your links with a live up/down dot, the weather and your server’s vitals on top, and a new tab extension to open it everywhere.
> Source: https://orochibraru.com/bercail/docs · Site index: https://orochibraru.com/llms.txt

# Bercail documentation

A start page for your homelab. Your links with a live up/down dot, the weather and your server’s vitals on top, and a new tab extension to open it everywhere.

The Markdown in [the project repo](https://github.com/orochibraru/bercail/tree/main/docs) is the source of truth;
these pages are generated from it.

- [Bercail](https://orochibraru.com/bercail/docs/readme.md): A self-hosted start page for your homelab. It shows the weather and your server's vitals at the top, and your links below, each with a live online/offline…
- [Installation](https://orochibraru.com/bercail/docs/installation.md): Data lives in a SQLite file under /app/data. Database migrations run automatically on startup.
- [Configuration](https://orochibraru.com/bercail/docs/configuration.md): Everything is optional. For local development, copy .env.example to .env.
- [Features](https://orochibraru.com/bercail/docs/features.md): The page refreshes its stats every 5 seconds. Drag a section by the grip in its left margin to reorder the dashboard; the order is saved on the server.
- [Weather location](https://orochibraru.com/bercail/docs/weather.md): The first of these that is set wins:
- [Sign-in](https://orochibraru.com/bercail/docs/sign-in.md): Without OIDCISSUER the app is open to anyone who can reach it. With it, every page asks for a sign-in through your provider (Pocket ID, Authentik, Authelia…
- [Host metrics](https://orochibraru.com/bercail/docs/host-metrics.md): A metric that can't be read shows N/A without affecting the others.
- [New tab extension](https://orochibraru.com/bercail/docs/extension.md): The extension in extension/ shows your Bercail instance on every new tab.
- [Development](https://orochibraru.com/bercail/docs/development.md): Requires Bun. prek comes in as a dev dependency.
- [Releases](https://orochibraru.com/bercail/docs/releases.md): Every merge to main goes through releaser. A feat, fix, perf, refactor or docs commit cuts a patch release: it updates CHANGELOG.md, tags vX.Y.Z, creates the…
