Install AhsayCBS

Install AhsayCBS in the following:

• Windows
• Windows Server Core
• Linux / FreeBSD
• Docker in Windows
• Docker in Linux
• Docker in QNAP

Windows

1. Click on the arrow on the right of the downloaded installer then click Open.

   

   Alternatively, double click the downloaded installer.

   

2. Click Run once you see the following message.

   

3. Choose the language, and then click OK to continue.

   

4. Click Next to continue.

   

5. Select I accept the agreement after reading the license agreement, then click Next to proceed.

   

6. Choose the installation directory. Then, click Next to continue.

   

7. Click Next to continue.

   

8. Enter the ports to be used by AhsayCBS. By default, the ports are 80 and 443 (HTTP and HTTPS respectively). If these ports have been used by other applications, e.g. Microsoft IIS, Apache or other applications, please use alternative ports such as 8080 and 8443. Click Next to continue when you are done setting.

   

9. Click Install to start the installation.

   

10. Click Finish to complete the installation.

    

Windows Server Core

1. Use the "C:\temp\cbs-win.exe" command to execute the installer.

   

2. Choose the language, and then click OK to continue.

   

3. Click Next to continue.

   

4. Select I accept the agreement after reading the license agreement, then click Next to proceed.

   

5. Choose the installation directory. Then, click Next to continue.

   

6. Click Next to continue.

   

7. Enter the ports to be used by AhsayCBS. By default, the ports are 80 and 443 (HTTP and HTTPS respectively). If these ports have been used by other applications, e.g. Microsoft IIS, Apache or other applications, please use alternative ports such as 8080 and 8443. Click Next to continue when you are done setting.

   

8. Click Install to start the installation.

   

9. Click Finish to complete the installation.

   

   Untick the “Administrator Login” checkbox before clicking Finish.

   If you forgot to untick the “Administrator Login” checkbox before clicking Finish you will get a rundll error. You can ignore this message since the missing “url.dll” is only used to launch the AhsayCBS web console in a browser.

   

Linux / FreeBSD

1. Use the "tar" command to extract the downloaded cbs-nix.tar.gz installation file.

   

2. Go to the bin folder then run the "install.sh" script to start the installation process.

   

3. Only on FreeBSD, when asked to enter the java 1.8 home, type the following:

   "/usr/local/openjdk8" which is the location of your java 1.8 home but the path may be different depending on the installed java.

   

   Installation will continue after providing the path to java 1.8 home

   

4. After successful installation, you can access the AhsayCBS login page by opening https://your-backup-server in a browser.

   

Docker in Windows

1. Install WSL

   To enable the features necessary to run WSL and install the Ubuntu distribution of Linux, run the command in Powershell:

   wsl --install 

   

2. Install Docker Desktop on Windows
    

   1. Download the installer from the Docker Desktop release notes page.

      

   2. Run the installer.
       

      1. Double-click the Docker Desktop Installer.exe to run the installer. By default, Docker Desktop is installed at C:\Program Files\Docker\Docker.

         

      2. By default, the "Use WSL 2 instead of Hyper-V" option is ticked on the Configuration page. Modify the option depending on your choice of backend.

         

      3. Follow the instructions on the installation wizard to authorize the installer and proceed with the install.

         

      4. When the installation is successful, click Close and logout to complete the installation process.

         

   3. Add user to docker-users group.
       

      1. Run Computer Management as an administrator.

         

      2. Go to Local Users and Groups > Groups > docker-users.

         

      3. Right-click to add your Windows user account to the group.

         

      4. Sign out and sign back in for the changes to take effect.

3. Create and Start Containers

   Run the following in the command prompt:

   docker run --name <container name> -d -p <optional IP>:<http port>:80 -p <optional IP>:<http port>:443 -v <local user home>:/user -v <local conf folder>:/config -v <local system folder>:/system -v <local log folder>:/logs <AhsayCBS docker hub account>/<project name>:<image tag> 

   

   Example:

   docker run --name cbs9 -d -p 80:80 -p 443:443 -v user:/user -v config:/config -v system:/system -v logs:/logs ahsay/cbs9:91120 

   

   The local volume folder structure will automatically create and clone the default configuration if it does not exist or use the existing one which is the default volume path.

   \\wsl$\docker-desktop-data\data\docker\volumes

   The volume can also be accessed via the Docker Desktop console

   \\wsl$\docker-desktop-data\data\docker\volumes\config\_data
   \\wsl$\docker-desktop-data\data\docker\volumes\logs\_data
   \\wsl$\docker-desktop-data\data\docker\volumes\system\_data
   \\wsl$\docker-desktop-data\data\docker\volumes\user\_data
   

   

4. Access AhsayCBS
    

   1. Open the Docker Desktop.

      

   2. AhsayCBS has been installed. You can access this by clicking on the port, you can choose from 443 or 80.

      

   3. AhsayCBS web console will be displayed.

      

5. Other Functions

   Stop and Start Containers

   • Using the command prompt:

     docker start <container name>
     docker stop <container name> 

   • Using the Docker Desktop console:

     Go to Containers > <container name> > Action > Stop/Start

     

   Recreate the container

   Run using the command prompt:

   docker stop <container name>
   docker rm <container name> 

   Example:

   docker run --name cbs9 -d -p 80:80 -p 443:443 -v user:/user -v config:/config -v system:/system -v logs:/logs ahsay/cbs9:latest 

   Clean up Docker Environment

   If issues are encountered and there is a need to remove all Docker containers and images:

   • Using the command prompt:

     docker rm <container name>
     docker rmi <image name> 

   • Using the Docker Desktop console:

     Go to Containers > <container name> > Action > Delete

     

     Go to Images > <image name> > Action > Delete

     

Upgrade AhsayCBS

1. Stop the container.

   docker stop <container name>

2. Remove the container.

   docker rm <container name>

3. Download the update.

   docker run --name <container name> -d -p <optional IP>:<http port>:80 -p <optional IP>:<https port>:443 \
   				-v <local user home>:/user \
   				-v <local conf folder>:/config \
   				-v <local system folder>:/system \
   				-v <local log folder>:/logs \
   				<AhsayCBS docker hub account>/<project name>:<image tag> 

Docker in Linux

Setting up Ubuntu Environment

Before starting the installation, prepare the Ubuntu environment first by running the following commands using the terminal:

1. To update the package list for upgrades and new package installations.

   apt-get update -y

   

2. To install necessary packages for Docker, including certificates, curl, GnuPG, LSB release information and lsof (used to list open files).

   sudo apt-get install ca-certificates curl gnupg lsb-release lsof -y 

   

3. To add Docker's official GPG key to ensure authenticity of Docker packages.

   curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg 

   

4. To setup a repository for Docker.

   echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null 

   

5. To update the package list again to include the Docker repository.

   apt-get update -y 

   

6. To install the Docker Engine, Docker CLI and containerd, which are required for running containers.

   apt-get install docker-ce docker-ce-cli containerd.io -y 

   

7. To add the current user to the docker group.

   sudo usermod -aG docker <current user> 

   

   If the docker group is not created automatically, create the group by running this command:

   sudo groupadd docker

   

Create and Start Containers

Run the following in the terminal:

1. To create the AhsayCBS Docker root folder.

   sudo mkdir /usr/local/cbs
   sudo chown $(id -u):$(id -g) /usr/local/cbs
   cd /usr/local/cbs

   

2. To create the AhsayCBS docker with latest release version.

   docker run --name <container name> -d -p <optional IP>:<http port>:80 -p <optional IP>:<http port>:443 -v <local user home>:/user -v <local conf folder>:/config -v <local system folder>:/system -v <local log folder>:/logs <AhsayCBS docker hub account>/<project name>:<image tag> 

   Example:

   docker run --name cbs9 -d -p 80:80 -p 443:443 -v ./user:/user -v ./config:/config -v ./system:/system -v ./logs:/logs ahsay/cbs9:latest 

   

   Specific release version may also be used (e.g. 9.11.2.0) by replacing "ahsay/cbs9:latest" with the specific version (e.g. ahsay/cbs9:91120)

The local server's folder structure for the above example will automatically create and clone the default configuration if it does not exist, or it will use the existing folder and configuration file.

/usr/local/cbs/config
/usr/local/cbs/logs
/usr/local/cbs/system
/usr/local/cbs/user 

To check the Docker status:

docker ps -a

Access AhsayCBS

Access the AhsayCBS web console at https://<your_backup_server>.

Other Functions

Stop and Start Container

Run using the terminal:

docker start <container name>
docker stop <container name> 

Recreate the Container

Run using the terminal:

docker stop <container name>
docker rm <container name>
docker run --name <container name> -d -p <optional IP>:<http port>:80 -p <optional IP>:<http port>443 -v <local user home>:/user -v <local conf folder>:/config -v <local system folder>:/system -v <local log folder>:/logs <AhsayCBS docker hub account>/ <project name>:<image tag> 

Example:

docker run --name cbs9 -d -p 80:80 -p 443:443 -v ./user:/user -v ./config:/config -v ./system:/system -v ./logs:/logs ahsay/cbs9:latest 

Clean Up Docker Environment

If issues are encountered and there is a need to remove all Docker containers and images, run the following commands using the terminal:

docker stop $(docker ps -ag)
docker rm $(docker ps -ag)
docker rmi $(docker images -q) 

Upgrade AhsayCBS

Please refer to the upgrade instructions in the previous section.

Docker in QNAP

1. Install Container Station 
    
   1. Log in to QNAP web interface by opening a web browser and typing the IP address of your QNAP device. (e.g. http://<your-QNAP-IP>).

   2. Open the App Center. From "Utilities" or "QTS Essentials", search for Container Station.

      

   3. Click Install and wait for the installation to complete.

      

2. Prepare Container Station 
    

   1. Click Container Station on the Main menu.

      

   2. Select your preferred folder and click Start.

      

      It will ask for the default folder to be used to store images and containers only during first time use of Container Station.

   3. Click Yes in the "Data Collection Agreement" prompt.

      

   4. In the File Station, check if a container folder with subfolders are created.

      

3. Create folder for AhsayCBS data 
    

   1. Using an SSH tool (e.g. Putty), access QNAP and log in with your username and password.

      

   2. Create a new folder for the AhsayCBS data by using the following command.

      mkdir /share/<QNAP data volume>/<AhsayCBS root folder>

      Example:

      

      In the example above, "test" is the QNAP data volume and "cbs" is the AhsayCBS root folder.

   3. Verify that the AhsayCBS folder is created by checking the File Station.

      

      Make sure to create the AhsayCBS folder in a shared folder to view the data inside that will be created once Docker CBS is installed.

4. Pull image from Docker Hub

   Docker Hub is where the Docker images are stored, shared and distributed. Here, you can select what image to copy and pull to create a Docker container. You can select from the list which AhsayCBS version you want to install.

   1. Click Copy beside the version that you want to copy the command that will pull the image.

      

   2. Use an SSH tool, right click to paste the command then hit Enter. Wait for the pull to complete.

      

   3. The image should be added in the Images tab of the Container Station.

      

5. Create and Start Containers

   Run the following in the command prompt:

   docker run --name <container name> -d -p <optional IP>:<http port>:443 \
   				-v <local user home>:/user \
   				-v <local conf folder>:/config \
   				-v <local system folder>:/system \
   				-v <local log folder>:/logs \
   				<AhsayCBS docker hub account>/<project name>:<image tag> 

   • container name - assign a container name you want
   • optional IP - if you do not add the IP, the QNAP IP will be used
   • http port - you can assign any port but make sure that the port you will use is available and is not used by another service or container
   • local folders (user, config, system, logs) - use the cbs folder path to store the local folders
   • AhsayCBS docer hub account, project name and image tag - you can find it from the command used to pull the image

   Example:

   docker run --name cbs91320 -d -p 8443:8443 \ 
   				-v /share/test/cbs/user:/user \
   				-v /share/test/cbs/config:/config \
   				-v /share/test/cbs/system:/system \
   				-v /share/test/cbs/logs:/logs \
   				-v /share/test/cbs/work:/usr/local/cbs/work \
   				ahsayactest/cbs9:internal-latest 

   

   The local server's folder structure for the above example will automatically create and clone the default configuration if it does not exist, or it will use the existing folder and configuration file.

   • /usr/local/cbs/config
   • /usr/local/cbs/logs
   • /usr/local/cbs/system
   • /usr/local/cbs/work
   • /usr/local/cbs/user

   In Container Station, go to Containers and check if the container is created and running.

   

   To check the docker status use the command:

   docker ps -a

   

6. Access AhsayCBS:

   Open a web browser and enter the QNAP IP with the assigned port (e.g. https://10.3.0.129:8443) in the URL.

7. Other Functions

   Stop and Start Containers

   • Using the command prompt:

     docker start <container name>
      

     or

     docker stop <container name> 

   • Using the Container Station:

     Go to Containers > <container name> > Action > Stop/Start

     

   Recreate the container

   Run using the command prompt:

   docker stop <container name>
                           docker rm <container name> 

   docker rm <container name>
                           docker rm <container name> 

   docker run --name <container name> -d -p <optional IP>:<http port>:80 -p <optional IP>:<http port>:443 -v <local user home>:/user -v <local conf folder>:/config -v <local system folder>:/system -v <local log folder>:/logs <Ahsay CBS docker hub account>/<project name>:<image tag>
    

   Example:

   docker run --name cbs9 -d -p 80:80 -p 443:443 -v user:/user -v config:/config -v system:/system -v logs:/logs ahsay/cbs9:latest 

    

Upgrade AhsayCBS

1. Stop the container.

   docker stop <container name>

2. Remove the container.

   docker rm <container name>

3. Run the command for creating container using the latest version.

   docker run --name <container name> -d -p <optional IP>:<http port>:443 \
   				-v <local user home>:/user \
   				-v <local conf folder>:/config \
   				-v <local system folder>:/system \
   				-v <local log folder>:/logs \
   				<AhsayCBS docker hub account>/<project name>:<image tag>