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 thesudo
command).
buddy logs
– shows the logs from the applicationbuddy clear-cache
– clears the Docker cache (docker prune
) as well as the filesystems and DinD (disk contents).buddy [--yes] restore
– restores the backup The--yes
flag restores the last backup it findsbuddy [--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)buddy start
– starts the applicationbuddy restart
– restarts the applicationbuddy stop
– stops the applicationbuddy configure
– lets you configure the application. See below for details.buddy [--yes] uninstall
– lets you delete the standalone (CLI has to be deleted manually) The--yes
flag enables doing it without user interactionbuddy [--yes] update
– lets you download a new version of the application The--yes
flag enables doing it without user interactionbuddy status
– shows the status of the application and all its components (Docker images)buddy diagnose
– analyzes your standalone and server configuration and returns information and tips on what might've gone wrong
Buddy configure options
These options are available upon running buddy configure
:
Exit configuration
Custom domain
Application data path (you can move the data to another partition or disk)
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)
Reset workspace owner password (shows the e-mail and the token to log in)
Build CPU limit
Build memory limit
Concurrent executions limit
Parallel actions limit
Repo max file size
HAProxy ciphers