Product documentation
Citrix Virtual Apps and Desktops
Current Release Service 2507 LTSR 2411 2407 2402 LTSR 2311 2203 LTSR

Installing and Configuring Log Server

August 25, 2025
Contributed by: 
C
  1. Download the log server docker container image from Citrix downloads.
  2. Place the downloaded files in the same directory.
  3. Run the installer in the directory with terminal (Linux) or command prompt (Windows) and follow the instructions:

Note: On Port Selection

  • Ensure the selected port is not already in use.
  • Avoid using privileged ports (0–1023) as they require administrator or system-level permissions.
  • Verify that firewall rules allow traffic on the chosen port.
  • Use a port number within the valid range (0–65535), but avoid ports commonly used by system services to prevent conflicts.

Linux Installation 

chmod +x ./InstallLogServer

# Install with https mode with port 8443 with default path
./InstallLogServer --https --cert </path/your_private_cert_key.pfx> --port 8443

# Install with http mode, with port 8080 with default path
./InstallLogServer --port 8080

# Command to change the config path and data path of your choice with https mode
./InstallLogServer --https --cert </path/your_private_cert_key.pfx> --port 8443 --config /Path/LogServer/Config --database /Path/LogServer/Data

# Command to change the config path and data path of your choice with http mode
./InstallLogServer --port 8080 --config /Path/LogServer/Config --database /Path/LogServer/Data
<!--NeedCopy-->

After the installation, some useful script files are generated:

# In Linux, sh scripts will be generated

DownloadLogsByTime.sh  
DownloadLogsByWords.sh
GetAuthKey.sh  
ListMachines.sh
StartLogServer.sh
<!--NeedCopy-->

Use ./StartLogServer.sh to start the server. Check your configpath/weblogs.txt to confirm LogServer started successfully.

If the LogServer starts successfully you will see the below message in the weblogs file. Port 5000 is used by LogServer internally in docker containers with selected http or https protocol.

Now listening on: https://[::]:5000
<!--NeedCopy-->

If the log server was installed in HTTP mode, successful logs should show the below:

Now listening on: http://[::]:5000
<!--NeedCopy-->

Note:

  • The port configured in the installation step (8080 or 8443 or any port specified) should be used when configuring LogServer url in DDC, Storefront, VDA, etc.
  • Usually it takes 30s to 60s to start on Linux.

Windows Installation

Step 1: Install Docker Desktop (subscription may be required) for Windows on the log server VM. Step 2: Run the below commands to continue the installation.

Note:

The default location of Config and Database (Data) folders are created under C:\Users<username>\LogServer.You can change them with the commands below:

#Install with https mode with port 8443 with default path
InstallLogServer.exe --https --cert <c:\path\cert.pfx> --port 8443

#Install with http mode, with port 8080 with default path
InstallLogServer.exe --port 8080
#Command to change the config path and data path of your choice with https mode 
InstallLogServer.exe --https --cert <c:\path\cert.pfx> --port 8443 --config C:\LogServer\Config --database C:\LogServer\Datacmd

#Install with specific config path and data path
InstallLogServer.exe --port 8080 --config C:\LogServer\Config --database C:\LogServer\Datacmd
<!--NeedCopy-->

After the installation, a few useful script files are generated in the same directory where you saved the installer files.

Note:

You may move these files to a different location. However, remember the new location, as they will be required again when configuring the Log Server.

#In Windows, bat scripts will be generated in the same directory where you saved the installer files. 


DownloadLogsByTime.bat  
DownloadLogsByWords.bat  
GetAuthKey.bat  
ListMachines.bat  
StartLogServer.bat
<!--NeedCopy-->

Use StartLogServer.bat to start the log server.

Check your configpath\weblogs.txt to confirm LogServer started successfully

When the logs show the below, it means to say the Log Server has started successfully.

If the LogServer starts successfully you will see the below message in the weblogs file. Port 5000 is used by LogServer internally in docker containers with selected http or https protocol.

Now listening on: https://[::]:5000
<!--NeedCopy-->

If the log server was installed in HTTP mode, successful logs should show the below:

Now listening on: http://[::]:5000
<!--NeedCopy-->

Note:

  • The port configured in the installation step (8080 or 8443 or any port specified) should be used when configuring LogServer url in DDC, Storefront, VDA, etc.
  • Usually it takes 1~10 minutes depending upon the hardware in Windows.

Verify the Log Server

Open your browser on Log Server or VDA or DDC, visit http://YourLogServerFQDN:8080/Ping A response string “Pong UTC:08/19/2025 01:03:29“ will show in the browser.

Note:

Change port 8080 to your configured port if not using the default port, and change http to https if installed with HTTPS mode:

If the log server verification fail, please check the following logs: Run docker logs logserver to check docker logs. For Linux - $HOME/LogServer/Config/weblogs.txt (change $HOME/LogServer to your real installed path if not using default one)

For Windows - C:\Users\YourUserName\LogServer\Config\weblogs.txt (Change YourUserName to real username. Change C:\Users\YourUserName\LogServer to your real installed path if not using default one)

Advanced Configuration of Log Server

Run docker stop logserver to stop the logserver

By default, the log server is configured with the below values. To make the changes, edit the StartLogServer.sh or StartLogServer.bat if installed in windows.

-e MAX_RESERVE_DAYS=7 -e MAX_DISK_USAGE_PERCENTAGE=90 -e LOCAL_DOWN_ONLY=true -e OPENSEARCH_JAVA_OPTS=”-Xms2G -Xmx2G”

LogServer Configuration Options Default Value Value Range Description
MAX_RESERVE_DAYS 7 1~30 Log Server stores log entries max days based on the TimeStamp field. Logs that were inserted 7 days ago will be deleted. Check every 10 minutes.
MAX_DISK_USAGE_PERCENTAGE 90 10~90 Log Server monitors the data storage percentage. If the usage percentage is more than 90%, Log Server will delete old logs day by day until the usage percentage is less than 90%. Check every 10 minutes.
LOCAL_DOWN_ONLY true true/false If true, only the machine installed Log Server can visit the /Download/* APIs. If false, then other machines with AuthKey could visit the /Download/* APIs.
OPENSEARCH_JAVA_OPTS “-Xms2G -Xmx2G” 2G ~ MaxMem/2 Opensearch memory configurations. Provide more memory if there are a lot of machines that would send logs to Log Server.

Start the log server, using./StartLogServer.sh on Linux Start the log server using StartLogServer.bat on Windows.

To check if the changes are considered

Installing and Configuring Log Server
August 25, 2025
Contributed by: 
C
August 25, 2025
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.