Initial commit

Author: auravoid

.dockerignore

@@ -0,0 +1,25 @@
+# Git
+.git
+.gitignore
+
+# CI/CD
+.github
+
+# Documentation
+README.md
+
+# Data files
+*.db
+data/
+
+# Docker files
+Dockerfile
+docker-compose.yml
+.dockerignore
+
+# Environment files (contains secrets)
+.env
+
+# OS generated files
+.DS_Store
+Thumbs.db

.github/workflows/docker-image.yml

@@ -0,0 +1,65 @@
+name: Docker Image CI
+
+on:
+  push:
+    branches: [ "main" ]
+    tags: [ 'v*.*.*' ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install cosign
+        if: github.event_name != 'pull_request'
+        uses: sigstore/cosign-installer@v3.5.0
+        with:
+          cosign-release: 'v2.2.4'
+          
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log into registry ${{ env.REGISTRY }}
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=raw,value=latest,enable={{is_default_branch}}
+            type=sha
+            type=ref,event=branch
+            type=ref,event=pr
+
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.gitignore

@@ -0,0 +1,37 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (uncomment if using dep)
+# vendor/
+
+# Go workspace file
+go.work
+
+# Binaries
+/bin/
+/dist/
+
+# Database files
+*.db
+data/
+
+# IDE files
+.vscode/
+.idea/
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Environment files
+.env

Dockerfile

@@ -0,0 +1,22 @@
+FROM golang:1.24-alpine AS builder
+
+WORKDIR /app
+
+COPY go.mod go.sum ./
+RUN go mod download
+COPY . .
+
+RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o short-it ./cmd/short-it
+FROM alpine:latest
+
+RUN apk --no-cache add ca-certificates
+
+WORKDIR /root/
+
+COPY --from=builder /app/short-it .
+RUN mkdir -p /data
+
+EXPOSE 8080
+ENV DB_PATH=/data/short-it.db
+
+CMD ["./short-it"] 

README.md

@@ -0,0 +1,114 @@
+# short-it
+
+A minimal, self-hosted URL shortener written in Go using bbolt (BoltDB). This project is inspired by [Erisa's worker-links](https://github.com/Erisa/worker-links). I wanted something that can do functionally the same as that project, without being fully locked into Cloudflare's services.
+
+## Features
+
+- Shorten URLs with autogenerated 6-character keys
+- Create custom paths
+- List stored URLs with cursor-based pagination
+- Simple token-based authorization
+- Single-file embedded database (bbolt)
+
+## Quick Start
+
+Prerequisites: Go 1.24 or Docker.
+
+Run locally:
+
+```bash
+go build -o short-it ./cmd/short-it
+APP_TOKEN=your-secret-token DB_PATH=short-it.db PORT=8080 ./short-it
+```
+
+Run with Docker:
+
+```bash
+docker build -t short-it .
+docker run -e APP_TOKEN=your-secret-token -p 8080:8080 -v $(pwd)/data:/data short-it
+```
+
+Or use the provided docker-compose configuration:
+
+```bash
+docker-compose up -d
+# edit docker-compose.yml to set APP_TOKEN or update the environment
+```
+
+The server listens on `PORT` (default `8080`) and stores the BoltDB file at `DB_PATH` (default `short-it.db`).
+
+## Configuration
+
+Environment variables:
+
+- `APP_TOKEN` (required): token used for authorization on protected endpoints
+- `PORT` (optional): HTTP port (default `8080`)
+- `DB_PATH` (optional): path to BoltDB file (default `short-it.db`)
+
+## HTTP API
+
+All endpoints that modify or list data require the `Authorization` header to equal the `APP_TOKEN` value.
+
+- Create a short URL
+	- `POST /`
+	- Headers: `Authorization`, `URL` (or JSON body `{ "url": "..." }`)
+	- Response: `{"key":"<generated-key>"}`
+
+- List URLs (paginated)
+	- `GET /`
+	- Headers: `Authorization`, optional `Cursor`, optional `Limit` (max 100)
+	- Response: `{ "items": [{"key":"...","value":"..."}], "next":"<cursor>" }`
+
+- Redirect
+	- `GET /{key}`
+	- Redirects (302) to the stored URL if found
+
+- Create/Update custom path
+	- `PUT /{path}`
+	- Headers: `Authorization`, `URL` (or JSON body)
+	- Response: `201 Created`
+
+- Delete path
+	- `DELETE /{path}`
+	- Headers: `Authorization`
+	- Response: `204 No Content`
+
+Examples:
+
+```bash
+# shorten a URL (using header)
+curl -X POST -H "Authorization: your-secret-token" -H "URL: https://example.com" http://localhost:8080/
+
+# get redirect
+curl -v http://localhost:8080/:key
+
+# create custom path
+curl -X PUT -H "Authorization: your-secret-token" -H "URL: https://custom.example" http://localhost:8080/custom
+
+# delete
+curl -X DELETE -H "Authorization: your-secret-token" http://localhost:8080/custom
+
+# list
+curl -H "Authorization: your-secret-token" http://localhost:8080/
+```
+
+## Development & Tests
+
+Run unit tests:
+
+```bash
+go test ./cmd/short-it
+```
+
+Key implementation files:
+
+- [cmd/short-it/main.go](cmd/short-it/main.go#L1) — HTTP handlers and core logic
+- [cmd/short-it/main_test.go](cmd/short-it/main_test.go#L1) — unit tests for handlers and DB ops
+- [Dockerfile](Dockerfile) — container build
+- [docker-compose.yml](docker-compose.yml) — example compose configuration
+
+## Notes
+
+- The app uses a BoltDB bucket named `urls` to store key → URL mappings.
+- The autogenerated keys are 6 characters drawn from `a-zA-Z0-9`.
+