SERVEIT - Dead-simple Web Server

SERVEIT is a very simple web server. It serves all files from a specified directory on port 4000. It is intended to be run in a container, hence the almost complete lack of configurability.

RUNNING

To run SERVEIT in its container, mount a directory to serve to /app/web and publish the container's port 4000:

docker run <options> \
    --volume $PWD/web:/app/web \
    --publish 4000:4000 \
    gcr.io/o-p-n/serveit:<TAG>

IMAGES

Releases can be found at the serveit container package. Generally, each release is tagged with its corresponding git commit hash. There is no latest tag, currently.

The following platforms are supported:

• linux/amd64
• linux/arm64

CONFIGURING

SERVEIT can be configuring via environment variables:

DEVELOPING

PREREQUISITES

To build serveit locally, the following tools must be available in your PATH:

• Deno, v2.0.0 or later
• Crane v0.19.0 or later
• Task, v3.30.0 or later
• Docker, v25 or later

It is possible to obtain most of these (excluding Docker) using an installer script for most of these dependencies (plus others needed by GitHub Actions for publishing and distritubing). By default the script installs tools in ${HOME}/bin.

In addition, git hooks are managed using Lefthook. It currently has the following hooks:

• pre-push — runs code styling checks (linting and format-checking)

WORKING COPY

This repository uses git modules for some build instructions. Be sure to clone with recursive submodules to have all the necessary files:

git clone --recurse-submodules https://github.com/o-p-n/serveit

TESTING

Run task test to execute all unit-tests. Run task cover to generate code coverage reports (including HTML); coverage reports are stored in ./coverage/html in your working copy.

BUILDING IMAGES

Run task image to build the container image. This is a multi-arch image, with both linux/amd64 and linux/arm64.