⚠️ Deprecated

Use https-localhost instead.

---

SServe

Static content on https connection trusted by localhost

$ sserve ~/myproj
Serving ~/myproj on port 443. Checkout at https://localhost.

Easy. Handy. Free.

The idea

sserve is a lightweight tool for serving static content on https thanks to locally-trusted development certificates.
It requires you no configuration.

Why and how it works

Serving static content on localhost in a trusted SSL connection is not so simple.
It requires to manually generate and trust certificates, with complicate commands and many manual steps.

sserve, serves static content using a locally-trusted certificate, generated with the well-knowed mkcert tool.

When you install sserve it automatically creates and installs a local CA in the system (and browsers) root store, and generates the certificate for you.
No configuration is required, just lunch the tool and we take care of everything you need.

Installation

Using Go

go get github.com/daquinoaldo/sserve

MacOS

The following script automatically downloads the binary executable and adds it to PATH for you.

mkdir -p ${HOME}/.sserve && curl -L -o ${HOME}/.sserve/sserve $(
  curl -s https://api.github.com/repos/daquinoaldo/sserve/releases/latest \
  | grep "browser_download_url.*-darwin-amd64" \
  | cut -d : -f 2,3 | tr -d \" \
) && chmod +x ${HOME}/.sserve/sserve \
&& echo "export PATH=${HOME}/.sserve:\${PATH}" >> ${HOME}/.bash_profile

Important: you may need to install certutil to make it work.

brew install nss

Linux

The following script automatically downloads the binary executable and adds it to PATH for you.

mkdir -p ${HOME}/.sserve && curl -L -o ${HOME}/.sserve/sserve $(
  curl -s https://api.github.com/repos/daquinoaldo/sserve/releases/latest \
  | grep "browser_download_url.*-linux-amd64" \
  | cut -d : -f 2,3 | tr -d \" \
) && chmod +x ${HOME}/.sserve/sserve \
&& echo "export PATH=${HOME}/.sserve:\${PATH}" >> ${HOME}/.bash_profile

Important: you may need to install certutil to make it work.

sudo apt install libnss3-tools
    -or-
sudo yum install nss-tools
    -or-
sudo pacman -S nss

Windows

Download the windows executable from the latest release (is the one that ends with -windows-amd64.exe) and put it wherever you want. Just drop the folder you want to serve over the executable.

Troubleshooting

If you're running into permission problems try running sserve as an Administrator.

For example, on some operating system is not possible to use the 443 port without sudo permissions.

Supported root stores

The supported root stores are the one supported by mkcert.
Checkout the updated list here.

Here there is a handy copy:

• macOS system store
• Windows system store
• Linux variants that provide either
  • update-ca-trust (Fedora, RHEL, CentOS) or
  • update-ca-certificates (Ubuntu, Debian) or
  • trust (Arch)
• Firefox (macOS and Linux only)
• Chrome and Chromium
• Java (when JAVA_HOME is set)

Uninstall

Go

go clean -i github.com/daquinoaldo/sserve

If there are any sources in $GOPATH/src/github.com/daquinoaldo/sserve remove them.

MacOS and Linux

rm -rf ${HOME}/.sserve

Then edit ~/.bash_profile and remove the following row.

export PATH=${HOME}/.sserve:\${PATH}

Windows

Just delete the downloaded file.

Things to know

Warning

The rootCA-key.pem file that mkcert automatically generates when installing sserve gives complete power to intercept secure requests from your machine. Do not share it.

License

Is released under AGPL-3.0 - GNU Affero General Public License v3.0.

Briefly:

• modification and redistribution allowed for both private and commercial use
• you must grant patent rigth to the owner and to all the contributors
• you must keep it open source and distribute under the same license
• changes must be documented
• include a limitation of liability and it does not provide any warranty

Warranty

THIS TOOL IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. For the full warranty check the LICENSE.