Skip to content

INSTALLATION.md

Latest commit

 

History

History
132 lines (93 loc) · 4.15 KB

INSTALLATION.md

File metadata and controls

132 lines (93 loc) · 4.15 KB
Raw

Installation

Homebrew (macOS & Linux)

brew tap routatic/tap
brew install routatic-proxy

Scoop (Windows)

scoop bucket add routatic https://github.com/routatic/scoop-bucket
scoop install routatic-proxy

Build from Source

git clone https://github.com/routatic/proxy.git
cd proxy
make build

# Binary is at bin/routatic-proxy
# bin/oc-go-cc is created as a compatibility alias
# Optionally install to $GOPATH/bin
make install

Download a Release Binary

Download the latest release for your platform from the Releases page:

Platform File
macOS (Apple Silicon) routatic-proxy_darwin-arm64
macOS (Intel) routatic-proxy_darwin-amd64
Linux (x86_64) routatic-proxy_linux-amd64
Linux (ARM64) routatic-proxy_linux-arm64
Windows (x86_64) routatic-proxy_windows-amd64.exe
Windows (ARM64) routatic-proxy_windows-arm64.exe 
# macOS Apple Silicon
curl -L -o routatic-proxy https://github.com/routatic/proxy/releases/latest/download/routatic-proxy_darwin-arm64
chmod +x routatic-proxy
sudo mv routatic-proxy /usr/local/bin/

# Windows (PowerShell)
Invoke-WebRequest -Uri "https://github.com/routatic/proxy/releases/latest/download/routatic-proxy_windows-amd64.exe" -OutFile "routatic-proxy.exe"
Move-Item -Path "routatic-proxy.exe" -Destination "$env:LOCALAPPDATA\Microsoft\WindowsApps\routatic-proxy.exe"

Homebrew and Scoop installs also provide oc-go-cc as an alias for routatic-proxy.

Docker

Pull the prebuilt image

Prebuilt multi-arch images (linux/amd64, linux/arm64) are published to GitHub Container Registry:

# Latest stable release
docker pull ghcr.io/routatic/proxy:latest

# Latest beta (newest prerelease build)
docker pull ghcr.io/routatic/proxy:beta

# A specific stable release
docker pull ghcr.io/routatic/proxy:v1.0.0

docker run -d --restart unless-stopped --name routatic-proxy \
  --env-file .env -p 3456:3456 ghcr.io/routatic/proxy:latest

Quick start with Makefile

cp .env.example .env
# Edit .env and put your API key
make docker-up

Stop the container:

make docker-stop

Build and run manually

docker build -t routatic-proxy .
docker run -d --restart unless-stopped --name routatic-proxy --env-file .env -p 3456:3456 routatic-proxy

Use a custom config

The Docker image uses configs/config.json by default (or configs/config.example.json as fallback). Override with a volume:

docker run -d --restart unless-stopped --name routatic-proxy --env-file .env -p 3456:3456 \
  -v /path/to/your/config.json:/etc/routatic-proxy/config.json:ro \
  routatic-proxy

Requirements

  • An OpenCode Go subscription and API key
  • Go 1.21+ (only needed if building from source)
  • Docker (only needed for Docker setup)

Updating

If you installed via go install or downloaded a release binary directly, you can self-update with the built-in command:

# See whether a newer release is available without changing anything
routatic-proxy update --check

# Download, verify checksum, and replace the running binary in place
routatic-proxy update

# Skip the confirmation prompt (useful in scripts)
routatic-proxy update --yes

The updater queries the routatic/proxy releases on GitHub, picks the asset that matches your OS/arch, verifies its SHA256 against checksums.txt when available, and writes a .old backup of the previous binary next to the running executable before replacing it. On Windows the .old backup is scheduled for deletion after the process exits because the running executable is locked until then.

A dev build (e.g. when compiled from source without a version tag) refuses to update unless you pass --force.

If you installed via Homebrew (brew upgrade routatic-proxy) or Scoop (scoop update routatic-proxy), prefer your package manager — it tracks the same releases and handles uninstall/reinstall cleanly.