🗃️ Installation
5 items
📄️ Active Directory Login
Xylok's AD Login provides seamless single sign on (SSO) for Xylok on intranet environments that use Windows Server 2012 R2, 2016, or Microsoft Azure AD. Xylok leverages the djangoauthadfs package to enable this, so most of the configuration details will be available from its documentation, found at https://django-auth-adfs.readthedocs.io/en/latest/config_guides.html.
📄️ Backups
As always, please contact us if you need assistance setting up backups or restoring data.
📄️ Benchmark Management
Updating and Update Frequency
📄️ Changing Host Systems
There are several options for moving a Xylok installation from on host machine to another, including:
📄️ Configuration Options
Configuration File
📄️ Directory Layout and Storage
Default Installation Location
📄️ File Portal - Installers, Licenses, and Release Notes
Initial installation and updates use the same installer. If you're performing a clean installation, the same self-extracting
📄️ Helper Command Line Utilities
Xylok includes many helper scripts in the install location (/opt/xylok) by default. These are generally just a few lines long and just call into the Xylok Manager, possibly after copying some files around.
📄️ HTTPS and SSL Certificates
When Xylok starts, it loads whatever PEM-format certificate and private key file are in /opt/xylok/certs. These files must be called cert.crt and key.key, for the certificate and private key respectively. If desired, these files can be replaced by your own certificates. After replacing these certificates, restart Xylok to apply.
📄️ Licensing
Download License
📄️ Security and Hardening
System Components
📄️ User Management
Any user in your organization with "Staff" access can reach the Database Admin site and manage your users. To access this page, at the bottom left of any page go to the user directory and choose "Database Admin."
📄️ Working with the Container
Xylok is installed by default to /opt/xylok. However, Xylok itself is running inside a container, via Docker or Podman. This introduces complications on working with it via the command line, because the processes inside the container can only access host files and directories that were explicitly mounted when the container was created. The majority of these mounts are in /var/lib/xylok and used to store the database and other data. For files that the user needs to access inside the container, a pass-through directory is mounted. On the host, this directory is at /opt/xylok/passthrough by default. Inside the container, the same files can be accessed at /passthrough.
📄️ 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: