Administration

Frequently Used Commands

Reset Administrator Password

In case of losing the password generated during installation, or if you need to update it, use the following command:

./abcd-lite config update password

Enable or Disable External Access to ABCD Lite Admin Panel

To enable external access to the admin panel, run the following command and restart the IIS site:

./abcd-lite config update web mode default

To disable access, use paranoid instead of default.

Update Application Port

To update the port, run the following command:

./abcd-lite config update web port 12345

Important

Don't forget to change the port number to the required one.

You may need to restart the IIS site after updating the port.

CLI Usage

Most operations with the service itself are performed through the command line. Below is information about some commands.

ABCD Lite

Usage:
  abcd-lite [flags]
  abcd-lite [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  config      Configuration utilities
  help        Help about any command
  run         Run the ABCD Lite server

Flags:
  -h, --help   help for abcd-lite

Use "abcd-lite [command] --help" for more information about a command.

Configuration

Main service configuration menu.

Configuration utilities

Usage:
  abcd-lite config [command]

Available Commands:
  generate    Generate a default config file
  update      Update configuration

Flags:
  -h, --help   help for config

Use "abcd-lite config [command] --help" for more information about a command.

Generate Configuration File

This command is used during installation to create the initial application configuration state.

The paranoid flag is available to create a more secure web server configuration than the default. For more details, see the Installation section.

Generate a default config file

Usage:
  abcd-lite config generate [flags]

Flags:
  -h, --help       help for generate
      --paranoid   Use paranoid IIS web.config

Update Configuration

Used to update service configuration. For example, to change the port used by the service or to restore the administrator password.

Update configuration

Usage:
  abcd-lite config update [command]

Available Commands:
  password    Update admin password
  web         Update web configuration

Flags:
  -h, --help   help for update

Use "abcd-lite config update [command] --help" for more information about a command.

Run

This command starts the service in interactive mode.

Production Warning

This startup method is not suitable for production mode. For production, it's better to use a Windows service. For more details, see the Installation section.

Run the ABCD Lite server

Usage:
  abcd-lite run [flags]

Flags:
  -h, --help   help for run

Update Web Server Configuration

Update web configuration

Usage:
  abcd-lite config update web [command]

Available Commands:
  jwt-secret  Update JWT secret in app config
  mode        Update web mode (default or paranoid)
  port        Update web port in both IIS and app config

Flags:
  -h, --help   help for web

Use "abcd-lite config update web [command] --help" for more information about a command.

mode

Updates the IIS configuration file. Designed to provide or deny access to the application admin panel from outside (beyond the server where ABCD Lite is installed).

Update web mode (default or paranoid)

Usage:
  abcd-lite config update web mode [default|paranoid] [flags]

Flags:
  -h, --help   help for mode

port

Updates the port used by the application.

Update web port in both IIS and app config

Usage:
  abcd-lite config update web port [port] [flags]

Flags:
  -h, --help   help for port

jwt-secret

In normal circumstances, you won't need this command. However, it updates the secret key for signing JWT tokens. For more information about JWT, see: https://www.jwt.io/introduction.

Documentation