Updated: 2023-08-22 04:36:23

1 Basic Settings

1.1 Email settings

Mail server used to configure email notification when sharing download/invite upload/upload download. Click Setting-Email settings. Set the correct mailbox server as required, click Test and save.

Email setting

1.2 Client settings

Support the server to set the client to force the hash check, encrypted transfer, automatic upgrade, configure client icon

Function Description
Enable hash check Raysync Client will force hash check transfer to be turned on.
Enable encrypted transfer Raysync Client will force encrypted transfer to be turned on.
Enable auto-update When the Client is configured with the correct default server, a silent upgrade will be performed automatically when the server version is higher than the client version.
Configure URL Use to enable the foreground user page to start the Raysync Client. You only need to modify the URL when customizing the Client version, otherwise it may affect normal use. If you need to customize the Client, please contact Raysync staff.

1.3 More settings

Click Settings-More

Function Description
Enable file close When this function is turned on, the file close operation will be executed in the background when the file upload is finished. Check the Enable Delayed Close button and restart the server to take effect
Enable event notifications Support turns off and starts the event notification function. After shutting down, the event notification function will not be executed in the background.
Support multiple IP addresses Support multiple IP addresses. When the server has multiple Ip addresses, you can enable multi-Ip configuration, then users can access through any Ip of the server.
Allow to set process number Support to configure the number of 'raysync-s' processes on the server. The default number of processes is server (CPU cores-2)/2, at least 1.

2. Transfer

2.1 Transfer settings

Support setting server global speed limit, time period speed limit, client transfer unit, transfer file format limit, transfer protocol selection. Click setting-Transfer settings

Function Description
Maximum upload/download speed Controls the maximum speed of the server during global upload/download (You can click Mbps and switch the speed limit unit)
Max speed period setting The maximum upload/download speed of the server at a certain period
Transfer Units Client transfer unit display
Transfer file format limit Transfer file format is divided into white list and black list. The whitelist is used to configure the file formats that the system allows to upload. Blacklist is used to configure the file formats that are not allowed to be uploaded by the system.
Select transfer protocol Auto select UDP/TCP: Set to automatically switch to TCP transfer when the transfer delay is lower than XXms; Use UDP transfer only: the transfer task only uses UDP mode transfer; Use TCP transfer only: the transfer task only uses TCP mode transfer; Give priority to UDP transfer, UDP cannot communicate automatically switch to TCP transfer: the system default configuration, when UDP connection fails, automatically switch to TCP transfer
Transfer type Set the transmission type, you can set to use only clienttransmission or only web transmission or the default(Web and Client)
Task name setting You can customize a transfer task name when creating a client transfer task

2.2 Sync

Global sync function switch, click Setting-Sync.



2.2 Peer-to-Peer transfer

If you want to use the Peer-to-Peer transfer, You need to :

  1. Open Peer-to-Peer ports for the service. TCP/3443;TCP/3443;UDP/32003
  2. you must configure the public ip address of the Peer-to-Peer service. The configuration takes effect after the restart.
Function Description
Server address Enter the public ip address of the Peer-to-Peer service. Multiple IP addresses are supported
Port Port monitored by the Peer-to-Peer service. The default port is 32003

3. Link

If you select "Bind the first device when open the share link", the shared download link can only be opened on the first device. Click Setting-Share.


4. Advanced

4.1 MySQL settings

Raysync supports external MySQL databases, providing administrators with more flexible database configuration methods. Click Configuration-MySQL Fill in the correct external database configuration, such as address/port/ account password, click Test Connection, if the test connection passes, click Save, after reboot, the external database will be enabled successfully, and all the background configuration information will be saved in the database.


4.2 Event (File Post Proccessing)

The server will try to excute the program after each file transfer is complete.

Scenario: When a setting event occurs in the system, the system will automatically trigger the execution program you set. Event notifications can be calls to transmitted files, tasks, transmitted mail notifications, and so on. Event notification enables users to learn about file information and changes in a timely manner, improving user experience and efficiency.

4.2.1 Add/Edit/Delete Event Notifications

Click Configuration - Add Event, select the event, fill in the event name, executable program path, parameters and completion wait time.

Event notification parameter replacement supports special parameters such as $filepath, $filename, $filesize, $userId, $destPath, $clientMac, $clientIp, representing "file path", "file name", "file size", " user ID", "Target path", "Client Mac address", "Client IP"


Click confirm to save. After saving successfully, click Test to check if the settings are successful.


Select the event to view event details, edit and delete it


4.3 Log

Click Setting-Log to configure the log path and the retention period for transfer logs and user operation logs, the default is 30 days.


We use cookies to ensure that we give you the best experience on our website. By clicking any link on this page you are giving your consent to our Cookies and Privacy Policy.