CLI

During the installation of Buddy On-premises, a Command Line Tool for managing your installation will be installed as well. In this article we describe how to use it.

General commands

buddy feedback – lets you send feedback to our team
buddy version – shows the CLI and the standalone version (if it is installed)
buddy terms – shows the terms

Root commands

All commands below need to be executed by root users (on Ubuntu they should be executed together with thesudocommand).

  1. buddy logs – shows the logs from the application
  2. buddy clear-cache – clears the Docker cache (docker prune) as well as the filesystems and DinD (disk contents).
  3. buddy [--yes] restore– restores the backup The --yes flag restores the last backup it finds
  4. buddy [--yes] [--full] backup – makes the data backup The --yes flag makes it automatically, without user interaction (automatically deletes old backups) The --full flag enables full cache backup (by default we make backup without filesystems and Docker cache)
  5. buddy start – starts the application
  6. buddy restart – restarts the application
  7. buddy stop – stops the application
  8. buddy configure – lets you configure the application. See below for details.
  9. buddy [--yes] uninstall – lets you delete the standalone (CLI has to be deleted manually) The --yes flag enables doing it without user interaction
  10. buddy [--yes] update – lets you download a new version of the application The --yes flag enables doing it without user interaction
  11. buddy status – shows the status of the application and all its components (Docker images)

Buddy configure options

These options are available upon running buddy configure:

  1. Exit configuration

  2. Custom domain

  3. Custom domain SSL certificate

  4. Application data path (you can move the data to another partition or disk)

  5. IP & ports. Here you can set:

    • external IP – what is opened in the browser
    • server IP – the IP to which the application on the server will be bound (by default all the interfaces on the server)
    • HTTPS port (443 is set by default)
    • HTTP port (80 is set by default)
    • Git SSH port (22 is set by default)
  6. Reset workspace owner password (shows the e-mail and the token to log in)

  7. Build CPU limit

  8. Build memory limit

  9. Concurrent executions limit

  10. Parallel actions limit

  11. Amazon SNS (SMS service)

  12. Repo max file size

  13. HAProxy ciphers

  14. Application memory management