serverino 0.6.0

<p align="center">

<picture>
  <img src="https://github.com/trikko/serverino/assets/647157/a6f462fa-8b76-43c3-9855-0671e704aa6c" height="128">
</picture>
<h1 align="center">serverino &middot; <a href="https://github.com/trikko/serverino/actions/workflows/d.yml"><img src="https://github.com/trikko/serverino/actions/workflows/d.yml/badge.svg" alt="BUILD &amp; TEST" style="max-width: 100%;"></a> <a href="https://paypal.me/andreafontana/5" rel="nofollow"><img src="https://camo.githubusercontent.com/cf3676b83230f6252e02c8bb9a707eb163872978c52a99389ad0b164c240e8e2/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f70617970616c2d6275795f6d655f615f626565722d4646454630303f6c6f676f3d70617970616c266c6f676f436f6c6f723d7768697465" alt="Donate" data-canonical-src="https://img.shields.io/badge/paypal-buy_me_a_beer-FFEF00?logo=paypal&amp;logoColor=white" style="max-width: 100%;"></a></h1>

</p> <h6> <p align="center"> <a href="#quickstart">quickstart</a> – <a href="#a-simple-webserver-in-just-three-lines">minimal example</a> – <a href="https://github.com/trikko/serverino/tree/master/examples">more examples</a> - <a href="https://github.com/trikko/serverino/wiki/">wiki</a> - <a href="#documentation-you-need">docs</a> – <a href="#shielding-the-whole-thing">shielding serverino</a> </p> </h6>

• Ready-to-go http server
• Cross-platform (Linux/Windows/MacOS)
• Multi-process
• Dynamic number of workers
• Zero dependencies
• Build & start your project in a few seconds

Quickstart

dub init your_fabulous_project -t serverino
cd your_fabulous_project
dub run

A simple webserver in just three lines

import serverino;
mixin ServerinoMain;
void hello(const Request req, Output output) { output ~= req.dump(); }

Documentation you need

• Serverino docs - Serverino reference, generated from code
• Examples - Some ready-to-try examples
• Tips - Some snippets you want to read

Defining more than one endpoint

Every function marked with ```@endpoint``` is called until one writes something to output

The calling order is defined by `@priority`

import serverino;
mixin ServerinoMain;

// This function will never block the execution of other endpoints since it doesn't write anything to output
// In this case `output` param is not needed and this works too: `@priority(10) @endpoint void logger(Request req)`
@priority(10) @endpoint void logger(Request req, Output output)
{
   import std.experimental.logger; // std.experimental.logger works fine!
   log(req.uri);
}

// We accept only GET request in this example
@priority(5) @endpoint void checkMethod(Request req, Output output)
{
   if (req.method != Request.Method.Get)
   {
      // We set a 405 (method not allowed) status here. 
      // If we change the output no other endpoints will be called.
      output.status = 405;
   }
}

// This endpoint (default priority == 0) handles the homepage
// Request and Output can be used in @safe code
@safe
@endpoint void hello(Request req, Output output)
{
   // Skip this endpoint if uri is not "/"
   if (req.uri != "/") return;

   output ~= "Hello world!";
}

// This function will be executed only if `hello(...)` doesn't write anything to output.
@priority(-10000) @endpoint void notfound(const Request req, Output output)
{
   output.status = 404;
   output ~= "Not found";
}

@onServerInit UDA

Use `@onServerInit` to configure your server

// Try also `setup(string args[])` if you need to read arguments passed to your application
@onServerInit ServerinoConfig setup()
{
   ServerinoConfig sc = ServerinoConfig.create(); // Config with default params
   sc.addListener("127.0.0.1", 8080);
   sc.addListener("127.0.0.1", 8081);
   sc.addListener!(ServerinoConfig.ListenerProtocol.IPV6)("localhost", 8082); // IPV6
   sc.setWorkers(2);
   // etc...

   return sc;
}

Shielding the whole thing

I would not put serverino into the wild. For using in production I suggest shielding serverino under a full webserver.

Using nginx

It's pretty easy. Just add these lines inside your nginx configuration:

server {
   listen 80 default_server;
   listen [::]:80 default_server;
   
   location /your_path/ {
      proxy_set_header Host $host;
      proxy_set_header X-Real-IP $remote_addr;
      
      proxy_pass http://localhost:8080;
   }
   ...
   ...
}

If you want to enable keepalive (between nginx and serverino) you must use an upstream:

upstream your_upstream_name {
  server localhost:8080;
  keepalive 64;
}


server {
   listen 80 default_server;
   listen [::]:80 default_server;

   location /your_path/ {
      proxy_set_header Connection "";
      proxy_http_version 1.1;
      proxy_set_header Host $host;
      proxy_set_header X-Real-IP $remote_addr;
      
      proxy_pass http://your_upstream_name;
    }
    
    ...
    ...
 }

Using apache2

Enable proxy module for apache2:

sudo a2enmod proxy
sudo a2enmod proxy_http

Add a proxy in your virtualhost configuration:

<VirtualHost *:80>
   ProxyPass "/"  "http://localhost:8080/"
   ...
</VirtualHost>