Console commands

Xeoma on Linux instruction

When you access Xeoma in a Terminal, you’ll get these regular commands displayed:

Usage: Xeoma [-command] [-argument]

Command Description
-help show this help
-core run server only
-client [password@address:port] run client only. Can be used without parameter, also password and port can be empty. For example: -client
-lls run License Server
-install [-argument] works with argument only
-install -allmanual install Server and client with manual start
-install -allauto install Server and client with auto start
-install -coreauto install Server (autoStart) and client (manualStart)
-install -hiddenmode install Server (autoStart) hidden mode used
-install -cloudauto install Cloud with auto start
-install -removeall remove all, include Archive and config files
-install -removeexe remove program, leave Archive and config files
-install -licauto install License Server with auto start
-installdir [DirPath] set install directory. ATTENTION! Path to dir must be in UTF-8 encoding!**
-stopservice stop Xeoma service (if installed)
-startservice start Xeoma service (if installed)
-restartservice restart Xeoma service (if installed)
-activateOnline [Serial] online activation (if activation of several Serial numbers is required, separate them with a comma (no spaces) OR enframe Serials with single quotes and separate them with ‘;’. For example: -activateOnline Serial1,Serial2)
-licenseServer [LicenseServer] license server for online activation. For example:
-activateRequest [Serial] offline activation (if activation of several Serial numbers is required, separate them with a comma (no spaces) OR enframe Serials with single quotes and separate them with ‘;’.)
-activateResponse [Activation] offline activation
-showpassword show current password and set enable network access
-startdelay [seconds] delay before starting in seconds
-log enable log for server events
-lang [Language] for English: en, for Russian: ru, etc.
-clientIndex [ClientID] client ID can contain only letters and numbers (no spaces, maximum 16 characters)
-individualsettings store personal settings individually for each client
-cloud start Cloud server with auto restart on crashes
-noguard use this parameter with -cloud to run Cloud without restart guard
-sampleconfig use this parameter with -cloud to generate sample config in Cloud mode
-nohup ignore the HUP (hangup) signal
-noscan disable camera scanning
-noscanptzandaudio disable scanning for ptz and audio url
-proxy [ProxyServerURL] set proxy server address*
-proxyclear remove stored proxy server address*
-noarchivedb disable archive database (search in archive will be not available)
-activateRetranslator [Serial] online activation of Repeater (if activation of several Serial numbers is required, separate them with a comma (no spaces) OR enframe Serials with single quotes and separate them with ‘;’. For example: -activateRetranslator ‘Serial1;Serial2’)
-noautoupdate forced restriction of auto updates for the server part
-serverport [PortNumber] set server port*
-setpassword [Password] set server password
-savepassword [1/0] allow password saving on client side
-reindexingArchive reindex archive and exit
-nolog disable log for server events
-fullscreen run Xeoma in fullscreen mode
-sslconnection [0/1/2] if 0 on the client – connect to server ignoring certificates; if 1 on the server – accept only secure connections from clients (to do that, generate and place the certificates into the Server and Client folders. See Xeoma folder > Security > Certificate > Readme.txt for details); if 2 on server or client – auto-detect certificates
-arducam enable using ArduCAM
-compressdb compress archive database
-uselocaltime use local time instead of UTC
-webaddr [WebAddr] change all addresses to specified
-enableconwithoutpass [UserName] enable connection without password within one minute
-archivecache [DirPath] path to cache directory (on RAM-disk or fast HDD) for speedup archive writing**
-connectioninfoport [PortNumber] set port for License Server (see -lls), default is 4200
-programdir [DirPath] set directory to unpack Xeoma’s files for the first launch**
-disableDownloads allows you to remove the Update option from the menu
-nosearchservers make Xeoma opt out of searching for any Xeoma servers in the network to connect to

* – if Xeoma is installed to autostart, this command only needs to be applied once, there is no need to add it to the autostart script.
** – make sure to put the required paths in quote marks, example: -programdir "/home/user1/Xeoma/"

Note: for -activateOnline if you want to use “;” instead of “,” as a delimiter, please put serials into ‘ ‘. For example: ./xeoma -activateOnline ‘LKB6CWP10WBPVW5KFGRЕ226UV;NK5XWLJUVММ9TММХСХDLV24E6’

Here are some additional commands you could take advantage of:

-setpassword MYPASS (set MYPASS or another password for Administrator profile, the password that is used for remote access)

-serverport 777 (set 777 as Xeoma port instead of the default 8090, can be any number).

You can edit Xeoma’s autostart script manually:

for Linux: /etc/systemd/system/XeomaCoreService (or /etc/init.d/XeomaCoreService)
for Mac: /Library/LaunchDaemons/XeomaCoreService.plist
for Windows: in the settings of services (Administrative Tools) or via the Registry (HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\services\XeomaCoreService)
Edit it with admin rights. Restart the server part thereafter.

-noscan (cancel initial search for cameras). Attention: doesn’t work for servers installed to autostart. See -serverport to learn how to make it work.

For a detailed instruction on how to work with Xeoma on Linux (with or without graphical shell), please see this article (troubleshooting included).

xeoma_software_advices Starting from the version Xeoma 22.11.25, a new feature to specify console command that will be added to the autostart script after installation has been added for console commands when installing Xeoma. For example, if you conduct -install -coreauto -serverport 8888, -serverport 8888 command will be added to the autostart script automatically. Previously, additional commands were not combined with the installation commands and they had to be specified manually in the autostart script.
Important advice from Xeoma Starting from the version of Xeoma 20.11.30 we added support for more separators when activating several license codes via console at once. Now you can separate several serial numbers with a comma or point. I.e. licenses can be activated via console using the command -activateOnline LICENSE,LICENSE or LICENSE.LICENSE.
To separate serial numbers with ; or even a space, you’d need to put serials in single frames, example: -activateOnline ‘LICENSE;LICENSE’ or -activateOnline ‘LICENSE LICENSE’

Changing camera layouts via configuration file

Starting from Xeoma 14.5.13, layouts can be controlled without the visual part via configuration file. For example, when integrated to your home automation system, it will help you choose camera layouts switch between live camera previews simply by pressing a button on a remote controller.

Changes should be applied to the Preview configuration file in Preview configuration folder in Xeoma’s directory:

# Use PreviewMode variable for setting preview mode, TabNumber for setting tab number.
# PreviewMode possible values are:
# 0 for all cameras
# 1 for 1×1
# 2 for 2×1
# 3 for 2×2
# 4 for 3×2
# 5 for 3×3
# 6 for 4×3
# 7 for 4×4
# 8 for 5×4
# 9 for 5×5
# 10 for 8×8

Replace 0 in PreviewMode=0 with 1 to enable the 1х1 layout (one camera on screen at a time), with 2 to enable the 2х1 layout, etc. Replace 0 in TabNumber=0 with the number of a tab you’d like to open. Please note: Xeoma should be launched and working when you apply those changes.