Add Docker build script and README

Multi-stage Dockerfile runs the tests, builds a static binary, and ships
it on Alpine with git for GitHub clones.
This commit is contained in:
Andy Dixon
2026-02-01 21:48:24 +00:00
parent 59d7e99e0b
commit 981ec88f43
4 changed files with 53 additions and 0 deletions
+4
View File
@@ -0,0 +1,4 @@
*
!go.mod
!*.go
!web
+17
View File
@@ -0,0 +1,17 @@
FROM golang:1.26-alpine AS build
WORKDIR /src
COPY go.mod ./
COPY *.go ./
COPY web ./web
RUN CGO_ENABLED=0 go test ./... \
&& CGO_ENABLED=0 go build -trimpath -ldflags="-s -w" -o /codenavigator .
FROM alpine:3.22
# git is needed at runtime to clone GitHub repositories.
RUN apk add --no-cache git ca-certificates && adduser -D -H app
COPY --from=build /codenavigator /usr/local/bin/codenavigator
USER app
ENV PORT=4177
EXPOSE 4177
HEALTHCHECK CMD wget -qO- http://127.0.0.1:$PORT/api/health || exit 1
ENTRYPOINT ["codenavigator"]
+24
View File
@@ -0,0 +1,24 @@
# CodeNavigator
A single binary that serves the WebGL frontend and the
indexing API (jobs, SSE progress, snapshots, search, source) on one origin.
No dependencies beyond the Go standard library.
```bash
go run . # http://127.0.0.1:4177
go test -race ./...
go test -run x -bench Index # indexes $CODENAV_BENCH_DIR (default: Go's stdlib source)
./build.sh [tag] # Docker image, tests run during the build
docker run --rm -p 4177:4177 codenavigator:latest
```
Configuration: `PORT` (default `4177`, or `--port`), `CORS_ORIGIN` (default `*`).
`git` must be on `PATH` to load GitHub repositories (the image includes it).
The browser frontend in `web/` is plain JavaScript (it has to run in the browser) and
is embedded into the binary; `web/config.js` points it at the same origin.
Notes:
- `GET /` serves the frontend instead of a JSON service description.
- Search queries are percent-decoded properly.
- `.gitignore` support covers standard globs but not global excludes or `.git/info/exclude`.
Executable
+8
View File
@@ -0,0 +1,8 @@
#!/bin/sh
# Builds the CodeNavigator Docker image (tests run inside the build).
# Usage: ./build.sh [image-tag] default tag: codenavigator:latest
set -eu
cd "$(dirname "$0")"
tag="${1:-codenavigator:latest}"
docker build -t "$tag" .
echo "Built $tag. Run: docker run --rm -p 4177:4177 $tag"