GoodSync uses URLs to identify the source and destination locations in a job. This article explains how to manually construct a URL for a file or folder accessed through a remote GoodSync Connect server using the GoodSync Transfer Protocol (GSTP).
NOTE: In most cases, you can select the location using the GoodSync Browse dialog and GoodSync will create the URL automatically. Manual URL construction is primarily used for command-line jobs, scripts, and advanced configurations.
GSTP URL Format
General format:
gstps://<GSTP-server>/<file-system-prefix>://<remote-server>/<folder-path>
Replace each value enclosed in angle brackets with the information for your environment. Do not include the angle brackets in the completed URL.
Understand Each Part of the URL
Protocol
Example: gstps://
Connects to the remote device using secure GSTP. The secure gstps:// protocol is required for mediated connections.
GSTP Server
Example: worker.test-user.goodsync
Identifies the remote GoodSync Connect server. A mediated address normally uses the format ComputerID.UserID.goodsync.
File-System Prefix
Examples: file, smb, or home
Identifies the file system that the remote GoodSync server will access. Other supported file-system prefixes may also be used.
Remote Server
Example: MYSERVER
Identifies a server that is accessible from the remote GoodSync device. This value is used for file systems such as SMB. Leave this value empty when the folder is stored directly on the GoodSync device.
Folder Path
Example: MYSHARE/my-folder
Identifies the folder or file that GoodSync will access.
Mediated and Direct Server Addresses
The GSTP server portion of the URL can use either of these address types:
-
Mediated address: ComputerID.UserID.goodsync
GoodSync uses its Mediator service to locate a device that may have a dynamic IP address. Use gstps:// for this connection type. -
Direct address: server.example.com or 192.168.1.50
GoodSync connects directly to the specified host name or IP address. Network routing, firewall access, and name resolution must allow the client to reach the server.
IMPORTANT: The unencrypted gstp:// protocol may be available for direct connections, but it is not recommended. Use gstps:// whenever possible to protect data in transit.
GSTP URL Examples
Access a Folder Stored on the Remote Device
Example URL:
gstps://worker.test-user.goodsync/file:///C:/mystuff
This URL identifies:
- The GoodSync Connect server named worker.
- The GoodSync Account user ID test-user.
- The local folder C:\mystuff on that remote device.
The remote-server value is empty because the folder is stored directly on the GoodSync Connect device. This produces the three forward slashes in file:///C:/mystuff.
Access an SMB Network Share Through the Remote Device
Example URL:
gstps://worker.test-user.goodsync/smb://MYSERVER/MYSHARE/my-folder
This URL identifies:
- The GoodSync Connect server named worker.
- The SMB server named MYSERVER, which must be reachable from the remote GoodSync device.
- The folder my-folder inside the share MYSHARE.
Access a GoodSync Home File System
Example URL:
gstps://worker.test-user.goodsync/home://S0/my-folder
This URL points to my-folder on the S0 virtual server in the remote user's Home File System. The Home File System presents only the locations made available to that user and does not expose the underlying storage implementation.
If the URL Does Not Connect
- Confirm the Computer ID and GoodSync Account user ID are correct.
- Make sure the remote device is online and configured to serve files through GoodSync Connect.
- For an SMB URL, confirm that the remote GoodSync device can access the SMB server and share directly.
- For a direct address, confirm that DNS, routing, the firewall, and the required GSTP port allow access to the server.
- Use forward slashes in the GoodSync URL, including when the target is a Windows folder.
- Do not add a GoodSync Account password or other credentials to the URL. Select or create the appropriate account in GoodSync when prompted.