Netpup - Easy HTTP Server

• Need a quick and dirty HTTP server? No problem!
• Want to create static web pages? No problem!
• Want to create client side webapps? No problem!

Netpup can do all of that and more!

Getting started

• Install netpup using cargo: cargo install netpup

• Or if you're on windows you can download Netpup from the releases page on the github page.

• Or (for other platforms), you can build it from source.

After installing, create your config toml file:

ip = "127.0.0.1"                            # REQUIRED | IP.
port = 5000                                 # OPTIONAL | Port. Defaults to 8080.
cwd = "/path/to/my/stuff"                   # OPTIONAL | Set current working directory.

[logger]                                    # OPTIONAL | Logger configuration.
print = true                                # OPTIONAL | Whether to print or not. Defaults to true.
log_file = 'logfile.log'                    # OPTIONAL | File to log to. If not specified, netpup will not log to a file.

[routes.main]                               # New Route -> "main" | Name must be unique, but is not important.
methods = ["GET"]                           # OPTIONAL | List of methods (GET, POST).
url = "/"                                   # REQUIRED | Url to access.
path = "mainpage.html"                      # REQUIRED | Path to serve from.

# Make sure that routes with '*' come last
[routes.resources]                          # New Route -> "resources" | Name must be unique, but is not important.
methods = ["GET"]                           # OPTIONAL | List of methods (GET, POST).
url = "/r/*"                                # REQUIRED | Url to access. '*' means anything can come after that.
path = "/resources/*"                       # REQUIRED | Path to serve from. '*' means that the '*' part of the url gets inserted here.

[errors.404]                                # OPTIONAL | Route for Error 404's.
path = "errors/error_404.html"              # REQUIRED | Path to serve from.

Then run netpup my-config.toml or netpup (config file path defaults to config.toml)

Dynamic loading

Instead of serving a static file, netpup can run a lua program serve its output.

Just provide the path to a lua file as a script in your route.

[routes.main]
methods = ["GET"]
url = "/*"
script = "main_page.lua"

Your lua program gets treated as a function:

ret = {
 ["code"] = 200,
 ["resp"] = "OK",
 ["headers"] = {},
 ["content"] = read("logfile.log"),
 ["type"] = "html"
}
log_info("Hi (triggered from Lua)")
return ret

Response format

The program must return a table in this format:

• code: u16
• resp: string,
• headers: string = string,
• content: string,
• type: string (mine type)

Provided functions

Additionally, netpup provides the program with the following functions:

• read(file_path: string) -> string
  • Reads a file to a string
• write(file_path: string, content: string) -> nil
  • Writes a string to a file
• log_info(message: string) -> nil
  • Logs a message as an info
• log_error(message: string) -> nil
  • Logs a message as an error
• log_fatal(message: string) -> nil
  • Logs a message as a fatal error and terminates the program