shorttpd

Simple Http Web Server For Serving Static Files

Latest Version: 0.0.4

Demo

Usage

Customize HTML

• You can Customize Shorttpd's Design
• You can change the html under /views/*{.hbs} and /public/css/*.css.

Authorization

• If you want to use auth feature, please set USE_AUTH=yes on .env
• Please set ADMIN_USERNAME and ADMIN_PASSWORD to use admin page. Admin page let you register users and managing them.
• Please set ADMIN_PAGE_PREFIX for connecting your admin page. URI to connect to the admin page will be /{ADMIN_PAGE_PREFIX}.
• After you added the user, you can login with the user for static web server of files whatever.

From 0.0.4, uses .env file not shorttpd.conf

• It is because that the project uses NestJS from version 0.0.4, not just ExpressJS (version until 0.0.3).

env file

PORT=3080

# Use Should Login to Use Shorttpd
USE_AUTH=yes
JWT_SECRET=__jwt_secret__

# Admin Setting
ADMIN_PAGE_PREFIX=/admin
ADMIN_USERNAME=admin
ADMIN_PASSWORD=admin

# Web View Setting
# Extensions to view directly at Web Browser
WEB_VIEW_EXTENSION=json,conf,ini,png,jpeg,jpg,gif,txt
# File name or Directory name not to show on shorttpd
WEB_VIEW_EXCLUDE=@eaDir

• If you don't prepare and don't mount .env file, application won't be started.
• .env file will be mounted into /shorttpd/.env

Docker

• Set .env File
• Prepare files to share which will be mounted into /shorttpd/serve/foo/bar.
• Mount prefix path: /shorttpd/serve
• You can mount multiple files for example: -v /foo:/shorttpd/serve/foo -v /bar:/shorttpd/serve/bar ...

Run

docker run --rm -p 3080:3080 -v /shorttpd/.env:/shorttpd/.env -v /shorttpd/serve:/shorttpd/serve --name shorttpd devwhoan/shorttpd:0.0.4