Configuration¶
For the complete list of JetStream configuration options, please see jetstream server and jetstream relay_server command reference.
Editing Configuration¶
JetStream services use response files for configuration, which contain all arguments that would normally be given on the command line. The arguments can be specified on a single line or argument per line for better readability. For example /etc/jetstream-server.rsp
:
--api-allow-remote-control
--trigger-dir=/var/lib/jetstream/triggers
--persistent-state-dir=/var/lib/jetstream/state
After editing configuration response files for one of the services, you will need to restart the service in order for the changes to take effect.
See also
- jetstream server command options
- jetstream relay_server command options
- Managing System Services
Linux (CentOS, Ubuntu)¶
The jetstream-server
startup arguments can be specified in the /etc/jetstream-server.rsp
file, and jetstream-relay
startup arguments in the /etc/jetstream-relay.rsp
file.
macOS¶
The jetstream-server
startup arguments can be specified in the /usr/local/jetstream/etc/jetstream-server.rsp
file, and jetstream-relay
startup arguments in the /usr/local/jetstream/etc/jetstream-relay.rsp
file.
Windows¶
On Windows, all JetStream Server service startup arguments can be specified in the C:\Program Files\Jet Digital\JetStream Server\etc\jetstream-server.rsp
file, and JetStream Relay service startup arguments in the C:\Program Files\Jet Digital\JetStream Server\etc\jetstream-relay.rsp
file.
License Configuration¶
JetStream server requires a license to send or receive transfers.
To specify your license key, you need to add a --license-password
argument with the key that was provided to you as its contents.
For a paid license, you may have the option of hosting your own license server, in which case you can customize the --license-location
argument to
point to this license server. By default it points to a license server hosted by Jet Digital Inc. Please contact sales@gojetstream.io if you need to host
your own license server.
See also
- Editing Configuration
- jetstream server command options
Startup Configuration¶
In order for the JetStream server to know where to send the data, it needs to be configured with another JetStream server. This configuration is not persistent and needs to be done each time the jetstream-server
service restarts or the machine reboots. To avoid manual configuration each time, a launch trigger can be used to set this automatically.
Create a new or edit the existing launch trigger and add the following contents (Linux example):
#!/bin/sh
export JETSTREAM_API_PASSWORD=secret
/usr/local/bin/jetstream api --user <username> createDestination --destinationAddress <destination_address> --sendRateMax=100000
Here, we use JETSTREAM_API_PASSWORD
environment variable, to avoid using it in command line parameters, where it’s visible to users who have shell access to the server. <destination_address>
is the IP address of the remote JetStream server, and <username>
is a username used to authenticate against the local JetStream server. The --user
parameter is only required if JetStream is running as a privileged process. A password can be specified as an environment variable in the trigger file (see example above, or API documentation).
As this is a launch trigger, JetStream will only execute it at startup. If the JetStream server is already running, you’ll need to restart the jetstream-server
service, or execute the launch
script manually.