---
name: "sxsetup.conf"
section: "5"
platform: "linux"
package: "sx"
version: "2.0+ds-4+b1"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/sxsetup.conf"
---

# sxsetup.conf(5)

configuration file for sxsetup

## NAME

sxsetup.conf - configuration file for sxsetup

## DESCRIPTION

The file contains configuration options for [**sxsetup**(8)](/sxsetup/8.md), used to automatically setup a node and join it to a cluster.

## OPTIONS

The options are specified in the format of **OPTION**="*VALUE*"

- **SX\_CLUSTER\_NAME**="*NAME*"

  Name of the cluster.

- **SX\_DATA\_DIR**="*PATH*"

  Path to the local storage directory.

- **SX\_RUN\_DIR**="*PATH*"

  Path to the local state directory.

- **SX\_LIB\_DIR**="*PATH*"

  Path to the local lib directory.

- **SX\_LOG\_FILE**="*PATH*"

  Path to the log file of [**sx.fcgi**(8)](/sx.fcgi/8.md).

- **SX\_NODE\_SIZE**="*SIZE*"

  Size of the node in bytes (use M, G, T for other sizes).

- **SX\_NODE\_IP**="*IPADDR*"

  Public IP address of the node.

- **SX\_NODE\_INTERNAL\_IP**="*IPADDR*"

  Internal IP address of the node (optional).

- **SX\_EXISTING\_NODE\_IP**="*IPADDR*"

  The IP address of an existing node in the cluster, used when joining the node to already existing cluster.

- **SX\_SERVER\_USER**="*NAME*"

  Name of the user, which will own the local storage and run [**sx.fcgi**(8)](/sx.fcgi/8.md).

- **SX\_SERVER\_GROUP**="*NAME*"

  Name of the group, which will have access to the local storage and run [**sx.fcgi**(8)](/sx.fcgi/8.md).

- **SX\_CHILDREN\_NUM**="*NUMBER*"

  Number of workers used by [**sx.fcgi**(8)](/sx.fcgi/8.md).

- **SX\_PORT**="*NUMBER*"

  The port number on which the node will communicate (must be the same across the cluster).

- **SX\_USE\_SSL**="*yes/no*"

  Whether to use secure communication.

- **SX\_SSL\_KEY\_FILE**="*PATH*"

  Path to the SSL key file.

- **SX\_SSL\_CERT\_FILE**="*PATH*"

  Path to the SSL certificate file.

- **SX\_SSL\_KEY**="*SSL\_KEY\_CONTENTS*"

  Contents of the SSL key. The key will be stored under **SX\_SSL\_KEY\_FILE**.

- **SX\_SSL\_CERT**="*SSL\_CERT\_CONTENTS*"

  Contents of the SSL certificate. The certificate will be stored under **SX\_SSL\_CERT\_FILE**.

- **SX\_CLUSTER\_UUID**="*UUID*"

  The UUID of the cluster (used when joining existing cluster).

- **SX\_CLUSTER\_KEY**="*KEY*"

  Secret key of the cluster (used when joining existing cluster).

- **SX\_ADMIN\_KEY**="*KEY*"

  Secret key of the cluster administrator (used when joining existing cluster).

- **SX\_CFG\_VERSION**="*NUMBER*"

  Version number of the config file format (currently 2).

## FURTHER DOCUMENTATION

Full documentation with additional examples available at: \<http://www.skylable.com/docs/\>

## SEE ALSO

[**sxsetup**(8)](/sxsetup/8.md), [**sx.fcgi**(8)](/sx.fcgi/8.md), [**sxadm**(8)](/sxadm/8.md)