Notploy

Onion services

Tor onion services attached to a Compose stack: create, start, stop and inspect their status. Generated from the `notploy` command surface.

Tor onion services attached to a Compose stack: create, start, stop and inspect their status.

notploy onion exposes 9 commands. They map one-to-one onto the onion.* API operations, so anything reachable from the dashboard is reachable from here.

Run notploy onion --help to list these commands in your terminal, or notploy onion <command> --help for a single command.

Commands

notploy onion create

Calls POST /api/trpc/onion.create.

notploy onion create --name <value> --composeId <value> --serviceName <value> --targetPort <value> [options]
OptionTypeRequiredAllowed values
--name <value>stringYes—
--composeId <value>stringYes—
--serviceName <value>stringYes—
--targetPort <value>numberYes—
--virtualPort <value>numberNo—
--profile <name>stringNo—

notploy onion delete

Calls POST /api/trpc/onion.delete.

notploy onion delete --onionServiceId <value> [options]
OptionTypeRequiredAllowed values
--onionServiceId <value>stringYes—
--deleteIdentity [boolean]booleanNo—
--no-deleteIdentitybooleanNo—
--profile <name>stringNo—

notploy onion list

Calls GET /api/trpc/onion.list.

notploy onion list --composeId <value> [options]
OptionTypeRequiredAllowed values
--composeId <value>stringYes—
--profile <name>stringNo—

notploy onion one

Calls GET /api/trpc/onion.one.

notploy onion one --onionServiceId <value> [options]
OptionTypeRequiredAllowed values
--onionServiceId <value>stringYes—
--profile <name>stringNo—

notploy onion restart

Calls POST /api/trpc/onion.restart.

notploy onion restart --onionServiceId <value> [options]
OptionTypeRequiredAllowed values
--onionServiceId <value>stringYes—
--profile <name>stringNo—

notploy onion start

Calls POST /api/trpc/onion.start.

notploy onion start --onionServiceId <value> [options]
OptionTypeRequiredAllowed values
--onionServiceId <value>stringYes—
--profile <name>stringNo—

notploy onion status

Calls GET /api/trpc/onion.status.

notploy onion status --onionServiceId <value> [options]
OptionTypeRequiredAllowed values
--onionServiceId <value>stringYes—
--profile <name>stringNo—

notploy onion stop

Calls POST /api/trpc/onion.stop.

notploy onion stop --onionServiceId <value> [options]
OptionTypeRequiredAllowed values
--onionServiceId <value>stringYes—
--profile <name>stringNo—

notploy onion update

Calls POST /api/trpc/onion.update.

notploy onion update --onionServiceId <value> [options]
OptionTypeRequiredAllowed values
--name <value>stringNo—
--serviceName <value>stringNo—
--targetPort <value>numberNo—
--virtualPort <value>numberNo—
--onionServiceId <value>stringYes—
--profile <name>stringNo—

Networks

Docker networks: create, import, inspect and resynchronise them across servers. Generated from the `notploy` command surface.

Ports

Publish container ports directly, without routing them through a domain. Generated from the `notploy` command surface.

On this page

Commandsnotploy onion createnotploy onion deletenotploy onion listnotploy onion onenotploy onion restartnotploy onion startnotploy onion statusnotploy onion stopnotploy onion update