You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Jake Howard b86b542998
Document the index file
3 years ago
.circleci Build container on CI 3 years ago
scripts Update test dependencies 3 years ago
site Add additional demo file 3 years ago
src Add more type definitions from types 3 years ago
tests Swap out linter 3 years ago
.gitignore Setup typescript basics 4 years ago
.npmignore Ignore more things 4 years ago
Dockerfile Move install location to `/opt` and install globally 3 years ago
README.md Document the index file 3 years ago
package-lock.json Release 1.2.0 3 years ago
package.json Correct prepublish script 3 years ago
tsconfig.json Replace typings with @types 3 years ago
tslint.json Swap out linter 3 years ago

README.md

tstatic

CircleCI npm npm

The only static-file server you'll ever need!

Features:

Usage

  tstatic <dir> [options]

  -h --help     Show this screen.
  --version     Show version.
  -p <port> --port=<port>  Port to listen on.
  -b <auth> --basic-auth=<auth>   Enable basic-auth.
  -i <ips> --ips=<ips>  Allowed IP addresses.
  -l --list-dir  List Directory.
  -o --open  Open in browser after start.

dir is where your static files are.

404 errors will return with <dir>/.404.html, with status code 404. If this file doesnt exist, the default error page will be shown.

Configuration

port

The port for the server to listen on. Currently supports plain HTTP only

basic-auth

Enable basic-auth for all paths. Currently only supports single credentals.

Format:-b username:password

ips

IP addresses that are allowed to connect to the server.

Format: -i 192.168.1.100,192.168.1.101

list-dir

Enables directory listing. Allow browseing

open

Open the server in the browser one started. It will open in your default browser, and use url http://0.0.0.0:<port>.

Docker

Included in this repo is a Dockerfile to use. The default setup requires being run from the project directory, and will serve /var/www in the container on port 5000. By default, this directory is contains a simple index file, however can be overriden.

Below is an example docker-compose.yml file you can use with it:

version: "2"
services:
  tstatic:
    image: "tstatic"
    build:
        context: .
        dockerfile: Dockerfile
    volumes:
        - ./site/:/var/www
    ports:
        - "5000:5000"