Settings

Instance-wide settings: Traefik, Docker cleanup, monitoring, GPUs, updates and SSH. Generated from the `notploy` command surface.

Instance-wide settings: Traefik, Docker cleanup, monitoring, GPUs, updates and SSH.

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

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

Commands

`notploy settings assign-domain-server`

Calls POST /api/trpc/settings.assignDomainServer.

notploy settings assign-domain-server --host <value> [options]

Option	Type	Required	Allowed values
`--host <value>`	string	Yes	—
`--certificateType <value>`	string	No	`letsencrypt`, `none`, `custom`
`--customCertResolver <value>`	string	No	—
`--letsEncryptEmail <value>`	string	No	``
`--https [boolean]`	boolean	No	—
`--no-https`	boolean	No	—
`--profile <name>`	string	No	—

`notploy settings check-gpustatus`

Calls GET /api/trpc/settings.checkGPUStatus.

notploy settings check-gpustatus [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings check-infrastructure-health`

Calls GET /api/trpc/settings.checkInfrastructureHealth.

notploy settings check-infrastructure-health [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings clean-all`

Calls POST /api/trpc/settings.cleanAll.

notploy settings clean-all [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings clean-all-deployment-queue`

Calls POST /api/trpc/settings.cleanAllDeploymentQueue.

notploy settings clean-all-deployment-queue [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings clean-docker-builder`

Calls POST /api/trpc/settings.cleanDockerBuilder.

notploy settings clean-docker-builder [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings clean-docker-prune`

Calls POST /api/trpc/settings.cleanDockerPrune.

notploy settings clean-docker-prune [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings clean-monitoring`

Calls POST /api/trpc/settings.cleanMonitoring.

notploy settings clean-monitoring [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings clean-sshprivate-key`

Calls POST /api/trpc/settings.cleanSSHPrivateKey.

notploy settings clean-sshprivate-key [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings clean-stopped-containers`

Calls POST /api/trpc/settings.cleanStoppedContainers.

notploy settings clean-stopped-containers [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings clean-unused-images`

Calls POST /api/trpc/settings.cleanUnusedImages.

notploy settings clean-unused-images [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings clean-unused-volumes`

Calls POST /api/trpc/settings.cleanUnusedVolumes.

notploy settings clean-unused-volumes [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings get-control-plane-runtime`

Calls GET /api/trpc/settings.getControlPlaneRuntime.

notploy settings get-control-plane-runtime [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings get-docker-disk-usage`

Calls GET /api/trpc/settings.getDockerDiskUsage.

notploy settings get-docker-disk-usage [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings get-ip`

Calls GET /api/trpc/settings.getIp.

notploy settings get-ip [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings get-log-cleanup-status`

Calls GET /api/trpc/settings.getLogCleanupStatus.

notploy settings get-log-cleanup-status [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings get-notploy-cloud-ips`

Calls GET /api/trpc/settings.getNotployCloudIps.

notploy settings get-notploy-cloud-ips [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings get-notploy-version`

Calls GET /api/trpc/settings.getNotployVersion.

notploy settings get-notploy-version [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings get-open-api-document`

Calls GET /api/trpc/settings.getOpenApiDocument.

notploy settings get-open-api-document [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings get-product`

Calls GET /api/trpc/settings.getProduct.

notploy settings get-product [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings get-release-tag`

Calls GET /api/trpc/settings.getReleaseTag.

notploy settings get-release-tag [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings get-traefik-overview`

Calls GET /api/trpc/settings.getTraefikOverview.

notploy settings get-traefik-overview [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings get-traefik-ports`

Calls GET /api/trpc/settings.getTraefikPorts.

notploy settings get-traefik-ports [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings get-update-data`

Calls POST /api/trpc/settings.getUpdateData.

notploy settings get-update-data [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings get-update-status`

Calls GET /api/trpc/settings.getUpdateStatus.

notploy settings get-update-status [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings get-web-server-ip-candidates`

Calls GET /api/trpc/settings.getWebServerIpCandidates.

notploy settings get-web-server-ip-candidates [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings get-web-server-settings`

Calls GET /api/trpc/settings.getWebServerSettings.

notploy settings get-web-server-settings [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings have-activate-requests`

Calls GET /api/trpc/settings.haveActivateRequests.

notploy settings have-activate-requests [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings have-traefik-dashboard-port-enabled`

Calls GET /api/trpc/settings.haveTraefikDashboardPortEnabled.

notploy settings have-traefik-dashboard-port-enabled [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings health`

Calls GET /api/trpc/settings.health.

notploy settings health [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings is-cloud`

Calls GET /api/trpc/settings.isCloud.

notploy settings is-cloud [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings is-user-subscribed`

Calls GET /api/trpc/settings.isUserSubscribed.

notploy settings is-user-subscribed [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings read-directories`

Calls GET /api/trpc/settings.readDirectories.

notploy settings read-directories [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings read-middleware-traefik-config`

Calls GET /api/trpc/settings.readMiddlewareTraefikConfig.

notploy settings read-middleware-traefik-config [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings read-traefik-config`

Calls GET /api/trpc/settings.readTraefikConfig.

notploy settings read-traefik-config [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings read-traefik-env`

Calls GET /api/trpc/settings.readTraefikEnv.

notploy settings read-traefik-env [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings read-traefik-file`

Calls GET /api/trpc/settings.readTraefikFile.

notploy settings read-traefik-file --path <value> [options]

Option	Type	Required	Allowed values
`--path <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings read-web-server-traefik-config`

Calls GET /api/trpc/settings.readWebServerTraefikConfig.

notploy settings read-web-server-traefik-config [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings reload-server`

Calls POST /api/trpc/settings.reloadServer.

notploy settings reload-server [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings reload-traefik`

Calls POST /api/trpc/settings.reloadTraefik.

notploy settings reload-traefik [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings save-sshprivate-key`

Calls POST /api/trpc/settings.saveSSHPrivateKey.

notploy settings save-sshprivate-key --sshPrivateKey <value> [options]

Option	Type	Required	Allowed values
`--sshPrivateKey <value>`	string	Yes	—
`--profile <name>`	string	No	—

`notploy settings setup-gpu`

Calls POST /api/trpc/settings.setupGPU.

notploy settings setup-gpu [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings toggle-dashboard`

Calls POST /api/trpc/settings.toggleDashboard.

notploy settings toggle-dashboard [options]

Option	Type	Required	Allowed values
`--enableDashboard [boolean]`	boolean	No	—
`--no-enableDashboard`	boolean	No	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings toggle-requests`

Calls POST /api/trpc/settings.toggleRequests.

notploy settings toggle-requests --enable [options]

Option	Type	Required	Allowed values
`--enable [boolean]`	boolean	Yes	—
`--profile <name>`	string	No	—

`notploy settings update-builds-concurrency`

Calls POST /api/trpc/settings.updateBuildsConcurrency.

notploy settings update-builds-concurrency --buildsConcurrency <value> [options]

Option	Type	Required	Allowed values
`--buildsConcurrency <value>`	number	Yes	—
`--profile <name>`	string	No	—

`notploy settings update-docker-cleanup`

Calls POST /api/trpc/settings.updateDockerCleanup.

notploy settings update-docker-cleanup --enableDockerCleanup [options]

Option	Type	Required	Allowed values
`--enableDockerCleanup [boolean]`	boolean	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings update-enforce-sso`

Calls POST /api/trpc/settings.updateEnforceSSO.

notploy settings update-enforce-sso --enforceSSO [options]

Option	Type	Required	Allowed values
`--enforceSSO [boolean]`	boolean	Yes	—
`--profile <name>`	string	No	—

`notploy settings update-log-cleanup`

Calls POST /api/trpc/settings.updateLogCleanup.

notploy settings update-log-cleanup --cronExpression <value> [options]

Option	Type	Required	Allowed values
`--cronExpression <value>`	string	Yes	—
`--profile <name>`	string	No	—

`notploy settings update-middleware-traefik-config`

Calls POST /api/trpc/settings.updateMiddlewareTraefikConfig.

notploy settings update-middleware-traefik-config --traefikConfig <value> [options]

Option	Type	Required	Allowed values
`--traefikConfig <value>`	string	Yes	—
`--profile <name>`	string	No	—

`notploy settings update-remote-servers-only`

Calls POST /api/trpc/settings.updateRemoteServersOnly.

notploy settings update-remote-servers-only --remoteServersOnly [options]

Option	Type	Required	Allowed values
`--remoteServersOnly [boolean]`	boolean	Yes	—
`--profile <name>`	string	No	—

`notploy settings update-server`

Calls POST /api/trpc/settings.updateServer.

notploy settings update-server [options]

Option	Type	Required	Allowed values
`--profile <name>`	string	No	—

`notploy settings update-server-ip`

Calls POST /api/trpc/settings.updateServerIp.

notploy settings update-server-ip --serverIp <value> [options]

Option	Type	Required	Allowed values
`--serverIp <value>`	string	Yes	—
`--profile <name>`	string	No	—

`notploy settings update-traefik-config`

Calls POST /api/trpc/settings.updateTraefikConfig.

notploy settings update-traefik-config --traefikConfig <value> [options]

Option	Type	Required	Allowed values
`--traefikConfig <value>`	string	Yes	—
`--profile <name>`	string	No	—

`notploy settings update-traefik-file`

Calls POST /api/trpc/settings.updateTraefikFile.

notploy settings update-traefik-file --path <value> --traefikConfig <value> [options]

Option	Type	Required	Allowed values
`--path <value>`	string	Yes	—
`--traefikConfig <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

`notploy settings update-traefik-ports`

Calls POST /api/trpc/settings.updateTraefikPorts.

notploy settings update-traefik-ports --additionalPorts <json> [options]

Option	Type	Required	Allowed values
`--serverId <value>`	string	No	—
`--additionalPorts <json>`	array	Yes	—
`--profile <name>`	string	No	—

`notploy settings update-web-server-traefik-config`

Calls POST /api/trpc/settings.updateWebServerTraefikConfig.

notploy settings update-web-server-traefik-config --traefikConfig <value> [options]

Option	Type	Required	Allowed values
`--traefikConfig <value>`	string	Yes	—
`--profile <name>`	string	No	—

`notploy settings write-traefik-env`

Calls POST /api/trpc/settings.writeTraefikEnv.

notploy settings write-traefik-env --env <value> [options]

Option	Type	Required	Allowed values
`--env <value>`	string	Yes	—
`--serverId <value>`	string	No	—
`--profile <name>`	string	No	—

On this page