Start and Stop Server Scripts (start-tc-server, stop-tc-server)
Use the start-tc-server script to run the Terracotta Server, optionally specifying a configuration file:
For Microsoft Windows:
[PROMPT] %BIGMEMORY_HOME%\server\bin\start-tc-server.bat ^
[-n <name of server>] [-f <config specification>]
For UNIX/Linux:
[PROMPT] ${BIGMEMORY_HOME}/server/bin/start-tc-server.sh \
[-n <name of server>] [-f <config specification>]
<config specification> can be one of:
Path to configuration file
URL to configuration file
<server host>:<tsa-port> of another running Terracotta Server
Note the following:
If no configuration is specified, a file named
tc-config.xml in the current working directory will be used.
If no configuration is specified and no file named
tc-config.xml is found in the current working directory, a default configuration will be used.
If no server is named, and more than one server exists in the configuration file used, an error is printed to standard out and no server is started.
Use the stop-tc-server script to cause the Terracotta Server to gracefully terminate:
For Microsoft Windows:
[PROMPT] %BIGMEMORY_HOME%\server\bin\stop-tc-server.bat <host-name> <jmx-port> <args>
For UNIX/Linux:
[PROMPT] ${BIGMEMORY_HOME}/server/bin/stop-tc-server.sh <host-name> <jmx-port> <args>
where <args> are:
[f]
<file-or-URL> – Specifies the tc-config file to use, as a file path or URL. For an SSL-secured server, a valid path to the self-signed certificate must have been specified in the server's configuration file.
[--force] – Force shutdown of the active server.
In production mode, if the stop-tc-server script detects that the mirror server in STANDBY state isn't reachable, it issues a warning and fails to shut down the active server. If failover is not a concern, you can override this behavior with the
--force flag. For information about production mode, see
Enabling Production Mode.
[n]
<server-name> – The name of the server to shut down. Defaults to the local host.
[s] – If the server is secured with a JMX password, then a username and password must be passed into the script.
[u] – Specify the JMX username. For an SSL-secured server, the user specified must have the "admin" role.
[w] – Specify the JMX password.
[k] – This flag causes invalid TMS SSL certificates to be ignored. Use this option to accept self-signed certificates (ones not signed by a trusted CA).
For more information, see "Setting up Server Security" in the BigMemory Max Security Guide.