Skip to content

Installation ​

Moonshed ships as one archive per platform: the binary, a default configuration file and the UI.

PlatformDownload
Linux x86-64moonshed-linux-amd64.tar.gz
Linux ARM64moonshed-linux-arm64.tar.gz
Windows x86-64moonshed-windows-amd64.zip

All releases are on the GitHub releases page, with a SHA256SUMS file to check the downloads against.

Install on the server ​

Download the latest release and unpack it where Moonshed should live. Everything it stores goes into a runtime/ folder next to the binary.

bash
cd /opt
curl -fsSL https://github.com/SiddheshNan/moonshed/releases/latest/download/moonshed-linux-amd64.tar.gz | sudo tar -xz
cd moonshed
powershell
# In an Administrator PowerShell
Invoke-WebRequest https://github.com/SiddheshNan/moonshed/releases/latest/download/moonshed-windows-amd64.zip -OutFile moonshed.zip
Expand-Archive moonshed.zip -DestinationPath C:\
cd C:\moonshed

On an ARM server, download moonshed-linux-arm64.tar.gz instead.

Check runtime/config/production.yaml (see Configuration file), then install Moonshed as a service:

bash
sudo ./moonshed install -e production
powershell
.\moonshed.exe install -e production

On Linux this writes a systemd unit to /etc/systemd/system/moonshed.service. On Windows it registers a Windows service. Either way Moonshed starts now and on every boot.

Open http://<your-server>:5050 and create the admin account.

Login page

The rest of runtime/ (databases, apps, logs, backups) is created on first run. See Runtime folder for what goes where.

Before you put it on the internet ​

  • The panel on port 5050 is plain HTTP. Give it a domain with HTTPS (Settings › General › Panel domain) and set panel_addr: "127.0.0.1:5050" so it is only reachable through that domain. See Domains and HTTPS.
  • Ports 80 and 443 must be free and open for the reverse proxy and Let's Encrypt.
  • Install Docker if you want to run Docker apps. Moonshed works without it.

Run in the foreground ​

To try Moonshed without installing a service:

bash
./moonshed serve -e production

Uninstall ​

bash
sudo ./moonshed uninstall

This stops and removes the service. The runtime/ folder is left as it is.

Build from source ​

You need Go 1.26+, Node 20+ and Python 3.

bash
git clone https://github.com/SiddheshNan/moonshed.git
cd moonshed
./scripts/build.py

The script asks for the version, the target platforms, the output folder and whether to run the tests. Press Enter to accept the defaults. It writes one folder per platform into dist/, laid out the same as a release archive. The binary is built without CGO, so you can build for any platform from any machine.

Released under the AGPL-3.0 license.