Skip to content

README.md

Latest commit

 

History

History
70 lines (46 loc) · 4.18 KB

README.md

File metadata and controls

70 lines (46 loc) · 4.18 KB
Raw

EasyServer documentation

Languages: English · Русский

Start with the task you are trying to complete. The documentation intentionally gets more technical as you move from first use into automation, extension, compatibility, and security details.

Start here

  • Getting started — install EasyServer, add a provider, rent a server, and reach the first service on localhost.
  • Interactive TUI — navigate the main interface, manage servers, configure providers, recover connection failures, and use accessibility modes.
  • Supported platforms — check the current operating-system, Node.js, npm, OpenSSH, and Secret Store support boundary.

Connect to your servers

  • Connect to a remote service — foreground local connections, remote vs local ports, first-use SSH trust, common failures, and advanced connection-method selection.
  • Background connections — managed daemon, background Sessions, saved connection intents, idempotency, restart, and recovery.

Use a provider

  • Vast.ai — account preparation, marketplace search/rental, lifecycle, connection requirements, and paid-resource cleanup.
  • Intelion.cloud — account preparation, server configuration/creation, lifecycle, connection behavior, and paid-resource cleanup.

Provider packages are opt-in. A clean EasyServer installation contains no Provider Plugins until you install and add one.

Install and operate EasyServer

  • Install from GitHub Releases — verify and run the portable artifact for Windows, Ubuntu, or macOS, then add plugins to that extracted installation when needed.
  • Package lifecycle — compatible upgrades, reinstalls, missing plugins, uninstall, and clean removal.
  • Support and maintenance — where to report bugs, what information is useful, and what the project currently supports.

Automate and integrate

  • Machine-readable CLI output — the versioned --json envelope, exit semantics, provider command data, and non-interactive SSH host-trust flow.
  • Versioning and compatibility — public compatibility promises for the 0.x release lines, Plugin SDK, Local State, and documented CLI behavior.

The built-in command reference is also available directly from the product:

easyserver --help
easyserver instances --help
easyserver connect --help

Provider-specific command trees expose their own nested help when the installed plugin publishes it.

Build a Provider Plugin

Security and project policy

  • Documentation localization — canonical language, locale layout, translation rules, and how to add another language.

  • Security model — trust boundaries, credential handling, SSH host trust, local control-plane protections, and plugin trust assumptions.

  • Security reporting — how to report vulnerabilities privately.

  • Contributing — development setup and contribution workflow.

Release history

Historical documents describe what shipped or was verified at a particular release. They are not the source of truth for current behavior.