GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SXSETUP.CONF (5)

NAME

sxsetup.conf - configuration file for sxsetup

CONTENTS

Description
Options
Further Documentation
See Also

DESCRIPTION

The file contains configuration options for sxsetup(8), 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_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_SERVER_GROUP="NAME"
  Name of the group, which will have access to the local storage and run sx.fcgi(8).
SX_CHILDREN_NUM="NUMBER"
  Number of workers used by sx.fcgi(8).
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), sx.fcgi(8), sxadm(8)
Search for    or go to Top of page |  Section 5 |  Main Index


sxsetup 1.2 SXSETUP.CONF (5) May 2015

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.