Configure after installation

What you will do: turn a freshly installed server into one you can keep: storage, memory, security, license, a first data source, and a check that every part works.

These steps apply to a V7 server on Linux, Windows or macOS. On the X8 Compose stack the storage paths and ports come from .env (Docker); the security, license, source and validation steps are the same in the console.

1. Point XPLG at external storage

Keep the configuration out of the installation folder so a reinstall, an upgrade or a cluster node can reuse it.

1. Create a folder on fast storage with full read and write for the XPLG user, for example /data/xplg/XPLGConfig (Linux) or D:\xplg\XPLGConfig (Windows).
2. In the console open PortX > Settings > General, tick Use external configuration directory, enter the absolute path and save. XPLG asks for a restart.
3. Restart, open the same page and confirm the path is still there. From now on everything XPLG knows lives in that folder; back it up (XPLG also keeps daily zips for 30 days under <extConf>/temp/backups/).

2. Set memory and JVM flags

All runtime parameters are on one line of the lax file: XpoLog.sh.lax (Linux, macOS) or XpoLog.lax (Windows), LAX.NL.JAVA.OPTION.ADDITIONAL. Every change needs a restart.

• -Xmx — the heap. Size it from the host: about 60 % of RAM on Linux, 70 % on Windows, never more than 32 GB per process. The installer default is 1 GB, which only suits a first try.
• -XX:+ExitOnOutOfMemoryError -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=<folder> — restart on out-of-memory and keep a dump for support.
• -Dfile.encoding=UTF-8 — or another Java encoding when sources use Chinese, Japanese, Korean or other non-default character sets.
• -Duser.language=en -Duser.region=US — only when dates and content from another region must be normalised.
• -Dhttps.proxyHost=<host> -Dhttps.proxyPort=<port> -DproxySet=true — only when Teams, Office 365, PagerDuty or Slack integrations must go through a proxy. XPLG itself needs no internet access.

On Linux also raise the limits of the user that runs XPLG in /etc/security/limits.conf (nofile 64000, nproc 20000), log out and in, verify with ulimit -n and ulimit -u, and restart XPLG. On Windows set the service's Log On account (Windows Server).

3. Activate security and replace the default account

1. PortX > Settings > Security: enable security. The internal realm is enough for an air-gapped site; SAML 2.0, AD/LDAP, Kerberos, OAuth/OpenID and header SSO are the enterprise options, with MFA enforced at the identity provider.
2. Create your own administrator, sign in with it, and disable or change the default account. Default credentials must not stay in use.
3. Create the groups and policies your teams need (Users → Groups → Policies, with per-folder, log and app View / Edit rights); keep the default group view-only.
4. Keep the default 30-minute idle timeout unless policy says otherwise.
5. Replace the self-signed certificate with your CA-signed keystore in ServletContainer/conf/server.xml and, when HTTPS is in place, set the HTTP port to 0.

4. Install the license

An evaluation license is created with your dock workspace; a subscription license is issued when an offer is accepted. One license covers a server or a whole cluster.

1. PortX > Settings > License: open the server-key section and copy the key (any node of a cluster gives the cluster's key).
2. Bind the key in dock on Licenses — see Get an evaluation license — or send it to XPLG for a subscription; you receive a .lic file.
3. Back on the License page upload the file or paste its text, save, and restart XPLG. A license must be renewed when it expires or when its terms change, for example a higher daily volume.

5. Connect the first source

• Push: create a listener under PortX > Data > Listeners — HTTP/S with a token for applications and Fluent Bit, or syslog on UDP 514 / TCP 1468 for devices — and point one source at it.
• Pull: PortX > Data > Add Data with an Address Book account: local or UNC files, SSH, Windows Events, S3, JDBC, cloud and SaaS plugins. XPLG needs read permission on everything it pulls; the wizard scans the path and unifies rotated files before you confirm.
• Every log lands in Folders and Logs with AppTags and a Collection Policy (schedule, hot path, retention, archive). Adjust the policy before the data grows.

The full list is in Sources.

6. Validate

1. XPLG > System > System Health: the node reports, Java 17 is listed under System Information, no license or disk alerts.
2. Folders and Logs shows the new log with recent data; Search returns events from it.
3. Monitors and Apps open; the installed version is in System > About.

If a step fails, Troubleshooting lists the usual causes.

7. Register with dock

Register the deployment: the first heartbeat creates the row on Deployments, binds the license and starts usage reporting. From then on the workspace shows version, status and usage for every server you run.

Next: Register a deployment

Source: XPLG wiki, pages 1594132180, 1594133274, 1594131986, 3161718811, 3161489438, 1595637847, 1594132976, 1689157633 (https://xpolog.atlassian.net/wiki/spaces/XPOL/pages/1594132180).