omnidex

omnidex

Centralized documentation portal for your repos. Omnidex aggregates markdown documentation from GitHub repositories and serves it through a searchable web portal.

Prerequisites

• Go 1.24+ — for building from source
• Docker and Docker Compose — for the containerized development environment
• Tailwind CSS CLI — for frontend development (npm install -g tailwindcss or standalone binary)

Quick Start

The fastest way to get Omnidex running locally is with Docker Compose:

# Clone the repository
git clone https://github.com/ksysoev/omnidex.git
cd omnidex

# Start Omnidex (automatically seeds sample documentation)
make up

After startup, sample documentation is automatically published and the portal is ready at http://localhost:8080. To re-seed the sample docs (e.g., after editing them), run make seed.

To stop the environment:

make down

All configuration has sensible defaults baked into docker-compose.yml. To override any value, export the corresponding environment variable before running make up:

API_API_KEYS=my-secret-key make up

Configuration

Omnidex is configured via a YAML file and/or environment variables. Environment variables take precedence over the config file.

See .env.example for a quick reference of all available variables. The docker-compose.yml includes reasonable defaults so no .env file is required for local development. Note that Docker Compose uses different default paths (/data/docs and /data/search) than the local runtime config shown above.

Development

Building from Source

# Build the binary
make build

# Or manually with ldflags
CGO_ENABLED=0 go build -o omnidex -ldflags "-X main.version=dev -X main.name=omnidex" ./cmd/omnidex/main.go

Running Locally (without Docker)

# Create data directories
mkdir -p data/repos data

# Build Tailwind CSS
make tailwind

# Run the server
make run

This uses the development config at runtime/config.yml.

Installing via Go

go install github.com/ksysoev/omnidex/cmd/omnidex@latest

Frontend Development

To watch and rebuild Tailwind CSS on changes:

make dev-css

Publishing Docs

Using the Ingest API

Send documentation to a running Omnidex instance via the REST API:

curl -X POST http://localhost:8080/api/v1/docs \
  -H "Authorization: Bearer changeme" \
  -H "Content-Type: application/json" \
  -d '{
    "repo": "myorg/myrepo",
    "commit_sha": "abc123",
    "documents": [
      {
        "path": "getting-started.md",
        "content": "# Hello\n\nYour markdown content here.",
        "action": "upsert"
      }
    ]
  }'

Using the GitHub Action

Add the Omnidex publish action to your repository's CI workflow:

- uses: ksysoev/omnidex/action@main
  with:
    omnidex_url: https://docs.example.com
    api_key: ${{ secrets.OMNIDEX_API_KEY }}
    docs_path: docs

This will publish all markdown files from the docs directory on every push.

Tip: For production workflows, pin the action to a specific version tag (e.g. @v1) or commit SHA instead of @main to avoid unexpected changes.

Testing

# Run unit tests with race detector
make test

# Run linter
make lint

# Generate mocks
make mocks

Project Structure

cmd/omnidex/          Application entrypoint (main.go)
pkg/
  cmd/                CLI initialization, config loading, dependency wiring
  api/                HTTP server, routing, handlers
    middleware/        Authentication, request ID middleware
  core/               Business logic, domain types, service layer
  repo/
    docstore/         Filesystem-based document storage
    search/           Full-text search engine (Bleve)
  prov/
    markdown/         Markdown rendering and processing (goldmark)
  views/              HTML template rendering (Go templates + HTMX)
action/               GitHub Action for publishing docs
docs/sample/          Sample documentation for local development
scripts/              Development utility scripts
static/               Static assets (CSS, JavaScript)
runtime/              Development configuration files

License

omnidex is licensed under the MIT License. See the LICENSE file for more details.