goweb

goweb

Multi domain/host web server written in Golang.

If you just want to host websites of a bunch of html/js/css files, and you don't want to be intimidated by the configuration files of Nginx or Apache, this might be for you.

Install and Run

$ go install github.com/elgs/goweb@latest

Assuming you have go's bin directory in your PATH, otherwise, you could add the following line to your .zshrc or .bashrc.

export PATH=$HOME/go/bin:$PATH

Then run the server:

$ goweb -c /path/to/config.json
# if the config file happens to be goweb.json in the same directory, you could simply run:
$ goweb
# for help, run
$ goweb --help

or if you will listen to any ports lower than 1024:

$ sudo goweb -c /path/to/config.json

Web Admin Interface

The goweb admin is a web interface that will help you to generate config json and test server configurations.

$ goweb -admin
2022/08/06 03:05:17 Listening on https://[::]:443/
Web admin url: http://[::]:54666/admin
Access token: pj8s1jy7n5ep0l9j9rwdk70a7j6ppmf7

A config file will be optional to run goweb in admin mode.

Uninstall

$ rm -rf $HOME/go/bin/goweb

Configurations

Bare minimum

[
  {
    "type": "http",
    "listen": "[::]:80",
    "hosts": [
      {
        "name": "example.com",
        "type": "serve_static",
        "path": "/path/to/webroot"
      }
    ]
  }
]

Https with redirect

[
  {
    "type": "http",
    "listen": "[::]:80",
    "hosts": [
      {
        "name": "example.com",
        "type": "301_redirect",
        "redirect_url": "https://example.com"
      }
    ]
  },
  {
    "type": "https",
    "listen": "[::]:443",
    "hosts": [
      {
        "name": "example.com",
        "type": "serve_static",
        "path": "/path/to/webroot",
        "cert_path": "/path/to/certfile",
        "key_path": "/path/to/keyfile"
      }
    ]
  }
]

Reverse Proxy and Load Balancer

[
  {
    "type": "https",
    "listen": "[::]:443",
    "hosts": [
      {
        "name": "example.com",
        "type": "reverse_proxy",
        "forward_urls": "http://s1.example.com:1234 http://s2.example.com",
        "cert_path": "/path/to/certfile",
        "key_path": "/path/to/keyfile"
      }
    ]
  }
]

TCP Proxy and Load Balancer

[
  {
    "type": "tcp",
    "listen": "[::]:1234",
    "hosts": [
      {
        "name": "server1",
        "upstream": "192.168.0.1"
      },
      {
        "name": "server2",
        "upstream": "192.168.0.2"
      }
    ]
  }
]

Multiple domains

[
  {
    "type": "https",
    "listen": "[::]:443",
    "hosts": [
      {
        "name": "example.com",
        "type": "serve_static",
        "path": "/path/to/webroot",
        "cert_path": "/path/to/certfile",
        "key_path": "/path/to/keyfile"
      },
      {
        "name": "example.net",
        "type": "serve_static",
        "path": "/path/to/webroot",
        "cert_path": "/path/to/certfile",
        "key_path": "/path/to/keyfile"
      }
    ]
  }
]

All parameters

Server

Host

Auto start with systemd

Create service unit file /etc/systemd/system/goweb.service with the following content:

[Unit]
After=network.target

[Service]
ExecStart=/home/elgs/go/bin/goweb -c /home/elgs/goweb.json

[Install]
WantedBy=default.target

Enable the service:

$ sudo systemctl enable goweb

Remove the service:

$ sudo systemctl disable goweb

Start the service

$ sudo systemctl start goweb

Stop the service

$ sudo systemctl stop goweb

Check service status

$ sudo systemctl status goweb

Auto renew certificates with certbot

Assuming certbot is installed. I use the command certbot certonly to get a new cert/key pair.

Create service unit file /etc/systemd/system/certbot.service with the following content:

[Unit]
Description=Let's Encrypt renewal

[Service]
Type=oneshot
ExecStartPre=systemctl stop goweb
ExecStart=/usr/bin/certbot renew --agree-tos
ExecStartPost=systemctl start goweb

Create timer unit file /etc/systemd/system/certbot.timer with the following content:

[Unit]
Description=Twice daily renewal of Let's Encrypt's certificates

[Timer]
OnCalendar=0/12:00:00
RandomizedDelaySec=1h
Persistent=true

[Install]
WantedBy=timers.target

Enable the timer:

$ sudo systemctl enable certbot.timer