Skip to content

Self Hosting with Binaries

Ringo Hoffmann edited this page Apr 1, 2021 · 1 revision

You can download the latest pre-compiled binaries and web assets below each release of shinpuru. To download them, just go to the releases page and download the provided binaries.

Linux

First, download the build assets.

$ curl -Lo sp.tgz https://github.com/zekroTJA/shinpuru/releases/download/<version>/build_assets.tar.gz

If you have jq installed, you can use the following command.

$ curl -Lo sp.tgz https://github.com/zekroTJA/shinpuru/releases/download/$(curl https://api.github.com/repos/zekroTJA/shinpuru/tags | jq .[0].name -r)/build_assets.tar.gz

After that, extract the contents of the archive.

$ tar -xzvf sp.tgz && rm sp.tgz

Following, you might need to set execute permissions to the binaries.

$ chmod +x ./shinpuru_linux_amd64

Now, follow these steps to set up the configuration.

After that, you can set up a linux systemd daemon. Here you can find a handy guide how to do so.
https://www.howtogeek.com/687970/how-to-run-a-linux-program-at-startup-with-systemd/

Windows

Download the latest build_assets.tar.gz from the releases page.

Following, you can unpack the archive using 7zip, fir example.

Now, follow these steps to set up the configuration.

After that, you can create a new windows service using sc. Here you can find a handy guide how to do so.
https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/sc-create

Config

After that, you need to get the latest config file. There are two ways to get the latest file.

If you are not experienced with configuring shinpuru, you might want to download the commented config from the repository.

$ curl -Lo config.yml https://raw.githubusercontent.com/zekroTJA/shinpuru/<version>/config/config.example.yaml

If you have jq installed, you can use the following command.

$ curl -Lo config.yml https://raw.githubusercontent.com/zekroTJA/shinpuru/$(curl https://api.github.com/repos/zekroTJA/shinpuru/tags | jq .[0].name -r)/config/config.example.yaml

Otherwise, if you know what you are doing, you can generate a preset config by just starting up the shinpuru binary.

Getting Started

Documentation

Self-Hosting

Clone this wiki locally