Skip to content

QUICKSTART.md

Latest commit

 

History

History
121 lines (84 loc) · 2.28 KB

QUICKSTART.md

File metadata and controls

121 lines (84 loc) · 2.28 KB
Raw

Deployment Quickstart

This quickstart uses release packages and one TOML config file. The installer downloads and extracts binaries only; it does not create services or edit system network settings.

Download

Linux/macOS, or Windows Git Bash:

curl -fsSL https://raw.githubusercontent.com/tianrking/Espejismo/main/scripts/install.sh | sh

Windows PowerShell:

iwr -useb https://raw.githubusercontent.com/tianrking/Espejismo/main/scripts/install.ps1 | iex

Server-only package:

curl -fsSL https://raw.githubusercontent.com/tianrking/Espejismo/main/scripts/install.sh \
  | ESPEJISMO_PACKAGE=server sh

Pinned release:

curl -fsSL https://raw.githubusercontent.com/tianrking/Espejismo/main/scripts/install.sh \
  | ESPEJISMO_VERSION=v0.1.5 sh

Configure

Edit the extracted example:

cp ~/.espejismo/configs/espejismo.toml ./espejismo.toml

Set at least:

[shared]
psk = "change-me-to-a-long-random-secret"

[local]
server = "YOUR_SERVER_IP_OR_DOMAIN:6690"
socks5_listen = "127.0.0.1:6680"
http_listen = "127.0.0.1:6681"

[remote]
listen = "0.0.0.0:6690"

Recommended remote egress guard:

[remote.egress]
deny_private_ips = true
allow_ports = [80, 443]

Full parameter reference: CONFIG.md.

Run Server

~/.espejismo/bin/espejismo-remote --config ./espejismo.toml

Windows:

& "$env:LOCALAPPDATA\Espejismo\bin\espejismo-remote.exe" --config .\espejismo.toml

Run Client

~/.espejismo/bin/espejismo-local --config ./espejismo.toml

Windows:

& "$env:LOCALAPPDATA\Espejismo\bin\espejismo-local.exe" --config .\espejismo.toml

Point applications at:

SOCKS5: 127.0.0.1:6680
HTTP:   127.0.0.1:6681

Validate

~/.espejismo/bin/espejismo-remote --config ./espejismo.toml --check-config
~/.espejismo/bin/espejismo-local --config ./espejismo.toml --check-config
~/.espejismo/bin/espejismo-local --config ./espejismo.toml --probe-server

Admin

Bind admin to loopback unless you have a strong reason to expose it:

[admin]
listen = "127.0.0.1:9090"
token = "change-me-admin-token"

Public admin listeners require admin.token.

curl -H "Authorization: Bearer change-me-admin-token" http://127.0.0.1:9090/status