Saturday 7 January 2023

Xlog is designed to be accessed by trusted clients inside trusted environments. This means that usually it is not a good idea to expose the Xlog instance directly to the internet or, in general, to an environment where untrusted clients can directly access the Xlog TCP port.

If you want to expose it over unsecure HTTP (for development purposes or in LAN), please use --serve-insecure true flag.

Listening on specific network interface

Xlog accepts --bind flag that defines the interface which xlog should listen to. --bind is in the format <ip.address.of.interface>:<port>.

  • To listen on all interfaces on port 3000 pass --bind
  • To listen on specific interface pass the interface IP address --bind

Readonly mode

Xlog accept a --readonly flag to signal all features not to write to the disk. Readonly mode is not a safe measure for exposing the server to the internet. additionally make sure you sandbox the process in a restricted environment such as docker, CGROUPS or another user that has readonly access to the disk.

Extensions can ignore the readonly flag so make sure you use trusted extensions only in case you intend to expose xlog to the internet.

Reporting Security Issues

Please report any issues to me on Keybase: