Setup

System requirements

• Debian Operating System
• at least 1 CPU
• at least 1GB RAM
• at least 512MB disk storage

Installation

Zuthree Manager is being distributed through a dedicated repository.

1. Add Zuthree Manager repository to your apt repositories:

   sudo curl -fsSL http://repository.zuthree.com/pgp-key.public -o /etc/apt/keyrings/zuthree-pgp-key.public

   echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/zuthree-pgp-key.public] http://repository.zuthree.com/debian stable main" \
     | sudo tee /etc/apt/sources.list.d/zuthree.list

   sudo apt-get update

2. Install Zuthree Manager:

   sudo apt-get install zuthree

3. Verify the installation:

   sudo zuthree --help

Activate your license

To use Zuthree Manager, a valid license must be purchased and activated. Purchase your Zuthree Manager license by providing your License Request on zuthree.com.

Generate License Request

New to Zuthree Manager? Follow these steps:

1. Run Zuthree Manager:

   sudo zuthree

2. Copy your License Request from the command output. Alternatively, you can copy a file named license-request.zuthree, located at /root/.zuthree/license-request.zuthree by default.
3. Go to zuthree.com and follow the instructions.

Apply License Key

Once you have obtained a License Key from zuthree.com, apply it by running:

sudo zuthree --license __your_license_key__

Update License Key

If your license expired, or you’ve upgraded you license, you will need to update it in the application. To update your license run:

sudo zuthree update-license --license __your_license_key__

Configuration

The recommended approach for running Zuthree Manager is as a systemd service. While you can specify configuration parameters when starting the service using the systemctl start command, it is highly recommended to use a dedicated configuration file.

To create your config file run:

sudo zuthree save-config __your_arguments__

This command will save your arguments to a configuration file. This file will be read each time Zuthree Manager starts, allowing the systemctl service to run without requiring additional arguments.

You can list all possible arguments by running:

sudo zuthree save-config --help

Caution

For security reasons, we strongly advise against storing your database password directly in the configuration file. Instead, we recommend setting the database password using the ZUTHREE_DATABASE_PASSWORD environment variable. For more details, see below.

Using the ZUTHREE_DATABASE_PASSWORD environment variable

1. Edit the root .bashrc file:
   nano

   sudo nano /root/.bashrc

   vim

   sudo vim /root/.bashrc

2. Export ZUTHREE_DATABASE_PASSWORD environment variable:
   nano
   1. Add this line to the end of the file:

      export ZUTHREE_DATABASE_PASSWORD=__your_password__

   2. Press Ctrl + X to save changes.
   vim
   1. Press i to enter insert mode.
   2. Type:

      export ZUTHREE_DATABASE_PASSWORD=__your_password__

   3. Press escape button to exit insert mode.
   4. Type :wq to save changes.
3. Save changes
   nano

   Press Ctrl+X

   vim

   Type in :wq and press enter

Starting service

Zuthree Manager installation includes a service to run the application.

To automatically start Zuthree Manager when your server boots, run:

sudo sytemctl enable zuthree

To start your service and application, run:

sudo systemctl start zuthree

To check the service status, run:

sudo systemctl status zuthree

Monitoring service

There are two ways to view Zuthree Manager logs:

journalctl

To use the system journal, run:

sudo journalctl -u zuthree

To view incoming logs in real-time, add the -f flag.

sudo journalctl -u zuthree -f

json logs

Zuthree Manager stores the last 7 days of logs in JSON format within the storage folder by default. You can view these logs using your preferred tools or directly in the console with:

ls -alh /root/.zuthree/storage/logs # to list all the log files
cat /root/.zuthree/storage/logs/zuthree-2024-12-31-01.log

Older logs are compressed into .gz files. To view them, run:

zcat /root/.zuthree/storage/logs/zuthree-2024-12-31-01.log.gz

Use the jq application to format the output. You may need to install it separately.

cat /opt/zuthree/storage/logs/zuthree-2024-12-31-01.log | jq

Uninstallation

To remove Zuthree Manager run:

Debian

sudo apt-get remove zuthree

This will stop the Zuthree Manager service if it was running and will remove it from your system. This will not remove your data in the application or applied license to it, thus if you reinstall Zuthree Manager you will still have access to it. To remove all data associated to it, you need to remove its files. If you did not change default config (—config argument) or storage location (—storage argument), run:

Debian

sudo rm -rf /root/.zuthree

Otherwise, remove /root/.zuthree with the command above to remove your license information and your config and storage locations separately.