Skip to main content

Xylok Manager

The primary interface into the Xylok container is the script at /opt/xylok/xylok. This master script managers starting, stopping, destroying, and executing commands inside the Xylok Scanner containers. The full list of subcommands and their options is can be retrieved using the "--help" flag, but the most common are:

  • start/stop/destroy/rebuild - Starts all Xylok containers needed for execution. Generally Xylok should be controlled via systemctl start/ stop / restart
  • exec - Run a command inside an existing Xylok container. If no arguments are given, bash will be run inside the container. The starting working directory inside the container is the pass-through directory, /_passthrough.
  • pt - Helpers for working with the user-data directory.
    • pt loc will print the host location of the external pass-through directory
    • pt fix will correct the permissions of all files in the pass-through directory, ensuring they are owned and read/writable by
  • logs - Retrieve all the logs from all Xylok containers, optionally saved to a file and compressed to send to Xylok support for debugging. By default, this creates a ZIP with all logs included. For on-the-fly debugging, use the -f flag to follow logs as they are generated.
  • systemd - Manage Xylok systemd unit file.

This management utility also includes experimental support for Podman, which will be used automatically if Docker is not detected. If any issues are encountered, please contact [email protected].

xylok-manager.py

Depending on your initial installation date, there may also be a xylok-manager.py or .xylok-manager.py file. This is the main logic of the Xylok Manager script, but generally it shouldn't be used directly--the extension-less /opt/xylok/xylok script takes care of setting some environment information.