Introduction

cwctl is the CLI tool used to install and manage a self-hosted OneLink Linux installation. cwctl aims to abstract away the common bash interactions with a OneLink installation and provide an easy-to-use syntax. This is not intended to be a full replacement. If you are running a OneLink instance installed from the managed Linux flow, cwctl may already be present as part of installation. Check if cwctl is already installed by
cwctl --version
If cwctl is not present, follow the steps below to install the managed installer CLI.

Install or Upgrade the Managed Installer CLI

If you used an older version of the install script (< 2.0), you will not have cwctl in your PATH. To install or upgrade the managed installer CLI,
wget https://one-link.kz/linux/install.sh -O /usr/local/bin/cwctl && chmod +x /usr/local/bin/cwctl
cwctl --help
The above command requires root access to install cwctl to /usr/local/bin.

Help

To learn more about the options supported by cwctl,
sudo cwctl --help
Whenever a new version of OneLink is released, use the following steps to upgrade your instance.
sudo cwctl --upgrade
This will upgrade your OneLink instance to the latest stable release. If you are running a custom branch in production, do not use this to upgrade.

Setup Nginx with SSL after installation

To set up Nginx with SSL after initial setup(if you answered no to webserver/SSL setup during the first install)
Please add an A record pointing to your OneLink instance IP before proceeding.
sudo cwctl --webserver
sudo cwctl --restart

Running Rails Console

sudo cwctl --console

Viewing Logs

For OneLink web (Rails) server logs use,
sudo cwctl --logs web
For OneLink worker (Sidekiq) server logs use,
sudo cwctl --logs worker

Version

To check the version of the managed installer CLI,
sudo cwctl --version