Enum Command 

pub enum Command {
    Serve {
        role: Option<RoleSet>,
    },
    Migrate,
    Init,
    Transfer {
        to: String,
        json: bool,
    },
    Account {
        command: AccountCommand,
    },
    Order {
        command: OrderCommand,
    },
    Audit {
        command: AuditCommand,
    },
    Jobs {
        command: JobsCommand,
    },
    Nonce {
        command: NonceCommand,
    },
    Profile {
        command: ProfileCommand,
    },
    Eab {
        command: EabCommand,
    },
    Filter {
        command: FilterCommand,
    },
    Upstream {
        command: UpstreamCommand,
    },
    Admin {
        command: AdminCommand,
    },
    Completions {
        shell: Shell,
    },
    Man,
}

Variants

Serve

Run the ACME HTTP(S) server. Default when no subcommand is given.

Fields

role: Option<RoleSet>

Which of the server’s three jobs this process does, comma-separated: acme, admin, worker. Defaults to all three in one process.

A split deployment runs the same binary and the same configuration several times, each naming its own roles. Only a process running worker applies migrations, generates first-run material and drains the job queue; the others check the schema and refuse if it is not current. An unknown role is refused with usage, exit 2.

Migrate

Apply any database migrations that have not run yet, then exit.

Opening the database no longer migrates it, so this is how a schema is brought up to date without starting a server. Safe to run repeatedly.

Init

Prepare a deployment: migrate, then generate whatever first-run material the configuration calls for (the local CA, an upstream account, a self-signed TLS certificate).

The one place that creates key material. A process that does not run the worker role refuses to generate any, so a split deployment runs this once before starting anything.

Transfer

Copy every row into another database, which must already exist, be migrated and be empty.

The configured database.url is the source, and each URL’s scheme picks its backend — so this is how a SQLite deployment becomes a PostgreSQL one, and the reverse is the same command with the two swapped. Stop the server first: a copy taken while something is writing is a torn snapshot, and nothing here can detect one.

Fields

to: String

The database to copy into.

json: bool

Print the per-table row counts as JSON.

Account

Inspect and manage ACME accounts.

Fields

command: AccountCommand

Order

Inspect and manage ACME orders.

Fields

command: OrderCommand

Audit

Read and prune the CA’s audit trail.

Fields

command: AuditCommand

Jobs

Inspect and manage the background job queue.

Fields

command: JobsCommand

Nonce

Count and prune the replay-nonce table.

Fields

command: NonceCommand

Profile

Inspect the ACME endpoints this configuration mounts.

Fields

command: ProfileCommand

Eab

Manage External Account Binding (EAB) credentials.

Fields

command: EabCommand

Filter

Read and test the access policy of an endpoint.

Fields

command: FilterCommand

Upstream

Manage this server’s own account at the upstream ACME server (signer.backend = "relay").

Fields

command: UpstreamCommand

Admin

Manage the web admin’s operators and their sessions. This is how the panel is bootstrapped: it has no sign-up page.

Fields

command: AdminCommand

Completions

Print a shell completion script on stdout.

Fields

shell: Shell

The shell to generate for.

Man

Print this binary’s man page, in roff, on stdout.

Trait Implementations

impl FromArgMatches for Command

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for Command

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand