Quickstart

Nethera deploys Docker Compose apps to Linux machines you control and gives them a public HTTPS endpoint. Pair a machine, write a nethera.yml, and deploy. No static IP, port forwarding, or router configuration required.

This quickstart shows the normal first deployment flow.

1. Install the CLI

Run this on your laptop or development machine:

$curl -fsSL https://get.nethera.io/cli | sh
$neth login

2. Install the agent

Run this on the Linux machine that will run your apps:

$curl -fsSL https://get.nethera.io/agent | sudo sh

The agent initiates pairing and prompts you to attach the machine to your Nethera workspace.

3. Choose a starting point

You can start from one of three places.

Start with a recipe

Pick a recipe, create a project directory, and copy the example nethera.yml into it. Recipes are the quickest path when you are deploying something Nethera already documents, such as ComfyUI, Ollama, or Open WebUI.

Start with docker-compose.yml

If your project already has docker-compose.yml or compose.yml, keep it in the project directory. neth init can import and normalize it into nethera.yml.

Start blank

If there is no Compose file, neth init creates a small hello-world placeholder nethera.yml that you can edit.

4. Run neth init

From your project directory:

$neth init

neth init writes nethera.yml, asks which paired machine or machines should be deployment targets, and uses the current directory name as the default app name.

5. Review nethera.yml

For most apps, you will edit the generated file so each service uses an image and any public service has a nethera: block:

app:
  name: example-app
services:
  web:
    image: ghcr.io/acme/example-app:latest
    nethera:
      public: 3000
      auth: login

6. Deploy

From the directory containing nethera.yml:

$neth deploy

When the deploy completes, Nethera prints the public HTTPS endpoint.

Next steps