Home

BloTils Documentation

Welcome to the BloTils documentation! BloTils (Blog-Utils) provides engagement tools built specifically for static sites.

What is BloTils?

Finally, engagement tools built for static sites. Drop in a script, get likes, comments, and analytics. No databases, no server config, no nonsense.

BloTils is a lightweight, self-hosted service that adds interactive features to your static blog without compromising its simplicity. Built with Go and SQLite, it's designed to be fast, privacy-friendly, and easy to deploy.

Quick Links

Section	Description
Getting Started	Quick start guide
How It Works	Architecture and flow
BloTils.js Reference	Client-side script documentation
Self-Hosting Guide	Deploy your own instance
Running Locally	Development setup
Configuration	All configuration options
API Reference	REST API documentation
Troubleshooting	Common issues and solutions

Features

Feature	Status	Description
Likes Counter	✅ Available	Privacy-friendly like system for posts
Comments	🚧 Coming Soon	Lightweight commenting system
Simple Analytics	🚧 Coming Soon	Privacy-focused page analytics
Email Subscription	🚧 Coming Soon	Newsletter subscription management
Forms	🚧 Coming Soon	Form handling for static sites
Polls	🚧 Coming Soon	Interactive polls

Quick Start

1. Add the Script to Your Blog

<button id="blotils_like_btn">❤️ Like</button>
<span class="love-count" data-blotils-count>0</span>

<script
  src="https://cdn.jsdelivr.net/gh/prinzpiuz/BloTils@v1.0.0/dist/BloTils.min.js"
  integrity="sha384-YOUR_HASH_HERE"
  crossorigin="anonymous"
  data-blotils_url="https://your-blotils-instance.com/"
  data-blotils_like_btn="blotils_like_btn">
</script>

2. Self-Host or Use Docker

docker run -d --name blotils -p 8000:8000 \
  -v ./BloTils.db:/blotils/BloTils.db \
  -v ./config.json:/blotils/config.json \
  ghcr.io/prinzpiuz/blotils:latest

See the Self-Hosting Guide for detailed instructions.

Why BloTils?

• Privacy-First: No third-party tracking, your data stays with you
• Lightweight: Minimal JavaScript footprint (~3KB minified)
• Self-Hosted: Full control over your data
• Simple Integration: One script tag, that's it
• Static-Site Friendly: Works with Hugo, Jekyll, Astro, and any static site generator

Support

• GitHub Issues - Report bugs or request features
• GitHub Discussions - Ask questions and share ideas

License

GPL-3.0 © prinzpiuz