Woodshed

Install Woodshed

Pick one. The installer runs Woodshed in the background as a service, also after a restart. Portable runs it only while its window is open, with nothing installed. Downloads are on the download section and the releases page.

This is the short version. The full install guide and user guide are on GitHub.

Windows

Installer

  1. Download woodshed_X.Y.Z_windows_amd64.msi (_arm64 for ARM PCs) and double-click it. Approve the administrator prompt.
  2. It installs the Woodshed service, which starts with the computer, and opens Windows Firewall for UDP and TCP 514 only.
  3. Open http://localhost:8514/, or the Woodshed shortcut in the Start menu.

Silent install from an administrator prompt: msiexec /i woodshed_X.Y.Z_windows_amd64.msi /qn

Portable

  1. Download woodshed_X.Y.Z_windows_amd64.zip, right-click it, Extract All.
  2. Double-click woodshed.exe. When Windows asks whether to allow it through the firewall, choose Allow.

Remove it

Settings → Apps → Woodshed → Uninstall. Your logs in C:\ProgramData\Woodshed are kept; delete the folder to remove them.

macOS

Installer

  1. Download woodshed_X.Y.Z_macos_universal.pkg (Apple silicon and Intel) and double-click it.
  2. Follow the installer; it needs an administrator password. When it finishes, the welcome page opens in your browser.

Portable

  1. Download woodshed_X.Y.Z_darwin_universal.tar.gz and double-click it to unpack.
  2. Double-click woodshed.

Remove it

sudo /usr/local/share/woodshed/uninstall.sh                # keeps the logs
sudo /usr/local/share/woodshed/uninstall.sh --delete-logs  # also deletes them

If the macOS firewall is on and devices can't reach port 514, allow incoming connections for /usr/local/bin/woodshed in System Settings → Network → Firewall.

Linux

Package

sudo apt install ./woodshed_X.Y.Z_amd64.deb        # Debian, Ubuntu
sudo dnf install ./woodshed-X.Y.Z-1.x86_64.rpm     # Fedora, RHEL
sudo zypper install ./woodshed-X.Y.Z-1.x86_64.rpm  # openSUSE

The package starts the woodshed service and prints the web address. It doesn't change the firewall; if one is on, open port 514:

sudo ufw allow 514                                                                  # ufw
sudo firewall-cmd --permanent --add-port=514/udp --add-port=514/tcp && sudo firewall-cmd --reload

Portable

tar xzf woodshed_X.Y.Z_linux_amd64.tar.gz
cd woodshed_X.Y.Z_linux_amd64
sudo ./woodshed          # port 514 needs root, or: sudo setcap cap_net_bind_service=+ep ./woodshed

Remove it

sudo apt remove woodshed   # keeps /var/lib/woodshed (apt purge also deletes it)
sudo dnf remove woodshed   # keeps /var/lib/woodshed

Point a device at it

  1. Open http://localhost:8514/ on the Woodshed machine. The Setup page lists its addresses.
  2. In the device's logging or syslog settings, set the syslog server to one of those addresses, port 514, UDP (or TCP if the device offers it).
  3. Make the device log something (log in to it, or change a setting). The Setup page says when the first message arrives.

No device handy? Send a test message from the Woodshed machine:

woodshed send --message "hello"   # portable: ./woodshed send ... (woodshed.exe on Windows)

Nothing arriving? See devices can't reach Woodshed in the FAQ.

Where the logs are

One folder per device and one plain-text file per day (UTC); older days are compressed (.log.gz).

InstallerPortable
WindowsC:\ProgramData\Woodshed\logs\woodshed-data\logs\ next to woodshed.exe
macOS/Library/Application Support/Woodshed/logs/woodshed-data/logs/ next to woodshed
Linux/var/lib/woodshed/logs/woodshed-data/logs/ next to woodshed

If your computer warns you

The downloads aren't code-signed yet. Windows: "Windows protected your PC" → More info → Run anyway. macOS: "can't be opened" → Done, then System Settings → Privacy & Security → Open Anyway. You only do this once per download.