Awesome

Feserve

GitHub Workflow Status Release

Feserve is a lightweight application created to make it easier for Frontend Developers to deploy their applications, without having to use Nginx, Node.js or the like which take up a lot of storage space.

Feature

Serve static files
Custom url path to file
Load balancer (HTTP)
Generate SSL certificate and auto renew (Let's Encrypt)

Installation

Binary File

Here I use linux with amd64 architecture as an example. Please adjust to your OS and Architecture here. Then download, verify the signature, and extract it like the following example.

wget https://github.com/ryanbekhen/feserve/releases/download/v0.1.0/feserve_0.1.0_linux_amd64.zip
wget https://github.com/ryanbekhen/feserve/releases/download/v0.1.0/checksums.txt
unzip feserve_0.1.0_linux_amd64.zip 
sha256sum --ignore-missing -c checksums.txt

After running the above command, move the binary file to /usr/local/bin with the following command.

sudo mv feserve /usr/local/bin

# permission for 80/443
sudo setcap 'cap_net_bind_service=+ep' ./usr/local/bin

Via `go install`

go install github.com/ryanbekhen/feserve

Note: go version go1.19.5 or later

Setup

Directory Structure

root-directory/
|- build/
|- app.yaml

Configuration `app.yaml`

version: 1
port: 8000
publicDir: build

With the above configuration, feserve will run on port 8000 and public/ as its public directory. To see more details here.

Usage

Local

To run it locally, just run feserve in your root directory with the following command.

feserve

Then open a browser at http://localhost:8000.

Docker

Before running the command below, first create the app.yaml config file.

docker run --name feserve -d \
  -p 80:80 \
  -p 443:443 \
  -v $(pwd)/certs:/certs \
  -v $(pwd)/app.yaml:/app.yaml \
  ghcr.io/ryanbekhen/feserve:latest

Dockerfile

To run it within docker, create a file Dockerfile like the following example.

# application build
FROM node:16-alpine As build
WORKDIR /app
COPY . .
RUN npm ci 
RUN npm run build
ENV NODE_ENV production

# application serve
FROM ghcr.io/ryanbekhen/feserve:latest
WORKDIR /app
COPY app.yaml .
COPY --from=build /app/build /app/build
EXPOSE 8000
ENTRYPOINT ["feserve"]

It can also be done in the following way if we have built it first.

FROM ghcr.io/ryanbekhen/feserve:latest
WORKDIR /app
COPY app.yaml .
COPY build ./build
EXPOSE 8000
ENTRYPOINT ["feserve"]

To try to run it simply with the following command.

docker build -t image-name .
docker run --rm -p 8000:8000 image-name