JetStream Server
2.6.5
Getting Started
Requirements
Recommended Hardware
Operating Systems
Encryption
Network/Firewall
User Management
Required Dependencies
Optional Dependencies
Quickstart
Ubuntu 18.04
New Installation
Update Existing Installation
Next Steps
CentOS 7
New Installation
Update Existing Installation
Next Steps
macOS
New Installation
Update Existing Installation
Next Steps
Windows
Installation
Next Steps
Connecting To JetStream
Local Machine
Local Network
External Network
Technical Primer
Overview
Default Configuration
User Management
Where Do Transfers Go?
Managing JetStream
Setup
Installation
Ubuntu 18.04
New Installation
Update Existing Installation
Uninstall
Check Service
Check Server
Active Directory
Firewalls
CentOS
New Installation
Update Existing Installation
Uninstall
Check Service
Check Server
Active Directory
Firewalls
macOS
New Installation
Update Existing Installation
Uninstall
Check Service
Check Server
Firewalls
Windows
Install
Update
Uninstall
Check Server
Firewalls
Configuration
Editing Configuration
Linux (CentOS, Ubuntu)
macOS
Windows
License Configuration
Client Application
Command-line
API
Configuration File
System Services
CentOS 7, Ubuntu 18.04
macOS
Windows
Logging
CentOS 7, Ubuntu 18.04
macOS
Windows
Firewalls
OS Firewalls
CentOS 7
Ubuntu 18.04
macOS
Windows
External Firewalls
Troubleshooting External Connections
Interacting with JetStream
API
Graphical Client
Command Line Client
Command Line Interface
Synopsis
Description
Options
jetstream server
Options
jetstream relay_server
Options
jetstream api
Options
Where Do Transfers Go?
User Management
System Integration
Wranglers
Bandwidth Management
Command Line
API
Security
Sandboxing
Superusers
Isolating the JetStream server process (Linux only)
Start JetStream in a chroot environment
Start JetStream in a lightweight container
Sandboxing
Basic Sandboxing
Advanced Sandboxing
Examples
Global And System Sandboxes
User Sandboxes
Sandbox Types
File
Configuration Options
Placeholders
Examples
S3
Configuration Options
Memory Requirements
Limitations
Example
Lifetime Management
Automatic Clean Up
Persistence
JetStream URI Scheme
Overview
Supported Actions
Example Uses
Simple Redirect Setup
File Redirect Setup
Shared Links
API Tokens
Triggers
Overview
Event Triggers
launch
send.destinationCreated
send.destinationDeleted
recv.transferComplete
Transfer File List
recv.transferComplete.json
Transfer Meta Data
recv.transferStarted
API Command Triggers
Trigger Considerations
Relay Configuration
Requirements
Single Relay
Receiver Relay
Receiver
Sender
Transfer
Double Relay
Receiver Relay
Receiver
Sender Relay
Sender
Destination
Troubleshooting
Full Disk Access on macOS 10.15+
Granting Full Disk Access
Authentication Failures on Linux with Active Directory
Windows 7 Installation
Using Network Shares on Windows
Sandboxes
Directory Links
Tools
jscp
Synopsis
Description
Options
Source and Destination
Examples
Reference
Telemetry
Telemetry Structures
Telemetry Information Structure
Telemetry Data Structure
Telemetry Data Sets
File Sizes Data Values
Transfer Sizes Data Values
Transfer Status Data Values
Round Trip Times Data Values
Transfer Rates Data Values
Transmission Rates Data Values
Release Notes
2.6.5
2.6.4
2.6.3
2.6.2
2.6.1
2.6.0
2.5.3
2.5.2
2.5.1
2.5.0
2.4.0
2.3.1
2.3.0
2.2.1
2.2.0
2.1.0
2.0.2
2.0.1
2.0.0
Known Issues
S3 Sandbox type
Quick Reference
Server Installation
Install Server
Update Server
Uninstall Server
Server Service
Start Service
Restart Service
Stop Service
Enable Service on Boot
Disable Service on Boot
Logging
View Server Log
Check Service
Configuration
Configuration File
Command Line Interface
Firewalls
Add OS Firewall Exception
Contact
Index
JetStream Server
Docs
»
Index
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
J
|
K
|
L
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
Symbols
--api-allow-remote-control
jetstream-server command line option
--api-connect arg
jetstream-server command line option
--api-control-port arg (=8886)
jetstream-api command line option
--api-disable-api-tokens
jetstream-server command line option
--api-disable-shared-tokens
jetstream-server command line option
--api-host arg
jetstream-server command line option
--api-min-ssl-version arg (=TLS1.2)
jetstream-server command line option
--api-port arg (=8886)
jetstream-server command line option
--api-ssl-cert arg
jetstream-server command line option
--api-ssl-cert-key arg
jetstream-server command line option
--authToken arg
jetstream-api command line option
--authTokenSession arg
jetstream-api command line option
--borrow-incoming-rate
jetstream-server command line option
--borrow-outgoing-rate
jetstream-server command line option
--cloud-cache-file arg
jetstream-server command line option
--control-port arg (=8887)
jetstream-relay_server command line option
--default-file-driver arg (=mem_map)
jetstream-server command line option
--disable-port-multiplex
jetstream-server command line option
--disable-telemetry
jetstream-server command line option
--external-address arg
jetstream-server command line option
--host arg (=localhost)
jetstream-api command line option
--incoming-rate-limit arg
jetstream-server command line option
--license-location arg
jetstream-server command line option
--license-password arg
jetstream-server command line option
--log arg
jetstream-relay_server command line option
jetstream-server command line option
--log-file-creates
jetstream-server command line option
--log-level arg (=3)
jetstream-server command line option
--max-cloud-cache-download-size arg (=52428800)
jetstream-server command line option
--max-cloud-cache-size arg (=4294967296)
jetstream-server command line option
--max-cloud-cache-upload-size arg (=104857600)
jetstream-server command line option
--max-cloud-connections arg (=16)
jetstream-server command line option
--name arg
jetstream-server command line option
--no-auth
jetstream-api command line option
--no-encryption
jscp command line option
--outgoing-rate-limit arg
jetstream-server command line option
--persistent-destinations arg
jetstream-server command line option
--persistent-state-dir arg
jetstream-server command line option
--persistent-transfers arg
jetstream-server command line option
--recv-allow-discovery arg (=1)
jetstream-server command line option
--recv-auth-required arg (=1)
jetstream-server command line option
--recv-host arg
jetstream-server command line option
--recv-nat-traversal arg (=0)
jetstream-server command line option
--recv-port arg (=8886)
jetstream-server command line option
--recv-relay-host arg
jetstream-server command line option
--recv-relay-port arg (=8887)
jetstream-server command line option
--response-file arg
jetstream-relay_server command line option
jetstream-server command line option
--sandbox-dir arg
jetstream-server command line option
--send-host arg
jetstream-server command line option
--supergroup arg
jetstream-server command line option
--superuser
jetstream-api command line option
--superuser arg
jetstream-server command line option
--transfer-min-cipher arg (=none)
jetstream-server command line option
--trigger-dir arg
jetstream-server command line option
--trigger-log arg
jetstream-server command line option
--trigger-on-api arg
jetstream-server command line option
--user arg
jetstream-api command line option
--version
jetstream command line option
-b, --batch
jscp command line option
-d <destination_path>, --destinationPath <destination_path>
jscp command line option
-h, --help
jscp command line option
-o <destination_api_port>, --destinationAPIPort <destination_api_port>
jscp command line option
-P <destination_receive_port>, --destinationPort <destination_receive_port>
jscp command line option
-p <source_api_port>, --serverPort <source_api_port>
jscp command line option
-q, --quiet
jscp command line option
-r <maximum_send_rate>, --sendRateMax <maximum_send_rate>
jscp command line option
-s <source_send_port>, --senderPort <source_send_port>
jscp command line option
-v
jscp command line option
A
accessKeyId
sandbox type S3
action
connect, jetstream uri
download, jetstream uri
jetstream uri
open, jetstream uri
anchor
jetstream uri
api tokens
api triggers
trigger
authority
jetstream uri
B
bucketName
sandbox type S3
C
caFile
sandbox type S3
caPath
sandbox type S3
connect
jetstream uri action
D
download
jetstream uri action
E
endpointOverride
sandbox type S3
F
File
password, sandbox type
path, sandbox type
sandboxing type
shareName, sandbox type
type, sandbox type
userName, sandbox type
file sizes
Telemetry Data Sets
File Sizes Data Values
Telemetry Data Sets
folder sharing
see api tokens
G
global
sandboxing sandbox
global sandbox
J
jetstream command line option
--version
jetstream uri
action
action connect
action download
action open
anchor
authority
path
query
jetstream-api command line option
--api-control-port arg (=8886)
--authToken arg
--authTokenSession arg
--host arg (=localhost)
--no-auth
--superuser
--user arg
jetstream-relay
,
[1]
jetstream-relay_server command line option
--control-port arg (=8887)
--log arg
--response-file arg
jetstream-server
,
[1]
jetstream-server command line option
--api-allow-remote-control
--api-connect arg
--api-disable-api-tokens
--api-disable-shared-tokens
--api-host arg
--api-min-ssl-version arg (=TLS1.2)
--api-port arg (=8886)
--api-ssl-cert arg
--api-ssl-cert-key arg
--borrow-incoming-rate
--borrow-outgoing-rate
--cloud-cache-file arg
--default-file-driver arg (=mem_map)
--disable-port-multiplex
--disable-telemetry
--external-address arg
--incoming-rate-limit arg
--license-location arg
--license-password arg
--log arg
--log-file-creates
--log-level arg (=3)
--max-cloud-cache-download-size arg (=52428800)
--max-cloud-cache-size arg (=4294967296)
--max-cloud-cache-upload-size arg (=104857600)
--max-cloud-connections arg (=16)
--name arg
--outgoing-rate-limit arg
--persistent-destinations arg
--persistent-state-dir arg
--persistent-transfers arg
--recv-allow-discovery arg (=1)
--recv-auth-required arg (=1)
--recv-host arg
--recv-nat-traversal arg (=0)
--recv-port arg (=8886)
--recv-relay-host arg
--recv-relay-port arg (=8887)
--response-file arg
--sandbox-dir arg
--send-host arg
--supergroup arg
--superuser arg
--transfer-min-cipher arg (=none)
--trigger-dir arg
--trigger-log arg
--trigger-on-api arg
jscp command line option
--no-encryption
-P <destination_receive_port>, --destinationPort <destination_receive_port>
-b, --batch
-d <destination_path>, --destinationPath <destination_path>
-h, --help
-o <destination_api_port>, --destinationAPIPort <destination_api_port>
-p <source_api_port>, --serverPort <source_api_port>
-q, --quiet
-r <maximum_send_rate>, --sendRateMax <maximum_send_rate>
-s <source_send_port>, --senderPort <source_send_port>
-v
K
key
Telemetry Data Structure
L
launch
trigger
license
Server Information Structure
link sharing
see shared links
O
open
jetstream uri action
P
password
sandbox type File
path
,
[1]
,
[2]
jetstream uri
sandbox type File
sandbox type S3
sandboxing type
platform
Server Information Structure
proxyHost
sandbox type S3
proxyPassword
sandbox type S3
proxyPort
sandbox type S3
proxyScheme
sandbox type S3
proxyUserName
sandbox type S3
Q
query
jetstream uri
R
recv.transferComplete
trigger
recv.transferComplete.json
trigger
recv.transferStarted
trigger
region
sandbox type S3
revision
Server Information Structure
round trip times
Telemetry Data Sets
Round Trip Times Data Values
Telemetry Data Sets
S
S3
accessKeyId, sandbox type
bucketName, sandbox type
caFile, sandbox type
caPath, sandbox type
endpointOverride, sandbox type
path, sandbox type
proxyHost, sandbox type
proxyPassword, sandbox type
proxyPort, sandbox type
proxyScheme, sandbox type
proxyUserName, sandbox type
region, sandbox type
sandboxing type
scheme, sandbox type
secretKey, sandbox type
sessionToken, sandbox type
type, sandbox type
verifySSL, sandbox type
sandbox
global, sandboxing
system, sandboxing
user, sandboxing
sandbox type
File password
File path
File shareName
File type
File userName
S3 accessKeyId
S3 bucketName
S3 caFile
S3 caPath
S3 endpointOverride
S3 path
S3 proxyHost
S3 proxyPassword
S3 proxyPort
S3 proxyScheme
S3 proxyUserName
S3 region
S3 scheme
S3 secretKey
S3 sessionToken
S3 type
S3 verifySSL
sandboxing
sandbox global
sandbox system
sandbox user
type File
type S3
type path
scheme
sandbox type S3
secretKey
sandbox type S3
send.destinationCreated
trigger
send.destinationDeleted
trigger
Server Information Structure
license
platform
revision
serverId
startTime
serverId
Server Information Structure
sessionToken
sandbox type S3
shared folders
see api tokens
shared links
shared tokens
see shared links
shareName
sandbox type File
startTime
Server Information Structure
system
sandboxing sandbox
system sandbox
T
Telemetry Data Sets
File Sizes Data Values
Round Trip Times Data Values
Transfer Rates Data Values
Transfer Sizes Data Values
Transfer Status Data Values
Transmission Rates Data Values
file sizes
round trip times
transfer rates
transfer sizes
transfer status
transmission rates
Telemetry Data Structure
key
timestamp
values
Telemetry Information Structure
timestamp
Telemetry Data Structure
transfer rates
Telemetry Data Sets
Transfer Rates Data Values
Telemetry Data Sets
transfer sizes
Telemetry Data Sets
Transfer Sizes Data Values
Telemetry Data Sets
transfer status
Telemetry Data Sets
Transfer Status Data Values
Telemetry Data Sets
transmission rates
Telemetry Data Sets
Transmission Rates Data Values
Telemetry Data Sets
trigger
api triggers
launch
recv.transferComplete
recv.transferComplete.json
recv.transferStarted
send.destinationCreated
send.destinationDeleted
type
,
[1]
File, sandboxing
S3, sandboxing
path, sandboxing
sandbox type File
sandbox type S3
U
user
sandboxing sandbox
user sandbox
userName
sandbox type File
V
values
Telemetry Data Structure
verifySSL
sandbox type S3
JetStream Server
v: 2.6.5
Versions
Documentation version list could not be retrieved.
JetStream Documentation Reference
Client
Server
API