Documentation / 01

Getting started

Install one binary, choose a directory, and open the server from a browser.

Install

macOS with Homebrew

brew install --cask wanetty/tap/upgopher

Windows with Scoop

scoop bucket add wanetty https://github.com/wanetty/scoop-bucket
scoop install upgopher

Any supported OS with Go

go install github.com/wanetty/upgopher@latest

Go places the executable in $(go env GOPATH)/bin. Make sure that directory is on your PATH.

Release archive

Download the archive for Linux, macOS, or Windows from the latest GitHub release. Extract it and put the executable somewhere on your PATH.

Share your first directory

mkdir shared
upgopher -dir ./shared

Open http://localhost:9090. Other devices on the same network can use your machine's LAN address, for example http://192.168.1.20:9090.

Network exposure: Upgopher listens on all interfaces. Add -user and -pass, or limit access with your network, VPN, firewall, or reverse proxy.
upgopher -dir ./shared -user admin -pass 'choose-a-strong-password'

Run with Docker

docker run --rm \
  --name upgopher \
  -p 9090:9090 \
  -v "$PWD:/data" \
  wanetty/upgopher:1.20.0

The image runs as a non-root user and serves /data. Ensure that the mounted directory is readable and writable by UID/GID 65532, or use -readonly with read permission only.

docker run -d \
  --name upgopher \
  --restart unless-stopped \
  -p 9090:9090 \
  -v "/srv/share:/data" \
  ghcr.io/wanetty/upgopher:1.20.0 \
  -dir /data -user admin -pass 'choose-a-strong-password'

Use an exact version tag for predictable deployments. Move to a newer version deliberately after reading its release notes.

Verify a downloaded archive

Every release includes checksums.txt. Download it next to the archive and compare the SHA-256 digest.

macOS or Linux

shasum -a 256 upgopher_1.20.0_darwin_arm64.tar.gz
grep upgopher_1.20.0_darwin_arm64.tar.gz checksums.txt

Windows PowerShell

Get-FileHash .\upgopher_1.20.0_windows_amd64.zip -Algorithm SHA256
Select-String upgopher_1.20.0_windows_amd64.zip .\checksums.txt

Next steps