CLI commands

Executing apleno-server without any additional parameters will normally start the server as expected. Additionally, some parameters can modify Apleno Server. You can see all the parameters with apleno-server -h:

Apleno Server v2.10.1

  Usage:
    command [options]

  Default command is server.

  Available commands:
    admin change-password             Change the password for an administrator.
    admin auth-local enable|disable   Enable/disable local username/password sign-in (break-glass recovery if SSO is misconfigured).
    backup create [--apps] [--files]  Create a new backup.
    backup restore <FILE>             Restore a backup.
    help                              Display this help.
    server                            Start Apleno server in foreground.
    service install                   Install a service on the system for running Apleno Server in the background.
    service start                     Start the Apleno server service.
    service stop                      Stop the Apleno server service.
    service uninstall                 Remove the Apleno server service from the system.
    test smtp <email>                 Send a test email to verify SMTP settings.
    test net [azure|pgm]              Test outgoing connectivity to external APIs.
    version                           Show the Apleno server version.

Note

The service * commands only work on Windows for now.

Examples

Change the password of an existing administrator (you will be prompted for their email and a new password):

apleno-server admin change-password

Temporarily re-enable local username/password sign-in if SSO is misconfigured and nobody can sign in:

apleno-server admin auth-local enable

Create a full backup (apps and user files):

apleno-server backup create --apps --files

Restore a backup from a file:

apleno-server backup restore my-backup.zip

Test that SMTP is correctly configured:

apleno-server test smtp me@example.com