0.79.1
Documentation

How to run it

The guides below are being written as the features settle. Where a page is still an outline it says so at the top rather than pretending otherwise.

Guides

Install

Preparing a Debian host, the packages ProxDock needs, and the first sign-in.

  • Supported platforms
  • Install
  • Knobs
  • Or do it by hand
  • After it installs
  • +4 more

First run

The setup wizard: creating the cluster, defining network zones and mapping them to interfaces.

  • What the installer left you
  • 1. Unlock
  • 2. Cluster
  • 3. Storage
  • Creating a pool from a blank disk
  • +5 more

Deploying an application

A real deploy from the bundled library, with a screenshot of every step and the transformation it produced.

  • 1. Pick a template, or bring your own
  • 2. Fill in what it needs
  • 3. Read what it will do
  • 4. Deploy
  • 5. What you get
  • +2 more

Compose files

What the transformation engine changes, what it refuses, and the variables a file may refer to.

  • What gets changed
  • What gets refused
  • Referring to your own identity
  • Reading the preview

Backups and restore

Send streams rather than tarballs, shipping offsite to S3 or a NAS, encryption at ship time, and restoring under a new name.

  • What a backup run does
  • Where backups go
  • Shipping looks after itself
  • Encryption
  • Restoring
  • +3 more

Storage and backup targets

Settings, Storage: adding an S3 or NAS destination, testing it, and pointing an application at it.

  • Adding an S3 target
  • Test before you save
  • NAS connections
  • Using one as a backup target
  • Sending a backup to it
  • +1 more

Running a cluster

Joining nodes, what quorum protects, and migrating an application between hosts.

  • How a request is served
  • Joining a node
  • What a healthy cluster looks like
  • Quorum
  • Accepting workloads
  • +5 more

Cloudflare Tunnel

Publishing applications to the internet at your own hostnames, with no port opened and a connector on every node.

  • What you need
  • Turning it on
  • One connector per node
  • Publishing an application
  • Migrations, unpublishing and deletion
  • +2 more

Reference

Architecture

How the pieces fit: the store, the orchestrator, ZFS, and where each decision is made.

  • The pieces
  • Two principles worth stating
  • Where decisions are made

Command line

The binary's small set of host-level subcommands, and why deploying is not one of them.

  • Subcommands
  • Flags
  • Getting back in
  • Scripting against ProxDock

Certificates

Per-node HTTPS over ACME DNS-01, per-application certificates, and using certificates you manage yourself.

  • A node's own certificate
  • Issuing publicly trusted certificates
  • Certificates you manage yourself
  • Certificates for applications
  • Configuring a domain
  • +3 more