livegrep-indexer

packaged by Chainguard

Chainguard Container for livegrep-indexer

Livegrep is a tool for interactive regex search of source code repositories.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/livegrep-indexer:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Image Variants

This module provides two container images:

Compatibility Notes

These images are compatible with the upstream livegrep Docker images.

• Images run as nonroot (UID 65532) instead of root

Getting Started

Livegrep operates in three stages:

1. Index: Create a search index from source code repositories
2. Backend: Run the codesearch server to serve search queries via gRPC
3. Frontend: Run the livegrep web server to provide the search UI

Step 1: Create a Search Index

First, create a configuration file describing the repositories to index:

mkdir -p /tmp/livegrep-data
cat > /tmp/livegrep-data/config.json << 'EOF'
{
  "name": "my-index",
  "fs_paths": [
    {"name": "my-repo", "path": "/data/repo"}
  ]
}
EOF

Clone or copy a repository to index:

git clone --depth 1 https://github.com/livegrep/livegrep /tmp/livegrep-data/repo

Build the index using the indexer image:

docker run --rm \
  -v /tmp/livegrep-data:/data \
  cgr.dev/ORGANIZATION/livegrep-indexer:latest \
  -index_only \
  -dump_index /data/index.idx \
  /data/config.json

Step 2: Start the Backend Server

Run the codesearch backend server to load the index and serve search queries:

docker run -d --name livegrep-backend \
  -v /tmp/livegrep-data:/data \
  -p 9999:9999 \
  cgr.dev/ORGANIZATION/livegrep:latest \
  -load_index /data/index.idx \
  -grpc 0.0.0.0:9999

Step 3: Start the Web Frontend

Run the livegrep frontend to provide the web UI:

docker run -d --name livegrep-frontend \
  --link livegrep-backend:backend \
  -p 8910:8910 \
  --entrypoint /usr/bin/livegrep \
  cgr.dev/ORGANIZATION/livegrep:latest \
  -docroot /livegrep/web \
  -listen 0.0.0.0:8910 \
  --connect backend:9999

Step 4: Access the Web UI

Open your browser to http://localhost:8910 to access the livegrep search interface.

Using Docker Compose

For convenience, here is a Docker Compose configuration:

version: '3.8'
services:
  backend:
    image: cgr.dev/ORGANIZATION/livegrep:latest
    volumes:
      - ./data:/data
    command:
      - -load_index
      - /data/index.idx
      - -grpc
      - 0.0.0.0:9999
    expose:
      - "9999"

  frontend:
    image: cgr.dev/ORGANIZATION/livegrep:latest
    entrypoint: /usr/bin/livegrep
    command:
      - -docroot
      - /livegrep/web
      - -listen
      - 0.0.0.0:8910
      - --connect
      - backend:9999
    ports:
      - "8910:8910"
    depends_on:
      - backend

Indexing GitHub Repositories

The livegrep-indexer image includes livegrep-github-reindex for indexing GitHub repositories:

docker run --rm \
  -v /tmp/livegrep-data:/data \
  --entrypoint /usr/bin/livegrep-github-reindex \
  cgr.dev/ORGANIZATION/livegrep-indexer:latest \
  -repo owner/repo \
  -http \
  -dir /data

Documentation and Resources

• Livegrep GitHub Repository
• Livegrep Documentation

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.