Sign inSign up

flushy/bible-api

By flushy

•Updated 8 months ago

Fast, light Go/SQLite Bible API. Access multiple translations via Scrollmapper’s databases.

Image
Web servers
0

250

flushy/bible-api repository overview

A high-performance, memory-efficient Bible API built with Go and SQLite.

This image provides a streamlined way to query scripture across multiple translations, utilizing optimized data from Scrollmapper’s Bible Databases.

Key Features Small Footprint: Multi-stage Docker build ensures the image contains only the Go binary and indexed .db files—no bulky CSV source files.

Fast Search: Implements COLLATE NOCASE indexing for rapid, case-insensitive keyword searching.

RESTful Design: Fully compliant with OpenAPI 3.0 specifications.

Cloudflare Ready: Includes built-in healthchecks for seamless integration with cloudflared tunnels.

Quick Start Bash docker pull flushy/bible-api:latest docker run -p 8080:8080 flushy/bible-api 🔍 Search for Verses Find specific keywords across any installed translation. The search is case-insensitive and supports pagination. GET /v1/translations/kjv/search?q=faith&limit=5&offset=0

⚖️ Compare Translations Compare a specific verse across multiple versions (e.g., KJV and WEB) in a single request. GET /v1/compare/verses?versions=kjv,web&book=John&chapter=3&verse=16

📅 Verse of the Day Get a random inspirational verse from your preferred translation. GET /v1/translations/kjv/verse-of-the-day

Deployment with Cloudflare Tunnel To run this securely behind a Cloudflare Tunnel as defined in your docker-compose.yaml, use the following environment variable:

Bash export CLOUDFLARE_TUNNEL_TOKEN=your_token_here docker compose up -d Note on Data: This image is self-contained. All .db files are indexed and stored internally at

Tag summary

Content type

Image

Digest

sha256:ec4163db3…

Size

421.5 MB

Last updated

8 months ago

docker pull flushy/bible-api