miniws/README.md

miniws

miniws (minimal web server) is a very simple web server written in golang. its purpose is to be lightweight, easy to configure and easily expandable for personal use.

all the help you'll ever need is in this README, and in the help text (miniws -h). there is no other documentation you have to read.

command line arguments

  -h  --help           Print help information
  -s  --signal         runs the executable in command mode, meaning it will
                       just send a command to an already running miniws server
                       process, then terminate. Default: 
  -p  --port           what port miniws will run on. Default: 8040
  -l  --logs-folder    the logs folder. Default: logs
  -c  --config-folder  the configurations folder. Default: config
  -w  --www-folder     the www folder where miniws will look for files to
                       serve. Default: .
  -b  --max-log-bytes  the maximum bytes after which the log files get split.
                       Default: 1048576        

how to configure

in your config folder you will find ipfilter.conf and useragentfilter.conf

both files use the same format: specify allow|deny in the first line to tell miniws to treat the file as a whitelist or a blacklist, then specify one ip/user-agent per line.

signals

you can pass the following signals when using -s:

• reload: reloads the configuration files from disk

logging

in your logging folder you will find access.log and errors.log

access.log utilizes the NCSA Combined Log Format

errors.log is for golang errors