Install AhsayCBS using Docker on 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>