1st version of mini HTTP server, documentation, build scripts

Author: VitSimon

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 20260206
+
+- First published version
+
+## 20260205
+
+- File introduced

Dockerfile

@@ -0,0 +1,4 @@
+FROM scratch
+COPY /main /
+EXPOSE 8080
+CMD ["/main"]

README.md

@@ -1,2 +1,54 @@
 # MiniHTTPServer
-Mini HTTP server for spinning HelpViewer quickly on local environments. Intended primarily for development purposes only, not for production deployment.
+
+Mini HTTP server for spinning HelpViewer quickly on local environments without changing standard CORS policy on browser apps. Intended primarily for development purposes only, not for production deployment.
+
+## Install
+
+1. Cloning this repository to your local machine
+2. OCI (Podman/Docker) image
+
+### Build locally
+
+This call will provide static build of source code (no external lib or binary dependencies).
+
+> CGO_ENABLED=0 \\  
+> go build -trimpath -ldflags="-s -w" -o main
+
+The same approach is used for OCI image preparation by CI/CD pipeline.
+
+### OCI image
+
+Base : **scratch**
+
+Linux systems:
+
+> podman pull ghcr.io/HelpViewer/MiniHTTPServer  
+> mkdir ./www  
+> podman run -p 80:8080 -v ./www:/www ghcr.io/HelpViewer/MiniHTTPServer  
+
+Webserver is accessible from port **80** via your browser with use of your IP for external network (inside Podman network access via container alias and port 8080).
+
+## Use with local launch
+
+1. Run:
+  - buid.bat (on Windows)
+  - buid.sh (on Linux)
+
+2. Create directory **www** on the same level as **build** script
+3. Run ./main or .\main.exe
+
+### Parameters
+
+Parameters map:  
+main --port [port] --dir [directory] --addr [IP address]
+
+| Parameter | Default | meaning |
+| --- | --- | --- |
+| **--port** | 8080 | HTTP port on which the server listens for requests |
+| **--dir** | www/ | The root directory with files to be served |
+| **--addr** | 127.0.0.1: | Binding IP address. |
+
+> [!CAUTION]
+> **--addr** parameter important notice:  
+Value: **127.0.0.1:** (default) keeps the server published only within the computer.  
+When you start the server with the value **:**, you publish the server to the connected network so that external computers can access your server.

buid.bat

@@ -0,0 +1,2 @@
+rem go build
+go build -trimpath -ldflags="-s -w" -o main.exe

buid.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+go build -trimpath -ldflags="-s -w" -o main

go.mod

@@ -0,0 +1,5 @@
+module main
+
+go 1.24.0
+
+toolchain go1.24.11

go.sum

@@ -0,0 +1,31 @@
+package main
+
+import (
+	"flag"
+	"log"
+	"net/http"
+	"os"
+	"path/filepath"
+)
+
+func main() {
+	port := flag.String("port", "8080", "Port (8080)")
+	dir := flag.String("dir", "www/", "Path (www/)")
+	addrF := flag.String("addr", "127.0.0.1:", "IPAddress (127.0.0.1:)")
+	flag.Parse()
+
+	absDir, err := filepath.Abs(*dir)
+	if err != nil {
+		log.Fatalf("File system error: %s: %v", *dir, err)
+	}
+
+	if _, err := os.Stat(absDir); os.IsNotExist(err) {
+		log.Fatalf("Dir %s missing!", absDir)
+	}
+
+	http.Handle("/", http.FileServer(http.Dir(absDir)))
+
+	addr := *addrF + *port
+	log.Printf("Running with path %s on http://%s", absDir, addr)
+	log.Fatal(http.ListenAndServe(addr, nil))
+}