NodeRings Docs

Get Started

Fast path from sign-up to your first marketplace VM

This guide takes you from registration to a running virtual machine in seven steps.

Before you start

You needNotes
NodeRings accountSign up and verify your email
Client organizationDefault type when you create an org; use this to buy from the marketplace
Payment methodRequired before VM create: Billing → Payment methods
SSH key (recommended)Optional if you use password auth: SSH Keys

You must be in a client organization to purchase from the marketplace. If you are in a provider org, switch orgs or create a client org from the organization switcher.


1. Create your account

Sign up

Open Sign up, enter your email and password, and confirm your account.

Verify email

Check your inbox for the verification link. You cannot launch VMs until your email is verified.

Complete welcome flow

Follow /welcome if prompted: create or select your first organization.

More detail: Profile & account.


2. Organization

Create or select a client org

Open the organization switcherCreate organization → choose Client (Buys services from providers).


3. Payment method

Add a card

Open /billing?t=payment-methodsAdd payment method and complete Stripe setup.

Set a default

Mark one payment method as default. VM create fails without a valid default payment method on file.

More detail: Billing.


4. SSH keys

Add a public key

Open /organization/ssh-keysCreate → paste your ssh-ed25519 or ssh-rsa public key.

Select at launch

When creating a VM, choose SSH keys as the auth method and pick the keys to install on the guest.

Alternatively use password or cloud-init user-data at launch. More detail: SSH keys.


5. Find a plan

Browse by location or provider

  • By location: pick a region, then compare providers and plans in that geography.
  • By provider: open a seller's catalog at /platform/providers/{providerId} and choose a plan from their matrix.

More detail: Marketplace.


6. Launch a VM

Configure the instance

Select plan, OS image, hostname, and auth method (SSH keys, password, or user-data). Review addons if the plan offers extras (IPs, backups).

Confirm and create

Review the launch summary and submit. NodeRings charges your payment method according to the plan billing type and sends the order to the provider.

Wait for provisioning

The VM appears at /platform/virtual-machines with a provisioning status until the provider's operator finishes clone and cloud-init.

More detail: Virtual machines.


7. Connect and operate

Open the VM detail page

Click the VM → Overview for IP addresses, power actions, and links to Graphs, Backups, Snapshots, and Settings.

SSH or console

SSH to the assigned IP using your key or password. For browser access, open Console (VNC) from the VM page.

Optional: firewall and support

Attach a firewall ruleset under Organization → Firewall. Open a ticket if you need provider help.


Stuck?

See Troubleshooting, or jump to a common issue:

ProblemRead
Cannot buy / org picker appearsTroubleshooting → Client org required
Payment method error on launchTroubleshooting → Payment method
VM stuck provisioningTroubleshooting → Provisioning
Cannot SSHVirtual machines → Connect