Skip to content

tschaefer/finch-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentation: Finch - The Minimal Observability Infrastructure

Technical documentation for Finch, a minimal, self-hosted observability stack that provides logs, metrics, and profiling out of the box with secure agent enrolment handled by finchctl.

Repositories

Repository Description
tschaefer/finch Finch service - gRPC backend, agent management, mTLS auth
tschaefer/finchctl CLI controller - stack deployment, agent enrolment, token management
tschaefer/finch-docs This repository - Zensical documentation site

Documentation

The documentation is published at https://tschaefer.github.io/finch-docs/ and covers:

  • Stack overview and architecture
  • Deployment workflow and TLS options
  • Finch service internals (agent management, authentication, dashboard)
  • Agent configuration and token renewal
  • Security model
  • CLI reference
  • Step-by-step tutorials

Building locally

Clone the documentation repository

git clone https://github.com/tschaefer/finch-docs
cd finch-docs

Set up a Python virtual environment

python3 -m venv venv
source venv/bin/activate

Install Zensical

pip install zensical

Build or serve the documentation locally

zensical build --clean
zensical serve

About

The Minimal Observability Infrastructure

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Contributors