Support

1.Brand new point to point transfer function, files can be transferred between Raysync clients directly without loading on the server, which is only transit data volume.

2.Object storage adding support Google Azure blob.

3.Raysync client UI improvement.

4.Support administrator setting batch set default permissions on side third party authentication user.

5.New feature on the administrator of sending a notification to users, including: A. Send notifications from the website. B. Send notifications from email.

6.Raysync client stays minimize when start-up.

7.The signature of the mail notification in the admin console can be self-defined according to the company name.

8.Add the validity and invalidity option to the TLS certificate page in the admin console.

9.Change password to optional in Raysync client mailbox configuration.

10.Raysync client supports mailbox login.

11.The online and offline status of the sub-account is visible now on the user management page of the admin console.

12.The IP whitelist in the admin console supports continuous segments. For example, IP from 192.168.0.1 to 192.168.0.100, can be written as 192.168.0.1-100.

v5.0.4.8

Updated: 2020-10-30

1.Add the button of upload file or folder when the client is connected with TCP.

2.Add default enable hash check and default enable encrypted transmission on the administrator.

3.Add the option to prohibit non-SSL connections on the administrator.

4.Default Raysync client automatically run at startup.

5.Change the client to priority TCP transmission.

6.The administrator displays the space capacity and used space of all disks on the Raysync server.

7.Add test button on the administrator in mailbox configuration.

8.Add common mailboxes SMTP to administrator mailbox and three-party authentication mailbox configuration.

9.Support administrator mailbox SMTP and STARTTLS encryption docking.

10.The administrator can control whether the client chooses to send the notification with the mailbox configured by the client.

11.Display users number of License control on the administrator.

12.Add IP white list to the user account on the administrator.

13.Optimize email format verification.

14.Transmission client UI optimization.

15.Administrator control the TCP transfer file size limit.

16.Other bug fixes

v5.0.3.8

Updated: 2020-10-30

1.Adapt to the Dark mode display of MacOS.

2.Update the MacOS logo icon.

3.Add third-party Http(s) authentication to the Raysync management console.

4.Support using wildcards to upload and download files under command line mode 5.Support moving files under command line mode.

6.Support specifying the modification of the target file name under command line mode.

7.Support three transmission protocol configurations in Raysync management console: UDP/TCP automatic selection (how many milliseconds to use TCP), Only UDP transmission, Only TCP transmission, Default.

8.Synchronization tasks support two-way synchronization.

9.Optimize UI for sharing downloads and invitations to upload pages.

10.Optimize UI for Software plugin download prompt window.

11.Optimize UI for management console.

12.Support rsync download verification: when downloading files, if the download directory has a file with the same name, it will be compared with the file on the server, the server only sends different data for download.

13.Add "Import Authentication account" button to LDAP authentication. After user configuration completes LDAP information, the account in LDAP can be actively imported to the Raysync server.

14.Support the home directory set some directories invisible to Raysync users.

15.Fix Other bugs.

v5.0.2.8

Updated: 2020-10-30

1.The web supports uploading and downloading files without starting client Raysync/Pro/Enterprise distinguishes the front-end display according to different licenses.

2.Support the librsync algorithm to check file changes.

3.IOS product development.

4.Raysync software supports license based on traffic comsuption.

5.Online and offline licenses support a specified number of accounts.

6.Internationalization of shared mail.

7.Transmission log display by pages.

8.Fix Other bugs.

2) About Raysync

Raysync, launched by RAYWING PTE. LTD., is a secure, fast, and reliable way to send large file. Raysync is dedicated to meeting the needs of large data transfer within the enterprise or with external partners and providing efficient and controllable large file transfer acceleration service.

The applications of Raysync include fast transfer of large files, high-speed transfer of massive small files, transnational network data transfer, secure files transfer, file migration, peer-to-peer transfer, file sync, file management, and group authority management. Fully meet the needs of enterprise users and help business development.

Why Raysync?

Large file transfer speed is at least 100 times faster than FTP/HTTP
Small file transfer can support tens of thousands of concurrent simultaneously
At least 100TB files can be transferred across borders every day
Minute-level rapid deployment delivery, supporting Windows and Linux servers
Raysync client supports Windows, Linux, macOS and other terminals
Support SDK integration, Raysync can be integrated into any of your applications
Adopt AES-256 bank-grade encryption technology, and use TLS encrypted transfer protocol to ensure data security
Supports user local to the server's configured storage, peer-to-peer transfer, sync transfer, and one-to-many data distribution, etc,.

3) How to Buy

Raysync provides different types of customers,Cloud version, SMB version, and Enterprise version.

	Cloud	SMB	Enterprise
UDP Bandwidth	1GB	1GB	Limited by Licence
Storage	1TB	Unlimited, depending on your storage	Unlimited, depending on your storage
Transfer Traffic	2TB	Unlimited	Unlimited
Limited Users	10	10	Unlimited
Pricing	$99/Month	$1,599/Annual	Please contact sales

For more version function distinction, please consult the business.

4) Deployment

4.1) Server Preparation

Operating systems

1) Windows service: WindowsServer2008-2019 and above, Windows7-11 and above, and other operating systems (64-bit)

2) Linux service: Centos6.5 and above, Ubuntu14 and above, Debian 12 and above

3) CPU：4 Intel Xeon 2.00GHz or better

4) Memory：8G or better

5) Disk Space：40GB or above

6) Network Connection：100M or faster

4.2) Server Deployment

We provide installation packages for Windows and Linux. Please select the correct version for deployment based on your server operating system. After the deployment is complete, you can access the Admin portal and User portal page through a browser.

Basic Usage Process

Server deployment -> Firewall configuration -> View Admin portal initial password -> Login Admin portal -> License activation -> Storage configuration -> User creation -> Login User portal -> Download and install Client -> High-speed upload and download.

1. Windows Server Deployment

Unzip and start service: Unzip the downloaded Raysync server package into your server, enter the directory of Raysync, and double-click Start.exe to start the Raysync transfer service. During the startup process, just click Confirm according to the system prompts.

Initial password: After the Raysync service is successfully started, an AdminInitPwd file will be generated in the installation directory, which records the initialization password of the default administrator (Account: admin), which can be opened and viewed with Notepad.

📌 Note: Auto-start on boot (optional): If you need to implement automatic startup of Raysync service at boot, you can execute ServiceRegister.exe to register the Raysync service as a system service.

2. Linux Server Deployment

Step 1: Unzip the installation package

$ tar -zxvf RaySync-8.1.8.6-SMB.tar.gz

Step 2: Installation

$ cd RaySync

$ ./install.sh

The execution result is successfully installed, which means the installation is successfully initialized and the Raysync service is added to the boot-up.

Step 3: Start Server

$ ./start.sh

📌 Note: If you need to transfer a large number of files, because the default number of open files by the server is 1024, there may be a problem of failure to open the file. Therefore, you need to configure the number of open files on the server.

Edit the limits configuration file:

vi /etc/security/limits.conf

Add the following lines:

* soft nofile 65535
* hard nofile 65536
root soft nofile 65535
root hard nofile 65536

3. Access Address

Login Admin Portal

Access address example: If the server IP is 172.16.5.77, then the Admin portal address is: http://172.16.5.77:9090/admin

Initial administrator account: admin

Initial administrator password:

Windows: After starting the service, open the AdminInitPwd file in the installation directory to check the password.

Linux: Run the following command in the server to view the password:cat AdminInitPwd

linux密码

Login User Portal

Access address example: If the server IP is 172.16.5.77, then the User portal address is: http://172.16.5.77:8090

If you need to log in, please create a user account in the Admin Portal first.

4.3) Firewall Configuration

1.On premise deployment

Raysync server needs to be configured with the machine's firewall to allow the following ports. If the server is deployed in a NAT gateway with only an intranet IP, the following ports also need to be mapped on the router NAT.

Direction	Protocol/Port	Port Service Description
Inbound	TCP/8090	User portal http service
Inbound	TCP/8091	User portal https service
Inbound	TCP/9090	Admin portal http service
Inbound	TCP/9091	Admin portal https service
Inbound	TCP/2480	Client Web Direct Service
Inbound	TCP/2481	Client Web Encryption Direct Connection Service
Inbound	TCP/2442	TCP Transfer Unencrypted Services
Inbound	TCP/2443	TCP Transfer TLS Encryption Service
Inbound	TCP/32001	Node Management Service
Inbound	UDP/32001	UDP Accelerated Transfer Service
Inbound	TCP/2482	HTTP download
Inbound	TCP/2483	HTTPS download
Inbound	TCP/3443	TCP forwarding server monitor port for Peer-to-Peer transfer
Inbound	UDP/3478	Raysync STUN server port is used for network detection and hole drilling between peer-to-peer
Inbound	UDP/32003	Peer-to-Peer transfer service
Inbound	TCP/2582-2583	Web video preview port Use 2582 for http access , 2583 for https access
Inbound	TCP/2542,2642,2742 or TCP2543,2642,2743（Encryption）	Multi-channel transfer

At least the port must be open:

http access: TCP: 8090, 9090, 2480, 2442; UDP: 32001
https access: TCP: 8091, 9091, 2481, 2443; UDP: 32001

2.Cloud deployment

If the Raysync service is deployed on public clouds such as AWS and Azure, in addition to opening access to the above ports in the security group where the server is located, it is also necessary to open the above-mentioned ports in the security group where the server is located. Common cloud vendor security group configurations:

AWS

Azure

Googl e Cloud

4.4) License Activation

There are two ways to activate Raysync License: online activation and offline activation.

1. Online Activation

Please use the online activation method to activate the license when the server can access the external network.

1) Enter Raysync Admin Portal - Devices - Server, click Activate

2) Enter the online activation code

3) Restart the Raysync server

4) Activate successfully

2. Offline Activation

Please use the offline activation method to activate the license when the server cannot access the external network.

1) Enter Raysync Admin Portal - Devices - Server, click Activate

2) Enter the Offline activation code

3) Generate license request file, The web will download a XXXXXXXX_Request_Code.req file.

4) Please send XXXXXXXX Request Code.req file to the raysync's staff

5) You will receive an offline activation file from us, such as "zpqxijpjarhgakxq_update_code. UPD", please Import the file to the web.

6) After importing, you can see the file you imported, then click [Activate]

7) Restart the Raysync server

8) Activate successfully

4.5) Server Upgrade

Raysync server has Windows version and Linux version, please check the corresponding upgrade operation steps according to the version type.

Windows Server Upgrade

Step 1: Stop the Old Service

Navigate to the installation directory of the old version of Raysync service and click Stop.exe to stop the Raysync service.

Step 2: Prepare the New Version

Uzip the new version Raysync service package to a different directory from the old version.

Step 3: Perform the Upgrade

1.Enter the extracted directory of the new version of Raysync service

2.Input "cmd" in the address bar path and press Enter to open the command line window.

3.Run the upgrade command with the path to the old server's deployment directory:

For example: "E:\RaySync-8.1.8.5" is the old Raysync service path

Upgrade.exe "E:\RaySync-8.1.8.5"

(Replace the example path with your actual old server path)

4.When prompted, enter Y and press Enter to confirm.

Step 4: Start the New Service

In the new version's directory, click Start.exe to launch the updated Raysync server.

Linux Server Upgrade

Step 1: Stop the Old Service

Navigate to the installation directory of the old version of Raysync service and execute the stop: ./stop.sh

Step 2: Prepare the New Version

Uzip the new version Raysync service package to a different directory from the old version.

tar -zxvf RaySync-8.1.8.6-SMB.tar.gz

(Replace the package name with your actual new version Raysync service package)

Step 3: Perform the Upgrade

1. Enter the extracted directory of the new version of Raysync service.

2. Run the upgrade command with the path to the old server's deployment directory:

For example: "/opt/lou/8.1.8.5/RaySync" is the old Raysync service path

./upgrade.sh /opt/lou/8.1.8.5/RaySync

(Replace the example path with your actual old server path)

3.When prompted, enter Y and press Enter to confirm.

4.Wait for the upgrade to complete. You will see a success message: "Upgrade succee".

Step 4: Start the New Service

Execute the following commands in the new version's directory to start the updated server:

./install.sh && ./start.sh

5) Quick Start

5.1) Configure Storage

After the license is activated, you need to configure storage for the space next.

After each server is deployed, there will be a default space, you can also create multiple spaces and configure different storage. Storage Currently supports local storage, Ali Cloud OSS, Amazon S3, Azure Blob, Google cloud storage and other s3 storage types. Please refer to the specific storage configuration in [Configuration] - [Storage Configuration]

5.2) Create Users

You can log in on the user portal only after a user to be created on the admin portal.

The Raysync management terminal provides a variety of ways to authenticate users. You can manually create users, or you can use a third-party integration method, including LDAP/AD domain, mailbox, System, external Http Service and OIDC.

Manually create user

If you create a new user manually, do as follows:

Step 1: Enter [Account]-[Users], Click [add], configure the basic information

Step 2: Configure the storage directory, and Click [Save]

After successful creation, you can configure permissions, speed, storage, file black and white lists, user menu bars, etc. for the user in the [User roles]. The created user is set to the [Default User] by default. You can also create other user role templates.

5.3) TLS Certificate

Raysync provides encrypted certificate services, which can be used both for https secure access to the web and for file transfer encryption. The default certificate provided by Raysync is only used for transfer encryption, so you can also use your own certificate for both secure access and file transfer encryption.

Admin access address is: https://Domain:9091/admin

User access address is: https://Domain:8091/

5.4) Create High Speed Transfer Task

1. Login the user portal

Enter the server User portal address (default: http://[server-IP]:8090, example: http://192.168.1.1:8090), as well as your account and password to log in.

2. Download the client

Download Raysync desktop client or browser plugin client, install, start.

💻 Desktop client: High-speed without web
🌐 Browser plug-in client : High-speed file transfer through the web page and plug-in client

3. Start transfer

DESKTOP MODE Desktop client for high-speed transfer

After launching the desktop client:

- Enter the server address (default: http://[server-IP]:8090)

📍 Example address: http://192.168.1.1:8090

- Enter your account and password to sign in
- Once logged in, you can start high-speed transfers directly from the desktop interface

PLUG-IN MODE Browser plug-in client for high-speed transfer

Access the User portal, then start the plug-in client:

- Navigate to My Files or Group Files on the web interface
- Select files or folders you wish to transfer
- Initiate upload or download — the plug-in will automatically accelerate transfer speeds

5.5) Create Peer-to-Peer Task

Peert-to-Peer transfer service

If you want to use the Peer-to-Peer transfer, You must configure the settings in the admin portal :

Open Peer-to-Peer ports for the service. TCP/3443;UDP/3478;UDP/32003
Configure the public or internal ip address (the same as the IP address of the Raysync service) and port number of the peer-to-peer service in [Configuration] - Transfer [Peer-to-peer]. If the service is used on a public network, set the IP address to a public network. After the configuration is successful, the system restarts to take effect

Function	Description
Peer to Peer Server address	Public or internal IP addresses of peer-to-peer services (the same as the IP address of the Raysync service). Multiple IP addresses are supported, but domain names are not supported
Port	Port monitored by the Peer-to-Peer service. The default port is 32003

Stun Service

Configuring the stun Service(Optional), it can detect the network between two devices to establish a direct connection service between the devices when creating peer to peer transfer, which improves the success rate of direct connection in peer-to-peer task transmission. You can deploy your private Stun service or use an open public Stun service.

Function	Description
Stun Server address	Public IP address or domain name of the Stun service. Only one IP address is supported
Port	Port monitored by the Stun service. The default port is 3478

Send peer-to-peer files

Login user portal
Download and install the client
Click left menu Send
Enter the receiver's device ID
Select file
Click Start to transfer

Receive peer-to-peer files

Login user-end portal
Download and install the client
Click left menu Receive
Enable the Allow to receive files
Copy the device ID and send it to the sender
Prepare to receive files

5.6) Create sync Task

Login user portal
Download and Start the client
Click left menu Sync Select folders and create synchronous tasks.

5.7) Create server task

The administrator can actively create transmission tasks in the Raysync admin portal, create upload tasks synchronously uploaded from the client node machine to the server, or download tasks synchronously downloaded from the server to each client, and view the task transmission details and transmission logs issued by the server. Node data in each area can be transferred to uniform transmission and dispatch.

1. The client configures the default server

Before creating a server to issue tasks, all client devices need to start the client and log in to the default server.

Step 1. Start the Raysync client

On the client side, download and install, and start the Raysync client.

Step 2. Configure the default server

Right click the client icon in the client to be transmitted, click [Settings] - [Default server], and enter the default server IP address (the server address to create the task), login account and password.

Step 3. Check the client connection status

Check whether the client connects to the service successfully. Click [Devices] - [Client devices] to check whether the node machine status is normal. Only the client node machine status is [Online], the transmission task issued by the server can be executed normally.

2. Create server task

Create a server task

Click [Transfer Tasks]-Server[Task list]-[Add] on the Admin portal,and fill in the task name, source path, and target path, select the synchronization frequency, and click Save to create it successfully.

Parameter	Description
Task name	Server task name
Source path	When the source path is the client, it is uploaded from the client of each node machine to the server; When the source path is the server, it is downloaded from the server to each client node locally. You can specify an online client node. If no online client node is specified, all online client nodes are default. Path supports using variables. ${system.currentDate} - Get the current system date, format (yy-mm-dd) ${system.currentTime} - Get the current system time, format (yy-mm-dd hh:mm:ss) ${system.task.name} - Get task name ${system.os.name} - Get the current client device system name ${system.os.version} -Get the current client device system version number ${system.user.email} - Get the current user email ${system.user.name} - Get the current user name For example: if the source path is set as the Client " C:\${system.currentDate} ", after the task is created, the system will transfer all folders named with the current client's system date in the C drive of the selected client .
Target path	If the target path is the client, then it is downloaded from the server to each client node locally; When the target path is the server, it is uploaded from each node client to the server. Path supports using variables
Task frequency	- Transfer Only Once: the transfer task will not be executed after it is executed once; - Execute transmission once every xx seconds/minutes/hour; - Execute the transmission at xx: xx every day; - Execute the transfer at xx: xx every week

2.1 Transfer from Client → Server (Upload Task)

1. Click [Add] and enter the task name.

2. Set Source path to Client: Enter the local file/directory path to be uploaded.

3. Set Target path to Server: Select the target Space and Storage, then enter the corresponding path.

Example: The storage [Default] path = /opt/Raysync . If server task path = / ; real upload to = /opt/Raysync ; if path = /test ; real upload to= /opt/Raysync/test .

4. Configure other optional parameters and click [Save].

2.2 Transfer from Server → Client (Download Task)

1. Click [Add] and enter the task name.

2. Set Source path to Server: Select the Storage, enter the server file/directory corresponding path to be downloaded.

Example: The storage [Default] path = /opt/Raysync. If server task path = / ; real download to = /opt/Raysync ; if path =test; real download to = /opt/Raysync/test

3. Set Target path to Client: Enter the local client path for file storage.

4. Configure other optional parameters and click [Save].

3. Task monitoring

After the task is created successfully, you can monitor the transmission status of the task, edit and delete the task.

Click View Log to view the task transmission status of each client node.

任务详情-英文

After each transmission, you can view the transmission record in the [Log] - [Server task]

6) Admin Portal Guide (Before Version 8180)

6.1) Devices

1. Server Settings

This interface will display the server configuration information, the display status of Raysync, the number of online users, the license activation status and the monitoring information of CPU and the corresponding network card, etc.

1.1 License activation

Raysync server needs to activate the license to experience the maximum speed. If the license is not activated, the default bandwidth is 5Mbps.

Click Server on the home page and click Activate, enter the correct activation code and restart the service to take effect. 激活英文

1.2 View license

Server-license information

查看激活码信息

1.3 View disk space

Server - Disk Space

磁盘英文

1.4 Service operation status

Server-Server operation status

状态英文

1.5 View server monitoring information

1.5.1 CPU information

Server-cpu information

cpu英文

1.5.2 NIC information

Server-NIC Information

网卡英文

1.6 View online users

Server - Connected Users

查看在线用户数英文

1.7 Shutdown, startup, and reboot Raysync service

Server - Basic Information

重启服务英文

1.8 Edit server information

Server information includes Server Address, UDP Port, UDP Package size, Default Storage Path Bandwidth, Compression, and other functions. Click Server - Modify

Function	Description
Server Address	The server address can be changed to an IP address or domain name.
UDP Acceleration Port	The UDP port can be changed to a port between 1 and 65535. The default is 32001. You need to ensure that the server firewall already has the UDP port. Otherwise, the transfer will fail. After the change, you need to restart the server.
UDP Message Size	UDP message size is generally set to the default value. The default is 1200 (the range is 600~1442).
Enable Compression	After enabling, files that can be compressed for transfer will be compressed, which can reduce bandwidth usage and improve transfer efficiency.
Outbound Bandwidth	The server export bandwidth is not configured by default, and the export bandwidth is not limited. When set to 0 or not filled in, the bandwidth limit will not take effect

2. Client Devices

It displays the Client running status and machine status of the connected server, monitors CPU, memory, and disk usage in real-time. In addition, it can stop, start and lock the operation of the Client user with one click for all transfer tasks connected to the node.

Client devices

3. Topology

This interface displays the storage of the server, the node Client connecting to the server, as well as the transfer data flow between nodes and between server and nodes.

topology

6.2) Spaces

Admin can assign members in the space, set administrators, configuration storage, group folder, space access restrictions, delivery authorization, etc. The new user is a member of the default space.

1. Space Storage Configuration

The storage configuration is used to specify the storage home directory and virtual directory of all user and group file libraries in the space, and supports the configuration of multiple storages. Supports adding multiple storage such as Alibaba Cloud OSS storages, Amazon S3 storage, S3 interface compatible storage, Azure Blob, and Google Cloud at the same time.

2.1 Add local storage

Select the space and click the storage configuration Add - select the local storage, enter the storage name, enter the storage path, click Save, and the storage will take effect after the service restarts.

Support regular cleanup of local storage. You can clean up files based on their modification time or access time. Cleaned files can be directly deleted or moved to the Recycle Bin before cleaning.

2.2 Add Alibaba Cloud OSS storage

Fill in the correct OSS storage configuration information, specify the OSS storage path (optional, it will be stored in the Bucket root directory by default) and click Test. If the test is passed, it means that the configuration information is correct. Click Save and it will take effect after the server restarts.

oss存储

2.3 Add Amazon S3 storage

Fill in the correct Amazon S3 storage configuration information, specify the storage path (optional, it will be stored in the Bucket root directory by default), click Test, if the test passes, then the configuration information is correct. Click Save and it will take effect after the server restarts.

aws存储英文

2.4 Add S3 interface compatible storage

Currently supported object storage: Backblaze B2 Cloud Storage , Wasabi, Ceph Object Storage, etc.

Endpoint defaults to https:// protocol. If you use http:// , you need to add http:// in front of the Endpoint

其他S3英文

2.5 Add Azure Blob Storage

Fill in the correct Azure Blob storage configuration information, specify the storage path (optional, it will be stored in the root directory by default), click Test, if the test passes, the configuration information is correct. Click Save and it will take effect after the server restarts.

微软英文

2.6 Add Google Cloud Storage

Select the space and click on the storage configuration New - Google Cloud Storage Enter the storage name, upload the correct Google cloud storage credential file, fill in the correct storage configuration information, specify the storage path (optional, it will be stored in the root directory by default), click Test, if the test passes, the configuration information is correct, click Save, it will take effect after the server restarts. google英文

2.7 File cleanup

Enable automatic file clearing, the server will automatically migrate all files or long-term transfer of uncompleted temporary file in the local storage path to the recycling path or direct deletion according to the file cleaning rules. (Only supports cleaning files in the local storage path)

For example, the local storage path is /opt/raysync/, the recycling path is /opt/recycle/, and the cleaning rule is to automatically clean up all files whose last access time was one year ago. After saving the configuration and restarting the service, files in /opt/raysync/ whose last access time was one year ago will be automatically migrated to the /opt/recycle/ directory.

In the Space-Storage configuration, Click Add/Edit Local Storage, click to enable automatic file cleanup. Select the file cleaning rule, configure the storage path for file recycling, and click Save.

3. Space Administrator

Space administrators can manage space membership, group folders, space access, and file delivery.

3.1 Add/Delete/Search Space administrator

Enter Default Space - administrator, to add, delete, and search for administrators.

4. Manage Space Members

4.1 Add/Delete/Search space members

Click Members - Add member to add, delete, and search space members.

4.2 Space member permissions and transfer configuration

Enter space management - select Space - Members - Directory/Permission or Transfer setting to configure the permissions and transfer configuration of space members.

Function	Description
Home Directory	User's personal file storage location
Virtual Directory	After adding a virtual directory, the user can view the user's virtual directory in the foreground, and transfer and operate the files in the virtual directory. Support for adding multiple virtual directories. Virtual directory alias: a path based on the user's home directory; virtual directory path: a valid path based on virtual storage
Forbidden access path	Set the path that the user is forbidden to access, the front-end user page cannot display the files (folders) of this path, and cannot create, delete, rename, copy, move, upload, download the files (folders) that are forbidden to access
Allowed access path	Set the path that the user is allowed to access. The front-end user can only see the set path. It supports setting files or folders. Paths other than the allowed access path cannot be created, deleted, renamed, copied, moved, uploaded, or downloaded. operate. Please refer to the rules in the prompt to fill in the
Permissions	Configure Personal File List, Download File, Delete, Rename, Create Folder, Upload File, Sync Folder, Move, Copy, Invite to Upload, Share
Upload file options	After enabling only upload new files, users can only upload newly added files, and cannot upload files with the same name
Upload and download speed limit	Limit the user's upload and download speed, the default speed is unlimited
Transfer File Format	Transmission 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. The blacklist is used to configure file formats that are not allowed to be uploaded by the system. Multiple formats need to be separated by ";", such as "txt;iso;mp4"
File transfer filter	1) It is supported to prohibit setting file filter conditions on the Raysync client. The sync tasks created by users in the personal space cannot set filter conditions. 2) Support skipping files whose file names meet certain conditions during transfer, and support regular expressions, such as filtering files starting with test during transmission, enter ^test.*. Supports skipping files whose size exceeds the set size during transfer.
File transfer notification	Notify administrator when uploading and downloading files
Maximum storage capacity	Set the upper limit of storage capacity for this user in the current space. When the used storage space exceeds the set upper limit, new files will no longer be stored. After turning it on, real-time statistics will be performed on file transfers and file operations. Global statistics will be performed at a default interval of 1 hour. Note that by default, only local storage is counted. If you need to count object storage or modify the statistical period, you can enter [Space] - [Space Statistics] to configure.

5. Group Folder

The group folder is a shared file directories in the space. You can create a group folder in space, set independent storage spaces for each group folder, set different file operation access for the members in a group folder, and control the transfer speed.

5.1 Add/Edit/Delete/Search group folder

You can create, delete, search, configure and other operations on the main directory, virtual directory, and set transfer file filtering of the group folder. For the function description of the group folder configuration item, please refer to the member settings.

Enter the space management, select the space, and click the group folder to add, delete, search, and set the group folder.

5.2 View/Add/Delete group cault members

You can view, add, and delete members of the group folder, and configure different file permissions for different members. Select a group and click Associate User

5.3 View/Add/Delete group administrator

Add administrators to the group to manage the group.

step 1 Configure group admin permissions under Administrators - Permission Setting

role permissions

step 2 Add the administrators you want to add to the space where the group is located

step 3 Click the icon below the group administrator to add or delete group administrators

6. Security Access Restrictions

Used for space access restrictions. If a whitelist is set, the IP users in the whitelist can normally access the space in the foreground; if a blacklist is set, the IP users in the blacklist cannot access the space in the foreground. Enter the Space List, select the space, click Access Restriction, configure the IP black and white list, then click Save.

7. Space statistics

Global scan statistics group file library and user personal folder storage, administrators can configure the statistical period to facilitate storage management and optimization.

Note: Group file libraries and user personal folders only count local storage. If you need to count object storage, you need to turn on this option. Object storage statistics depend on group file library, personal folder statistics and maximum storage capacity. Turning on object storage statistics will take effect only when any one of them is turned on. Enabling object storage statistics alone will not take effect. The statistical period follows the statistical period of group file libraries and personal folders, and the default interval is 1 hour. Object storage statistics may incur corresponding charges, so please use them with caution.

6.3) Administrator

1. Administrators

This function is used for login and management of the server admin portal, you can add, delete, edit permissions, disable, and search for administrators.

管理员英文

2. Role permissions

Role permissions user specifies the permissions of the administrator and can be configured with different permission groups.

角色权限英文

6.4) Users

1. Local User

1.1 Add user

Click User-Local user, click Add to add users.

Options	Function Description
Name	Account real name
Account number	Cannot be modified after successful creation
Password	Passwords can be edited manually or automatically generated Password must contain lowercase, uppercase, number, and special characters at a length between 8 and 20. Can not include account name. The password and account number cannot be the same. Special symbol support: _~!@#%$.^-+*(){}?
Department	Establish a department for users
Forced password change on first login	When this function is enabled, user must change the initial password upon the first login
Email	Support email login
Department	Establish a department for users
Home directory	User's personal file storage location
Virtual directory	After adding a virtual directory, users can view the user's virtual directory in the foreground and transfer and operate the files in the virtual directory. Support adding multiple virtual directories. Virtual directory alias: based on a path under the user's home directory; virtual directory path: based on a valid path to virtual storage.
Disable access paths	Set the paths that the user is prohibited from accessing, so that the front-end user page cannot display the files (folders) of this path, and cannot create, delete, rename, copy, move, upload, or download the files (folders) that are prohibited from accessing. Refer to the rules in the prompt to fill in
Allowed access path	Set the path that the user is allowed to access. The foreground user can only see the set path and can set files or folders. You cannot create, delete, rename, copy, move, upload, or download the paths other than the allowed access path. Enter the rules according to the tips
Maximum storage capacity	Set the upper limit of storage capacity for this user in the current space. When the used storage space exceeds the set upper limit, new files will no longer be stored. After turning it on, real-time statistics will be performed on file transfers and file operations. Global statistics will be performed at a default interval of 1 hour. Note that by default, only local storage is counted. If you need to count object storage or modify the statistical period, you can enter [Space] - [Space Statistics] to configure.
Permissions	File list, download files, delete, rename, create folders, upload files, sync folders, move, copy, invite, share
Upload file option	After enabling only upload new files, users can only upload newly added files, and cannot upload files with the same name.
Upload and download speed limit	Limit the upload and download speed of the user, the default speed is unlimited
Transfer file format	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 the system does not allow to upload. Multiple formats should be separated by ";", such as "txt;iso;mp4".
Transfer File Filtering	1) Prohibit users from setting filtering criteria when creating synchronization tasks 2) Support transfer file (folder) blacklist and whitelist, meet the conditions of the file will be filtered or transmitted, support wildcard. For example, if files starting with test need to be filtered during transmission, enable the blacklist and enter test*. 3) Support to skip files whose file size exceeds the set size when transferring
File Transfer Notification	Notify administrator when uploading and downloading files
Mailbox sender	Send with administrator's configured mailbox: After setting, you need to configure the mailbox in the administrator's background mailbox settings before using. Email notifications such as sharing links will be sent to the mailbox configured by the administrator; Sending by user configured mailbox: After setting, users need to configure the mailbox in the account settings before using. Email notifications such as sharing links will be sent to the mailbox configured by users.
Share download email notification	1) Link and password will be sent in one email 2) Link and password will be sent in different emails
IP Login Whitelist	After checking Enable, enter the IP address that allows the user to login in the input box. Multiple IP addresses should be separated by ";", such as "127.0.0.1; 172.16.4.55; 192.169.80.12", and the suggested wildcard [] is supported, such as 172.16.[0-100]. [0-100]
Email validation	Login validation using only password
Sync task frequency	When enabled, the frequency of all sync tasks will be in compliance with this setting, users cannot set the frequency when creating and editing sync tasks in the User Portal
Prompt when logging in for the first time	After turning it on, a prompt will pop up on the user's home page when the user logs in for the first time.
Do not show hidden files	The file list does not show hidden files that start with "."
Disable the peer-to-peer	Turn off peer-to-peer transport for user

1.2 Edit user

Can edit user's password/home directory/permissions/speed limit/user group/prohibited path/synchronous directory function/file format transfer restriction/upload file option/file filtering/virtual directory/IP login whitelist/etc. Select any user and click Edit.

1.3 Lock/unlock user

Select any unlocked user and click Lock; for any locked user, click Unlock to unlock.

1.4 Delete user account

Check the users you want to delete and click Delete above. Click confirm to delete successfully.

1.5 Import LDAP/AD domain account

Click Import LDAP/AD domain account to actively import all domain user accounts created by the domain server, provided that you need to configure LDAP/AP domain in User Integration - Third-party Authentication to support this feature.

1.6 Import/Export users

Click Import User to fill in the account, mailbox, and password through the specified template. Click Export User to export the mailboxes, accounts, and names of all accounts.

1.7 Batch edit users

Select the account number that needs to be edited, click Edit to edit the status, directory settings, transmission settings, and security settings of the account number in batches

1.8 Copy user

Select the account you need to copy, click Copy to copy an account with the same settings, but the mailbox, account number, password, and name need to be configured separately.

1.9 Organization

Support the creation department and add users to the department. When importing the AD domain account, it can be imported directly according to the user's organization to facilitate the administrator to manage the user. The system defaults to the Local department.

2. User Integration

It supports AD domain user authentication, mailbox user authentication, Linux system user authentication and external http authentication methods, which are interoperable with enterprise internal accounts and easy to operate. Users only need to import an enterprise AD domain account or input email, Linux system account password or external http authentication user account password to log in Raysync system at the front-end.

2.1 LDAP/AD domain authentication

Support Windows Active Directory and OpenLdap 。

Click User Integration - Third-party login authentication, select LDAP/AD domain.

2.1.1 AD domain

Fill in the correct domain server address, domain name, domain username, domain password, click test, the test passed means the information is filled in correctly. Click Save to take effect.

1) If only import user1 into Raysync, you need to configure:
Domain account path: cn=user1, ou=RD, ou=BU, dc=abc, dc=com
Domain account and password: user1’s display name and user1’s password

2)If need to configure all the accounts under the group, you need to configure:
Domain account path: cn=group, ou=RD, ou=BU, dc=abc, dc=com
Domain test account and password: A user’s display name and this user’s password under RD organization unit.
If need to configure users from multiple organization units, please add the corresponding domain paths.
Note: Import group user not supported, the group users will be displaied on user list after login.

3)If need to import all the account under the RD organization unit, you need to configure:
Domain account path: ou=RD, ou=BU, dc=abc, dc=com
Domain test account and password: A user’s display name and this user’s password under RD organization unit.
If need to import users from multiple organization units, please add the corresponding domain paths.

4)If need to import all the users from the domain, you need to configure:
Domain account path: dc=abc, dc=com
Domain test account and password: A user’s display name and this user’s password under abc.com

Log in to the domain account at the user portal, you need to log in using User SamAccountName.

2.1.1 OpenLdap

Configuration instructions:
User 1 and the group is under the RD organization unit, the RD organization unit is under BU organization unit, the BU organization unit is under abc.com domain. user1 Path: abc.com/BU/RD/group/user1，the group path:abc.com/BU/RD/group
then,BindUser: uid=user1,ou=RD,ou=BU,dc=abc,dc=com (Binduser can also be any user in the abc.com domain)
BindPasswd: should be user1
1. If only import user 1 into Raysync, then
Domain account path: uid=user1, ou=RD, ou=BU, dc=abc, dc=com
2.If need to configure all the accounts under the group, then
Domain account path: cn=group, ou=RD, ou=BU, dc=abc, dc=com
If need to configure users from multiple organization units, please add the corresponding domain paths.
Note: Import group user not supported, the group users will be displayed on user list after login.
3.If need to import all the account under the RD organization unit, then
Domain account path: ou=RD, ou=BU, dc=abc, dc=com
If need to import users from multiple organization units, please add the corresponding domain paths.

2.2 Email authentication

Click Third-party login authentication, select Email Fill in the correct SMTP host, SMTP port, encryption, SMTP account and SMTP password, and the test pass means the information is filled in correctly. Click Save to take effect.

邮箱鉴权英文

2.3 Unix System authentication

When using the Linux system root authority or sudo authority to start the Raysync service, it supports configuring the Linux system user authentication. Click User Integration - Third-Party Login Authentication, select System Authentication, and click Save. It prompts that the save is successful and the configuration is successful. (The Raysync service started by ordinary Linux system users does not have permission to perform this configuration.

2.4 External http authentication

Supports the use of external http services for Raysync authentication. When you already have your own http service, you can directly log in to your original user in your http service to use Raysync, or you can log in to your http users in the Raysync system.

1) Permissions controlled by external http service: External http service logs with own accounts to use Raysync, and permissions are controlled by your http service. Users will not be created simultaneously in the Raysync system, and the accounts of the external http service cannot be used to log in to the Raysync system.

2) Permissions controlled by Raysync: Externally http service users will be created synchronously in the Raysync system, and permissions will be controlled by Raysync. Users can use the account and password of the external authentication service to log in to the Raysync system.

Integration documents can be provided by contacting Raysync technical or business personnel.

2.5 OpenID Connect

OIDC (OpenID Connect) is an authentication and authorization protocol based on the OAuth 2.0 protocol. It extends OAuth 2.0 to provide a standardized way for identities to enable users to authenticate with third-party applications and authorize those applications to access protected resources.

Raysync oidc authentication implements back-end communication with IDP. Its function is similar to the traditional OAuth process, and it interacts with the Raysync web application to obtain the access token through the traditional OAuth access token method. During this process, the IDP provider does not send user details, but a special one-time code that Raysync Web Services can exchange for an OAuth access token. In addition to the one-time code, this exchange needs to include the client ID and client secret, just like the traditional OAuth 2.0 flow. This token is invisible through the browser and enables Raysync services to authenticate between IDP services.

If you already have your own enterprise management system, you can log in to Raysync using your enterprise management system account.

2.5.1 OKTA Login

2.5.1.1 Create OKTA app

1) Log in to your okta management page, find Applications in the left menu bar, and click Create APP Integration

2) On the pop-up page, select Sign-in method: OIDC - OpenID Connect, and select Application type: Web Application. After completing the selection, click Next

3) Fill in the application information, please make sure the address is accurate

Function	Description
App integration name	App integration name
Client acting on behalf of a user	Authorization Code
Sign-in redirect URIs	redirect URIs：Your Raysync user portal url + /api/user/oidc/callback. For example: https://{{RAYSYNC_DOMAIN:8091}}/api/user/oidc/callback

4) Set the Assignments. The default selection is as follows. All users running okta. Click Save after completing the selection.

2.5.1.2 Get OKTA application information

1) Click on the created APP

2）Get the Client ID、Client Secret

3) In the left menu bar, select API under Security and enter

4) Click on the picture to enter the configuration information of okta

5) Get the Issuer

6) According to the issuer, obtain the configuration information address of idp. The conversion address is such as: {{issuer}}/.well-known/openid-configuration. After the conversion is completed, enter the address in the browser.

7) From the json information obtained in step 6, obtain authorization_endpoint, token_endpoint, userinfo_endpoint

2.5.1.3 Fill in OKTA APP information into Raysync

Fill in the above information into the oidc authentication configuration of the Raysync admin portal and click Save

Click Test Connection. If you successfully jump to OKTA's login page, the configuration is successful. After successful configuration, users can use their OKTA account to log in to Raysync user portal.

2.5.2 OneLogin Login

2.5.2.1 Create OneLogin app

1) Login into your management page, click on the upper navigation bar , Applications > Add App

2) Search for "OpenId Connect" or "oidc" and select Open Connect (OIDC)

3) Enter a name for the application and click Save

4) In the Configuration tab, configure the application information, make sure the address is accurate, and click Save

Function	Description
Login Url	Your Raysync user portal url https://{{RAYSYNC_DOMAIN:8091}}
Redirect URI's	Your Raysync user portal url + api/user/oidc/callback https://{{RAYSYNC_DOMAIN:8091}}/api/user/oidc/callback
Post Logout Redirect URI's	Your Raysync user portal url https://{{RAYSYNC_DOMAIN:8091}}

Function

Description

Your Raysync user portal url

https://{{RAYSYNC_DOMAIN:8091}}

Redirect URI's

Your Raysync user portal url + api/user/oidc/callback

https://{{RAYSYNC_DOMAIN:8091}}/api/user/oidc/callback

Post Logout Redirect URI's

Your Raysync user portal url

https://{{RAYSYNC_DOMAIN:8091}}

5) In the SSO tab, select Web for Application Type; select POST as the token endpoint for Authentication Method, and click Save

6) Add users to the application

Click the navigation bar Users > Users, then select a user and click to enter

Click Application and add

Select the application you want to add and click Save

2.5.2.2 Get OneLogin application information

1) Click to enter the app

2) Click SSO , get Client ID and Client Secret

3) Get IssuerURL

Click "Well-known Configuration" to get authorization_endpoint, token_endpoint, userinfo_endpoint

2.5.2.3 Fill in the OneLogin APP information into Raysync

After saving, click Test Connection. If you jump to the Onelogin login page, the configuration is successful. After successful configuration, users can use their Onelogin account to log in to Raysync user portal.

2.5.3 Google Login

2.5.3.1 Create Google credentials

1) Log in to google console https://console.cloud.google.com

2) Click API & Services

3) Click Credentials > Create Credentials

4) Select OAuth client ID

5) Select application type: Web application

6) Fill in Authorized JavaScript origins and Authorized redirect URIs

Function	Description
Authorized JavaScript origins	Your Raysync user portal url. The address must use a top-level domain name https://{{RAYSYNC Top-level domain:8091}}
Authorized redirect URIs	Your Raysync user portal url + /api/user/oidc/callback https://{{RAYSYNC Top-level domain:8091}}/api/user/oidc/callback

Function

Description

Authorized JavaScript origins

Your Raysync user portal url. The address must use a top-level domain name

https://{{RAYSYNC Top-level domain:8091}}

Authorized redirect URIs

Your Raysync user portal url + /api/user/oidc/callback

https://{{RAYSYNC Top-level domain:8091}}/api/user/oidc/callback

Click Create

7) Download json file or click to enter your Client to obtain your Client ID and Client secret

2.5.3.2 Fill in Google credentials information into Raysync

Log in to the Raysync admin portal , User--User integration--Third-party login auth--OpenID Connect

1) Open the help document

https://accounts.google.com/.well-known/openid-configuration

Get Issuer URL、Authorization Endpoint、Token Endpoint 、Userinfo Endpoint

2) Fill in the configuration information and save

4) Click Test Connection

If you jump to the Google login page, the configuration is successful.

After successful configuration, users can use their Google account to log in to Raysync user portal.

2.6 Default authentication permission configuration

After configuring the login authentication method, you can configure default permissions for the authenticated users.

LDAP / ad domain & Email & WeCom & OpenID Connect & External http authentication-Control permissions by Raysync & System: this page configuration is only valid for the newly logged in accounts in these authentication methods. The configuration of the logged in account can be modified through the account information list. (System authentication does not create account information and does not support "Prompt when logging in for the first time")

System & External http-Control permissions by external http service: This configuration does not take effect because the permissions are controlled by an external service.

6.5) Configuration

1 Basic Settings

1.1 Email settings

Send email notification for shared download/invite upload/notification/login 2FA verification.

Click Configuration-Email configuration. Set the correct mailbox server as required. You can send a test email to the specified mailbox to verify the availability of the mailbox. Click [Save] to take effect.

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, When enabled, all users can use sync. When disabled, all users cannot use sync.

2.3 Peer-to-Peer transfer

2.3.1 Peer-to-Peer transfer

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

Open Peer-to-Peer ports for the service. TCP/3443;UDP/3478;UDP/32003
Configure the public or internal ip address (the same as the IP address of the Raysync service) and port number of the peer-to-peer service. If the service is used on a public network, set the IP address to a public network. After the configuration is successful, the system restarts to take effect

Function	Description
Peer to Peer Server address	Public or internal IP addresses of peer-to-peer services (the same as the IP address of the Raysync service). Multiple IP addresses are supported, but domain names are not supported
Port	Port monitored by the Peer-to-Peer service. The default port is 32003

2.3.2 Stun Service

Function	Description
Stun Server address	Public IP address or domain name of the Stun service. Only one IP address is supported
Port	Port monitored by the Stun service. The default port is 3478

3. Link

Function	Description
Bind the first device when open the share link	the shared download link can only be opened on the first device. If you need to unbind the link, you need to unbind it in [Collaboration]-[Share to download]
Email login verification is required when sharing and inviting external personnel	Email login verification is required when sharing and inviting to anyone with the link.

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.

After opening MySQL, if you need to close it, you need to stop your service. In the configuration file "config.ini" of the server directory Raysync/config, modify "use_mysql = 0" and start the service.

4.2 Event (File Post Proccessing)

You can set different post-processing events based on different event types. In this way, you can write custom file post-processing logic based on specific business needs and characteristics of transmission tasks, implement custom post-processing logic, improve work efficiency, uniformly manage and monitor transmission tasks, and expand system functions and adaptability. This can better meet user needs and provide more powerful and flexible data transmission and processing capabilities. For example, you can automatically trigger a script or program after the file transfer is completed to perform format conversion, data processing, verification, etc. on the transferred files.

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.

事件通知英文

Options	Function Description
Even type	Trigger other programs when an event is executed.
Event execution	Executable program: When an event occurs, the action/execution program path will be triggered. HTTP callback: When an event occurs, the system will send a POST request to the URL to your HTTP callback address, and the event notification content will be delivered through the HTTP Body.
Program execution parameters	Program execution parameters The parameter variables supported by Raysync are: 1. File transfer event type, supported variable: $filepath file path $filename filename $filesize file size $userId user ID $clientIp client IP $clientMac client Mac (web page transfer task is not supported) 2. Task transmission event type, supports variables: $filesize total file size $userId user ID $dstPath target path $srcPath source path $taskId task ID $clientIp client IP $clientMac client Mac (web page transfer task is not supported) 3. Rename, delete, file (folder), create folder, supported variables: $filepath file size $filename file name $userId user ID $clientIp client IP $clientMac (use the client to get clientMac)

Options

Function Description

Even type

Trigger other programs when an event is executed.

Event execution

Executable program: When an event occurs, the action/execution program path will be triggered.

HTTP callback: When an event occurs, the system will send a POST request to the URL to your HTTP callback address, and the event notification content will be delivered through the HTTP Body.

Program execution parameters

The parameter variables supported by Raysync are:

1. File transfer event type, supported variable: $filepath file path
$filename filename
$filesize file size
$userId user ID
$clientIp client IP
$clientMac client Mac (web page transfer task is not supported)

2. Task transmission event type, supports variables:
$filesize total file size
$userId user ID
$dstPath target path
$srcPath source path
$taskId task ID
$clientIp client IP
$clientMac client Mac (web page transfer task is not supported)

3. Rename, delete, file (folder), create folder, supported variables:
$filepath file size
$filename file name
$userId user ID
$clientIp client IP
$clientMac (use the client to get clientMac)

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

events

4.3 Log

You can configure the log storage path and the storage period for transfer log, operation log, and system log. Log files larger than 1Gb are automatically and compress once a day.

6.6) Transfer Tasks

1. Clien tasks and Web tasks

View the live status and transmisfer logs of general task, peer to peer task, sync task, and web transfer tasks.

The real-time transmission can view the user account of the task that the user is transmitting/user source IP/file name file transfer type/file name of the transmission task/country/region/city of the source IP/total number of transfers/total transfer speed/average transfer speed/ Task status/failure reason.

Supports pausing tasks during live transmission and enabling/disabling synchronization tasks. Once a task is disabled, it will no longer be synchronized, and users cannot start disabled synchronization tasks.

Generral tasks

2.Server Task

2.1 Guide

How to create a server-delivered task？

Server Guide

You can download the Raysync Client after clicking the Raysync icon.

download client

You can hover over the image of the task creation and preview the detailed steps.

Preview server task

2.2 Task list

In theTask list module, you can create tasks, view the transfer details of tasks and modify or delete tasks.

Task list

2.2.1 Create task

Function	Description
General settings	1、Enter a unique task name 2、Enter the path of the client, you can enter an absolute path or enter a system variable Enter the path of the server, you can enter a relative path or enter a system variable
Direction	1、One-way transfer Synchronous upload or download 2、Two-way transfer Synchronous upload and download
Task frequency	Select the start time of the task, support two synchronization frequency settings (1) Synchronize once a day at a fixed time. For example , select " Daily 18:22 , the synchronization task will start synchronization at 18:22 every day (2) Synchronize every time period .For example, select Every 60 seconds, the synchronization task will start synchronization every 60 seconds (3) Synchronize once only For example , select " Once 12:00 , the synchronization task will start synchronization once at 12:00 (4) Synchronize by weekIf one or more dates are specified in a week , the synchronization will be performed at a certain time of theFor example , if you set 20:14 synchronization on Monday and Wednesday every week, you can synchronize
Security	Using AES-256 encrypted transmission to make transmission more secure after enabled
File processing	(1) The modification time of the transfer file is reserved, and it can be opened according to the specific needs of the user. (the default is on) turn on the "save modification time" option: after the synchronization task is transferred, the modification time of the file can be consistent with the local modification time. Turn off the "save modification time" option: after the synchronization task is transferred, the modification time of the file is consistent with the time when the current client transfer is completed (2) When transferring, only the files and folders in the source directory will be transferred (3) If the files of the source or target path are deleted, the files of the other party will be deleted synchronously. For example, synchronize the local directory to the server. If the test files in directory a are deleted, the test files on the server will be deleted synchronously. Note: synchronous deletion in the root directory is not supported temporarily; Synchronous deletion and transfer only source files cannot be checked at the same time. (4) After the synchronization task is completed, the source directory will be automatically deleted. For example, synchronize the local directory to the server. After the synchronization task is completed, the local directory will be deleted automatically
Please select the processing way when the target file already exists	(1) Overwrite directly overwrites the existing file contents. (2) If the source file is newer, the last modification time of the uploaded or downloaded file is newer than that of the target file, and the file is overwritten. (3) Append write to target file (not applicable to object storage) append a new file content to the end of the target file. (4) Rename (only one-way synchronization is supported) when the source file has the same name as the target file, rename the source file. For example, if there is test in the target path and a test with different content is uploaded, rename the newly uploaded file as test (1).
File filtering	(1)Support regular matching and filtering files. If the files ending in txt are transferred and filtered, enter "* txt". (2) When the synchronization task is transferred, the files ending in txt will not be transferred

When the synchronization task is transferred, files exceeding the set size will not be transferred. |

2.3 Logs

You can view the logs of tasks in the Logs module.

server task logs

6.7) Collaboration

1.1 Invite to upload

Click Collaboration - Invite to Upload, double-click to select the link of any user you want to view, it will display the link's invitation directory, username, sharing time, expiration time, and link status. Copy, cancel and delete links are supported.

1.2 Share to download

Click Collaboration - Share to download, select any link of the user you want to view. It will display the link's shared file, user name, sharing time, expiration time, download times, link status, whether to bind the first device, and device identification number. Copy, cancel and delete links are supported.

6.8) Files

Administrator can view the list of files for each space user, Group folder, Recycle bin and Isolation zone Click on File - Select Space to view it.

6.9) Security

1. Antivirus

Support antivirus after uploading files. Raysync mainly uses ClamAV (Clam AntiVirus) virus scanning tool to scan the uploaded files and will move the infected files to Isolation Zone.

Enter the directory to the Raysync Server’s clamdscan ,update of the virus library.

./updatedb.sh

After the upgrade is successful, enter the Admin Portal, clickSecurity - Antivirus to enable the antivirus configuration. Restart the Raysync server for changes to take effect.

Antivirus

When the uploaded files are scanned for viruses, the infected files are moved toFile -Isolation zone.

Isolation zone

2. Access Restrictions

Used for foreground user login restrictions. Set a white list, the IP addresses in the white list are allowed to log in to the front desk; set a black list, the IP addresses in the black list cannot log in to the front desk. Click Security- Access Restriction, select whitelist or blacklist, enter ip or ip range (such as 10.80.90.1-100), and click Save to take effect.

Access restriction

3. Watermark Settings

Used to configure video online preview watermark configuration. ClickEnable watermark, upload the watermark image, select the location, and click Save.

Watermark

4. Login Settings

It supports administrators to configure whether to allow users to modify passwords, account lockout rules, and weak password settings.

Functions	Description
Anti-brute force attacking	You can configure the user password to lock the account after X consecutive wrong input within X minutes, and the number of wrong input is 3~30 times. After the configuration is saved, it will take effect.
Allow users to change their passwords	If selected, the front-end users can change their passwords in the front-end, and the button to change the password is displayed in the foreground. If not selected, it will not be displayed.
Weak password settings	Passwords that users are not allowed to set, please use“ ; ”to separate multiple passwords, such as Raysync;raysync. After the configuration is saved, it will take effect.
Email validate	After enabling, you need both password and email validate code to log in. (only support Local users)

Before enabling email login verification, you need to configure the system mailbox. Configure it under the Settings - Email configuaration

Email setting

5. Certificate Management

5.1 TLS certificates

Raysync provides encrypted certificate services that can be used for both HTTP encryption of the web and file transfer encryption. The default is to use Raysync's own encryption certificate, or you can use the user's own certificate for encryption. Fill in the correct certificate file and certificate private key, click Start Upload, and restart the server to take effect

If you select Prohibit non-SSL connections, the front-end user pages cannot be accessed using non-encrypted HTTP addresses. Note: The premise of configuring security settings is that the administrator needs to upload a valid TLS certificate.

5.2 Client Certificate

Raysync Client certificate is the certificate used by the client to connect with the browser. Available in two ways:

One is to obtain the latest certificate from the default Alibaba Cloud OSS. When the server can access the external network, Raysync will automatically download the latest client certificate from the oss storage when the oss certificate is updated.

The second is to download from the Raysync server. When the network cannot access the external network, please configure the certificate location as the Raysync server. Click to upload the latest certificate bundle. The certificate package is provided by Raysync staff. After uploading the certificate, click Save. Re-login to the client on the front-end page to download the client certificate.

5. Detective Sensitive words

During the transmission process, the content of the file name and text file can be detected. The content of the file contains sensitive words. The system will automatically allocate the file to the isolation area.

If you need to detect the sensitive word like "kill", the input box inputs the sensitive word "kill", click [Save] and then enable

Multiple sensitive words are separated by ;

6.10) Notification

1. Manual Notification

The administrator can send the notification to the specified account by web page notification or email notification.
Click notification - Add Notification, edit message notification, select receiving account and notification method. (If email notification is selected, the administrator needs to configure the email in the Admin Portal in advance to send the notification successfully.)

2. System Notification

System notifications are divided into four categories, namely Log in, Space management, Upload and Download and Antivirus (The administrator needs to configure the email in the Admin Portal in advance to send the notification successfully.)

2.1 Space management

Function	Description
Notify new users when they are added	When the administrator adds a new member to a space, the system mailbox sends an email to the user, and the user can click the space name in the email to log in and jump to the space
Notify new administrator when they are added	When the administrator adds a new administrators to the space, the system mailbox will send an email to the administrator, the administrator can click the space name in the email, and after logging in, he can jump to the space for space configuration
Notify new members when they are added to the group folder	When the administrator adds a new member to the group folder, the system mailbox will send an email to the member, the member can click the group name in the email, and can jump to the group folder after logging in

2.2 Upload and download

Function	Description
Notify space administrator when transfer starts	When a member starts uploading or downloading files in space, the system mailbox will send an email to all administrators of the space. The email contains the user name of the file being transferred, path,etc. Support selected administrators to receive the system notification from selected users.
Notify space administrator when transfer task completed	When a member completes uploading or downloading files in space, the system mailbox will send an email to all administrators of the space. The email contains the user name of the file being transferred, the number of files to be transferred, and a list of 5 files to be transferred. Support selected administrators to receive the system notification from selected users.
Notify space administrator when transfer task failed	When a member fails to upload or download files in space, the system mailbox will send an email to all administrators of the space. The email contains the user name of the file being transferred, the number of files to be transferred, and a list of 5 files to be transferred. Support selected administrators to receive the system notification from selected users.
Notify the creator when the transfer task completed	When uploading or downloading files is completed, the system mailbox will send the upload or download completed email to the task creator. The email content includes the number of files and lists 5 files. Supports selecting creators who need to be notified
Notify the creator when the transfer task failed	When uploading or downloading tasks have failed tasks, the system mailbox will send an email to notify the task creator. The email content includes the number of files that failed to upload this time and lists 5 files that failed to upload or download. Supports selecting creators who need to be notified

2.3 Antivirus

Function	Description
Notify space administrator when virus files are detected	When a user uploads a file containing a virus, the system mailbox will send an email to notify all administrators of the space. The content of the email includes the file name of the detected virus, virus type, upload space, upload path, and upload time.

2.4 Notification settings

Supports specifying transfer users, specifying administrators, and customizing email templates for transfer notification emails.

6.11) Customize

Support website customization and website keyword customization Website customization includes shortcut icon, logo, background image, background colour, button colour, screen position Keyword customization includes: company name, product abbreviation, company website

1 Site Design

Click customize- Site design

自定义英文

2 Site Keywords

Click customize- Keywords

关键字英文

3 Menu Bar

Supports customizing the menu bar of the user's web page and desktop client, if you deselect it, it will not be displayed on the User features.

You can also disable the access the user portal or share/invite links.

example:

client 1

client 2

6.12) Log

Click [Log] to view the operation users, modules, operation details, IP, time and other information of the administrator and front desk, as well as the log of user video preview

6.13) Statistics

Support the total amount of storage of space files, the total amount of personal files, the total amount of group folders, the statistics of the space flow, the statistics of member traffic, IP traffic, and collaboration statistics.

1. Timing Statistics

In spatial management-space statistics, regular statistics can be opened for personal file storage or group file inventory. After opening, full statistics will be performed according to the statistical cycle.

定时统计2

2. Real-time Statistics

Real-time statistics of storage usage when adding or reducing files on the Client, and real-time statistics of transfer traffic when transferring files.

7) Admin Portal Guide

7.1) Devices

1. Server Settings

1.1 License activation

Raysync server needs to activate the license to experience the maximum speed. If the license is not activated, the default bandwidth is 5Mbps.

Click Server on the home page and click Activate, enter the correct activation code and restart the service to take effect. 激活英文

1.2 View license

Server-license information

查看激活码信息

1.3 View disk space

Server - Disk Space

磁盘英文

1.4 Service operation status

Server-Server operation status

1.5 View server monitoring information

1.5.1 CPU information

Server-cpu information

cpu英文

1.5.2 NIC information

Server-NIC Information

网卡英文

1.6 View online users

Server - Connected Users

查看在线用户数英文

1.7 Shutdown, startup, and reboot Raysync service

Server - Basic Information

1.8 Edit server information

Server information includes Server Address, UDP Port, UDP Package size, Default Storage Path Bandwidth, Compression, and other functions. Click Server - Modify.

Function	Description
Server Address	The server address can be changed to an IP address or domain name.
UDP Acceleration Port	The UDP port can be changed to a port between 1 and 65535. The default is 32001. You need to ensure that the server firewall already has the UDP port. Otherwise, the transfer will fail. After the change, you need to restart the server.
UDP Message Size	UDP message size is generally set to the default value. The default is 1200 (the range is 600~1442).
Enable Compression	After enabling, files that can be compressed for transfer will be compressed, which can reduce bandwidth usage and improve transfer efficiency.
Outbound Bandwidth	The server export bandwidth is not configured by default, and the export bandwidth is not limited. When set to 0 or not filled in, the bandwidth limit will not take effect

2. Client Devices

3. Topology

This interface displays the storage of the server, the node Client connecting to the server, as well as the transfer data flow between nodes and between server and nodes.

7.2) Account

7.3) File

7.4) Configuration

7.5) Transfer Task

1. Client tasks and Web tasks

View the live status of general task, peer to peer task, sync task, and web transfer tasks.

2. Server task

2.1 Guide

How to create a server-delivered task？

You can download the Raysync Client after clicking the Raysync icon.

2.2 Task list

In the Task list module, Click "add", enter the task name, select the synchronization direction, enter the source path and target path, select the synchronization frequency, and click "save" to create the task., also can view the transfer details of tasks and modify or delete tasks.

2.3 Create task

Function	Description
General settings	1、Enter a unique task name 2、Enter the path of the client, you can enter an absolute path or enter a system variable Enter the path of the server, you can enter a relative path or enter a system variable
Direction	1、One-way transfer Synchronous upload or download 2、Two-way transfer Synchronous upload and download
Task frequency	Select the start time of the task, support two synchronization frequency settings (1) Synchronize once a day at a fixed time. For example , select " Daily 18:22 , the synchronization task will start synchronization at 18:22 every day (2) Synchronize every time period .For example, select Every 60 seconds, the synchronization task will start synchronization every 60 seconds (3) Synchronize once only For example , select " Once 12:00 , the synchronization task will start synchronization once at 12:00 (4) Synchronize by weekIf one or more dates are specified in a week , the synchronization will be performed at a certain time of theFor example , if you set 20:14 synchronization on Monday and Wednesday every week, you can synchronize
Security	Using AES-256 encrypted transmission to make transmission more secure after enabled
File processing	(1) The modification time of the transfer file is reserved, and it can be opened according to the specific needs of the user. (the default is on) turn on the "save modification time" option: after the synchronization task is transferred, the modification time of the file can be consistent with the local modification time. Turn off the "save modification time" option: after the synchronization task is transferred, the modification time of the file is consistent with the time when the current client transfer is completed (2) When transferring, only the files and folders in the source directory will be transferred (3) If the files of the source or target path are deleted, the files of the other party will be deleted synchronously. For example, synchronize the local directory to the server. If the test files in directory a are deleted, the test files on the server will be deleted synchronously. Note: synchronous deletion in the root directory is not supported temporarily; Synchronous deletion and transfer only source files cannot be checked at the same time. (4) After the synchronization task is completed, the source directory will be automatically deleted. For example, synchronize the local directory to the server. After the synchronization task is completed, the local directory will be deleted automatically
Please select the processing way when the target file already exists	(1) Overwrite directly overwrites the existing file contents. (2) If the source file is newer, the last modification time of the uploaded or downloaded file is newer than that of the target file, and the file is overwritten. (3) Append write to target file (not applicable to object storage) append a new file content to the end of the target file. (4) Rename (only one-way synchronization is supported) when the source file has the same name as the target file, rename the source file. For example, if there is test in the target path and a test with different content is uploaded, rename the newly uploaded file as test (1).
File filtering	(1)Support regular matching and filtering files. If the files ending in txt are transferred and filtered, enter "* txt". (2) When the synchronization task is transferred, the files ending in txt will not be transferred

When the synchronization task is transferred, files exceeding the set size will not be transferred.

7.6) Collaboration

1. Invite to upload

2. Share to download

7.7) Security

1. Antivirus

Support antivirus after uploading files. Raysync mainly uses ClamAV (Clam AntiVirus) virus scanning tool to scan the uploaded files and will move the infected files to Isolation Zone.

Click Security - Antivirus to enable the antivirus configuration. Restart the Raysync server for changes to take effect.

2. Access Restrictions

Used for foreground user login restrictions. Set a white list, the IP addresses in the white list are allowed to log in to the front desk; set a black list, the IP addresses in the black list cannot log in to the front desk. Click Security - Access Restriction, select whitelist or blacklist, enter ip or ip range (such as 10.80.90.1-100), and click Save to take effect.

3. Watermark Settings

Used to configure video online preview watermark configuration. Click Enable watermark, upload the watermark image, select the location, and click Save.

4. Login Settings

It supports administrators to configure whether to allow users to modify passwords, account lockout rules, Multi-factor Authentication and weak password settings.

Functions	Description
Anti-brute force attacking	You can configure the user password to lock the account after X consecutive wrong input within X minutes, and the number of wrong input is 3~30 times. After the configuration is saved, it will take effect.
Allow users to change their passwords	If selected, the front-end users can change their passwords in the front-end, and the button to change the password is displayed in the foreground. If not selected, it will not be displayed.
Weak password settings	Passwords that users are not allowed to set, please use“ ; ”to separate multiple passwords, such as Raysync;raysync. After the configuration is saved, it will take effect.
Multi-factor Authentication	Email verification, it is supported for user login, administrator login(except the super administrator.), and modification of user information. Support verification through "all IP/Skip verification for listed IPs/Verify only listed IPs". (Before enabling email login verification, you need to configure the system mailbox. Configure it under the Configuration - Email configuration.) Authenticator App, it is supports two-factor authentication using authenticators such as Google Authenticator or Microsoft Authenticator when user login, administrator login, or modification of user information. Support verification through "all IP/Skip verification for listed IPs/Verify only listed IPs". You can ignore the admin's two-facotr verification by modifying the value of the field "block_super_administrator_login_email_verify" or "block_super_administrator_login_totp_verify" to 1 in the Raysync Server's config/config.ini. Graphic verification, only for user login.
Graphic verification code	When enabled, you need to enter a graphic verification code each time you log in to the User portal or links
Login Restrictions	Login error limit The account will be automatically disabled after specified days days without login Restrict IP login

6. Sensitive words

If you need to detect the sensitive word like "kill", the input box inputs the sensitive word "kill", click [Save] and then enable

Multiple sensitive words are separated by ;

7. Certificate Management

7.1 TLS certificates

Raysync provides encrypted certificate services that can be used for both HTTP encryption of the web and file transfer encryption. The default is to use Raysync's own encryption certificate, or you can use the your own certificate for encryption. Fill in the correct certificate file and certificate private key, click Start Upload, and restart the server to take effect

7.2 Client certificates

The client certificate used to establish an encrypted connection between the plugin and the browser. The Raysync server comes with this certificate. For online services, this certificate is automatically updated annually. For offline services, when the client certificate expires, you need to upload a new one. Support for uploading your own certificate. After uploading the new certificate, the user needs to exit the plugin Client and restart it on the Web for the changes to take effect.

8. Delete files

8.1 Scheduled file deletion

You can create scheduled file deletion rules. Click 【Scheduled file deletion】-【Add】 to set your file deletion rule, click 【Save】, then click 【Associated path】, select the path you want to delete, and click 【Save】. When the system triggers the conditions of this deletion rule, it will automatically delete the files in the path you selected or move them to the recycle bin. It only supports local storages.

8.2 Manual file deletion

The files that the user manually deletes, you can choose to delete them directly, or first move them to the recycle bin before deleting them.

7.8) Log

1. Log Presentation

Click [Log] to view the operation logs of administrators and front desk users, as well as logs for various types of transfer tasks and user video previews.

2. Log Collection

Click [Log Collection] to view all log files from the server, and you can select individual files or choose to select all for download.

3. Optimization of Log List Classification Module

1) The "Create Time" and "Last Update" fields have been optimized to provide a clearer and more intuitive timeline for the current task.

2) Improved interactivity of virtual path settings

You can now view detailed information for each task in the History section, with support for downloading the logs of the current task.

4. Support to check the connection type of P2P task on transfer log

You can check the connection type of P2P on log transfer record, direct and relay. As shown in the figure below.

7.9) Statistics

Click [Statistics] to view the total storage amount of files, individual file storage, group file library storage, traffic statistics, member traffic statistics, IP traffic, and collaboration statistics. 统计英文

1. Timing Statistics

In Configuration-Statistics period, regular statistics can be opened for personal file storage or group file inventory. After opening, full statistics will be performed according to the statistical cycle.

2. Real-time Statistics

Real-time statistics of storage usage when adding or reducing files on the Client, and real-time statistics of transfer traffic when transferring files.

8) User Portal Guide

8.1) Profile

1. User login

Login Process Please enter the login page, enter the correct user name and password, and click Login. The password needs to be changed for the first login and the new password is used to successfully log in.

Enter the user login page of Raysync. The URL address of the login page is generally the server IP + port number "8090" ( e.g.:192.168.1.1:8090)
Enter the login page, the page includes the user name and password. Enter the user name and password and click the Login button, (if the background management configures the user to reset the password for the first login)enter the reset password page, otherwise, a message will be displayed indicating that the user name or password is incorrect.

login1-en

2. Browser Usage Tips

Tips added for non-Google browsers: It is recommended to use Google Chrome.

3. User Log Out

Click the user name button in the upper right corner to expand the options, click the Log Out button. logOut-en

4. User Center

Click the user name in the upper right corner to expand options, and click the "Personal Center Button" button.

4.1 User Massage

Click User Massage, edit your real name and your login email.

4.2 Update Password

Click Update Password to change the login password of the account.

4.3 Mail Settings

Click Mail Settings to configure the sender email address for sharing and downloading email notifications.

4.4 Forget Password

Click Forget Password, enter the user's login email, and use the received verification code to reset the password. Note: Forget password function needs to configure the system mail. For details, please refer to the server user guide - configuration - email configuration.

Enter the user's login email address and click Next
Send the verification code, click Next
If the verification code expires, please click Resend. The verification code expires in 10 minutes, and the resend time is 60 seconds.
Enter a valid new password. Click Confirm Reset to complete the password modification. Note: The password needs to be 8 to 20 characters, including three combinations of uppercase letters, lowercase letters, numbers and characters, and the password cannot be the same as the username.

5. Download app

You can scan the code with the scan tool of the browser to obtain the installation package of the Android app or jump to the app store to install the raysync app.

download app

8.2) My Files

1 Client installation and uninstallation

Raysync client supports the installation of windows server 2008/ windows server 2012/ windows server 2016/windows 7/windows 8/windows 10/mac os 10.11 and above.

1.1 Download client

If the client is not installed or started, click the "Client Download" button and select the client of the corresponding platform to download.

1) Use Desktop client for high-speed experience without webpage.

2) Use the Browser plug-in client to perform high-speed file transfer through the web page.

1.2 Desktop Client: Linux Version Now Available

Raysync Desktop Client upgrade supports Linux system, which can meet your needs for client operation on Linux system.

1.3 Install the client

1) Install Desktop client

After the download is successful, double-click on it to start the installation

Select installation options and click [Next]
Select the path to install and click [Install]
After the installation is complete, click Finish to run the desktop client

After starting the desktop client, enter the server address (the default server IP address + port number 8090, for example, http://192.168.1.1:8090), as well as your account and password to log in to the desktop client for high-speed transmission.

2) Install Browser transfer plug-in

After the download is successful, double-click to open to start the installation, as shown below
Read the software installation agreement and click I accept to proceed to the next step
Select the installation option and click Next
Select the components to be installed and click Next

install3-en

install4-en

Select the path to be installed and click Next

install5-en

Select Install, and click Finish after the installation is complete

install6-en

install7-en

install8-en

1.4 Start the client

Startup method 1

After the user logs in to the webpage, the system will check whether the Raysync client has been activated. If the Raysync client is not activated, it will automatically switch to the web page tcp connection mode, which only supports normal upload/normal download/invite to upload/ Share to download. If you need to use other functions, you need to start the Raysync client.
Click Transfer List on the Raysync front-end web page. The prompt dialog box for startup or download will pop up. Click the "Start" button.
A message is displayed asking you whether to open raysync-watch. exe. Click to open the application and wait until the startup is complete.

Startup method 2

If the message that the client is not connected pops up, click "Start".
A message is displayed asking you whether to open raysync-watch. exe. Click to open the application and wait until the startup is complete.

1.5 Uninstall the client

Uninstall method 1

Enter Windows "Control Panel" -> "Programs" -> "Programs and Features"
Select the Raysync client program, right-click to uninstall.

uninstall1-en

Uninstall method 2

Right-click on the desktop Raysync client icon, click Open file location
Select uninstall.exe, right-click the uninstall.exe program, select Run as administrator, and Confirm to remove the client.

uninstall2-2-en

uninstall-2-3-en

2 File Operations

Raysync supports two ways of transfer: web(without the client)and client. In the absence of a client (web), you can create a new folder/invite upload/download/share download/copy/move/delete/property/rename, while creating a synchronization task directory/previewing videos requires the installation of a client.

2.1 Upload file

Click Upload file with web Select the file to upload You can view the transfer progress of the selected uploaded file in the transfer list of bottom right corner of the web

uploadFile web

uploadFile web2

Click upload folder with web Select the folder to upload You can view the transfer progress of the selected uploaded files in a folder in the transfer list of bottom right corner of the web.(not applicable to empty folder)

uploadFolder web

uploadFolder web2

Click upload with client Select the file or folder to upload. You can view the transfer progress of the selected uploaded file in the transfer list of client.

transferList-en

Drag and drop upload You can select and drag the file or folder you want to upload from the file manager, long press the left mouse button, and drag to the file list position of the raysync website, until the upload to my file/a directory appears, release the left mouse button to upload all the dragged files.

First step：

drop

Second step：

drop 3

Third step：

drop 2

2.2 Download file

Select the file or folder to download Click the download with web,you can view the download progress of the selected file or folder in the browsers's downloads.

download Web

Select the file or folder to download Click the Download button or select Download in the operation bar
You can view the download progress of the selected file of folder in the transfer list of the client
After the file is downloaded, it will be saved in the selected path. Click the "Open File Directory" icon in the Raysync plugin to find the file just downloaded.

download Client

transferList-en

2.3 File operations

1) Create a new folder

Click the New Folder button
The default name of the new folder is "New Folder", you can enter a new folder name by yourself
After entering the name, click the Create button to complete

newFolder-en

2) Rename

Select the file/folder to be renamed, and select Rename in the operation. Note: virtual directory does not support renaming on the client side

rename-en

The file name becomes editable, enter the name that needs to be renamed
Enter the name and click OK to save

3) Delete files

Select the file/folder to be deleted, click the delete icon or select Delete in the operation

delete-en

4) Search

After clicking search, enter the name of the file/folder to be searched in the search box, such as: test
Click ENTER to search successfully

5) Moving files

Select the file, click the Move button or move within the operation
Select the directory you want to move to, click to move here

move-en

6) Copy files

Select the file, click the Copy button or copy within the operation
Select the directory to be copied to, click Copy to this

copy-en

7) Folder Properties

Select the folder whose properties you want to view, and click Properties of the operation to view the properties of the folder. Note: View properties are not supported for file folders
Pop-up folder properties popup

8) Uzip file

Decompress zip, 7zip, and rar files

2.4 Creat sync task

To use this synchronization function, you need the permission to use sync tasks in the user information configuration managed by the administrator in the server background. syncA

Click the Create Sync Directory Task button
Pop up a new synchronization directory pop-up box
Setup Instructions: Sync Directory
Enter the task name of the sync task, the source path, the target path, the sync frequency

Function	Description
Task name	The name of a synchronization task is displayed in the task list after it is successfully created.
Direction	1) One-way Synchronize folder from the server to the local; Synchronize folder locally to the server. When the source path is the server,the folder is synchronized from the server to the local.When the source path is the computer ,the folder is synchronized from the local to the server. 2) Two-way Raysync service will conduct two-way synchronization between radium speed server and local directories. After the two-way sync is enabled, Raysync will first upload the locaI directory files to the server directory, and then download the files of the server directory to the local directory, so as to maintain the consistency between the server directory and the local client directory files.
Source path	Select the source folder path to be synchronized,support two-way. When the source path is the computer, it is a synchronous upload. When the source path is the server, it is a synchronous download. When two-way synch is used, the source and target paths are not distinguished. When selecting folder, you can select multiple paths of the same level to transfer.
Target path	Select the target path for synchronization to the server or local.
Sync schedule	Select the start time of the synchronization task,support two synchronization frequency settings. 1) Synchronize once a day at a fixed time. For example, select "Daily 18:22", the synchronization task will start synchronization at 18:22 every day. 2)Synchronize every time period. For example, select Every 60 seconds,the synchronization task will start synchronization every 60 seconds. 3)Synchronize once only. For example,select"Once 12:00",the synchronization task will start synchronization once at 12:00. 4)Synchronize by week If one or more dates are specified in a week,the synchronization will be performed at a certain time of the specified week. For example,if you set 20:14 synchronization on Monday and Wednesday every week,you can synchronize at 20:14 on Monday and Wednesday.

security

Turn on encrypted transfer

sync2a

Document Handling

Selection of file processing method: retain file modification time; transfer only files and folders in the source directory; when the source file is deleted, the target file is automatically deleted; after each file sync is completed, the source file is automatically deleted; two-way sync

Function	Description
Preserve modification time Enabled	Enabled: After the synchronization task is completed, the modification time of the file is the same with the local modification time. Disabled: After the synchronization task transfer is completed, the modification time of the file is the same with the current client transfer completion time.
Only transfer source files	Enabled: The folder of the first layer will not be transmitted Disabled: All files and folders in the directory will be transferred.
Delete target file synchronously when source deleted	Enabled: if the file of the source or destination path is deleted, the other party's file will also be deleted synchronously. For example, if the local directory A is synchronized to the server, if the "test" file in the A directory is deleted, the "test" file on the server will be deleted synchronously. Tips: Root directory is not supported; "Delete Synchronously" and "Transfer source files only" can notenabled both.
Preserve file ACL attribute	It is a mechanism for permission control of files or directories. It can control the access permissions of users or groups to files or directories. Acls enable administrators to finer control file or directory access permissions to better protect system security. Retention is only supported between the same systems.
Check before transfer start ，It will not start until file is no change in 3~30s	The transfer will be checked once at the beginning of the transfer, when the file has not changed within 3-30 years, the file will actually start the transfer. When the file is changed within the specified time, the file will not be transferred. Avoid transferring files that are in use and ensure the integrity of the transferred files.
The processing mode of source files after synchronization is complete	1, after synchronization, automatically delete the source directory (for synchronous upload, download) 1) Delete all source directories and files For example, after the synchronization is complete, directory A and the files in directory A are automatically deleted. 2) Retain the source directory structure and delete only the files in directory A. Neither directory A nor the directories in Directory A are deleted 2. After synchronization, transfer the source file and delete it (only applicable to upload) The uploaded source file is automatically transferred to the path xx after xx hours, and the source file is automatically cleared after xx days.
Synchronous transfer Supports synchronization when the source file is updated	Synchronize only when the source file has been modified or added, which can avoid unnecessary duplicate synchronization operations
File update	When the target file already exists and content is inconsistent with the source file,you have two updatesways 1) Overwrite target file Directly overwrite existing file contents 2) Overwrite if sou rse newer Overwrite if the last modification time of the uploaded or downloaded file is newer than the time of the target file. 3) Append to the target file (Notapplicable to object storage) Append the new file contents to the end of the target file 4) Rename file Rename the source file when the source file has the same name as the target file For example: if test exists in the target path, if a test with different content is uploaded, the newly uploaded file will be renamed to test(1).

File Filter

Function

Description

Filtering-transfer files and folder

Supports setting files that are allowed to be transferred or filtered. Files and folder that meet the conditions will be filtered or transferred.

Supports the use of wildcards. For example, if you need to filter all files starting with "test" during transfer, you can enable the blacklist and enter test*.

Filtering-filter files of a specified size filter

Files file whose size exceeds the set size when transferring

2.5 File preview

Select the file you want to preview, click the location of the file name, you can preview it online.

Preview Type:

- Image: png, jpg, gif, jpeg, bmp, ico, svg
- Office: doc, docx, ppt, pptx, xls, xlsx, csv (Office service needs to be installed separately)
- Video: mp4, avi, mov, mxf, mpg (On the web page, video preview requires Raysync Client plugin.)

preview-en

preview3-en

2.6 Isolation zone

2.6.1 Virus blocker

If the file you upload through the website contains a virus.

uploadVirusWEB

If the file you upload through the client contains a virus.

uploadVirusClient

2.6.2 Virus view

You can view the virus type and other information of the isolated file through the file name.

name

You can view the virus type and other information of the isolated file through the isolation time.

time

2.7 Support share file preview only

When using the client, this feature allows users to share files with others for preview only. Users can choose whether to permit downloading the shared content.

When you're creating the Sharing Link:
Adjust the logic of the [Allow Downloaded] feature:
When the option is enabled:
Web end---User can download files and can preview them online.
Client end---User can download files and can preview them online.

When the option is disabled:
Web end---User can only view the list of shared files, and cannot download or preview them online.
Client end---User can only view the list of shared files, and cannot download but can preview them online.

2.8 The synchronization feature supports real-time updates

When modifying the corresponding files, the modified files can be synchronized in real time.

Note: Currently, only real-time synchronization and upload are supported, and only local storage is supported.

2.9 File Upload and Download through Raysync Links Supported

Shared links support upload and download via the desktop client. After copying the link, open the desktop client to automatically detect it. You can then manually initiate the upload or download.

If Raysync fails to detect the link in your clipboard, you can manually enter it here.

8.3) Group Folders

Group space can support multi-user collaborative file management.

Select - Group File Folder in the left navigation bar to enter the group, and open the page to display all the group file libraries that the current user is in.
The arrangement of the group file library can be switched in the upper right corner of the display page, and can be switched between list display and horizontal tiling.

Select to enter any group file library, all files and folders of the group file library will be displayed
You can select any file/folder in the group file library to download and upload, create sync tasks, create new folders, and delete operations, which are the same as uploading, downloading, creating sync tasks, creating new folders, and deleting in personal space. Note: The group file supports users to share external links

8.4) Peer to Peer

Raysync client supports direct transfer between user and client, data does not upload on the server, the server only carries out data traffic transit. User A is online, user A provides his own transfer ID and key, other users can connect to user A through the transfer ID and key, and the data is transferred directly to user A's computer without uploading on the server's disk.

1.1 Send Peer to Peer transfer file

Click Peer to Peer on the web page to enter the peeer-to-Peer transfer interface
Enter the recipient's device ID or Email, select the file name to be sent, click start to transfer, that is, the Peer to Peer transfer task is created successfully

Note: The recipient needs to turn on the Allow to receive files button on the web page

1.2 Receive peer to peer files

Click Peer to peer Receive on the web-page
If the recipient does not want to receive direct transfer files sent by others, click the web page to uncheck Allow to receive files
or Turn off the receiving files on Raysync Client

Transfer Status Description

Status	Description
Sending	Files/folders are sending
Completed	Files/folders transfer Completed
Canceled	The sender client pauses the task
Failed	During the transfer, the failure will be displayed when the following situation occur: one exits the client, the receiving client's transfer is suspended, the transfer is interrupted, the network connection is not good, the server is abnormal, the transfer fails, the authentication fails, etc.
Receiver offline , ready for transfer	When the receiver is not online, the sender can still create a task to send to the receiver, and the status is ready for transfer. When the receiver goes online, it will automatically receive the file.

1.3 View peer to peer transfer task on Client

8.5) Share Link

1.1 Create share link

Select the file/folder you need to share, click[Share to download], support select multiple files/folders to share at the same time.

Options	Function Description
Sharing scope	Anyone with the link: No user authentication, anyone with the link can get the file. Only people in your organization: After obtaining the link, the user needs to log in to the Raysync account to get the file.
Whether to allow users to download	After turning it off, the shared files cannot be downloaded.
Download times	Anyone with the link: The total number of times the link was viewed, the number of downloads shared by all people who accessed the link. Only people in your organization: Individual downloads for each visiting user.
Specify the email to access	When the email address is specified, only users with the specified email address can log in and access the link. When no email address is specified, any user who obtains the link can log in and access the link.
Whether to set a password	Without setting a password: any user who obtains the link can access the shared file. Set a password: You need to verify the correctness of the password when accessing the link.
Link expiration time	Set link expiration time.
File aliases	Only for files, you can set an alias for the file and then share it. The shared file will be displayed with the alias.
Email notifications to partners	Notify others to open the link when it is created. Note: By default, the notification email use the administrator's email service as the sender. You can set your personal email as sender. This needs to be set up by the administrator at first. (For details, please refer to "Admin Portal Guide" - Local User - Mailbox sender.) If the administrator has set the user's mailbox as the email sender, you need to configure your own email notification service. (Please refer to "User Guide" - Profile - Email Settings.)
Send regularly	After setting the timer, the system will send emails to notify others to open the link at the set time.
Notify to recipients	It will send a separate identical notification email to the private recipient, and the email content can choose whether to include the access password.
Download notifications	Notification when download starts and when download is completed

Click to create the share link, the link access password will be automatically generated.

1.2 Access the share link

Enter the share link address in the browser, enter the password, and click Log in

Enter the file list of shared download links and click the download button to start downloading.

1.3 Share link management

Cancel the share links Select the link that needs to be canceled in the sharing link, click Disable,

share8-en

After canceling, the link will no longer be accessible

Turn on the device binding Note: To enable this function, the administrator needs to enable it on the server background. For details, please refer to the setting-sharing link in the "Admin Portal Guide". If the second device accesses the link, it will prompt that the device has been bound.

1.4 Enable/Disable Shared Link Functionality

1) After you create a sharing link (upload/download), you can disable it if you no longer want to use it.

2）To maintain the validity of this link, you may enable it.

8.6) Invitation Link

1.1 Create an invite to upload link

Enter the folder where you want to invite uploads, such as the "Raysync" directory, and click the "Invite to upload" button

invite-en

1.2 Internal member fuzzy search

When selecting members within the organization, you can use a fuzzy search based on the user’s account, email address, or name. This search method allows for imprecise or partial keywords and returns closely matching results using advanced algorithms.

1.3 Support specify the recipient's email to protect shared content

Specify the recipient's email address. Add the specified email address on the following page. Only the recipient of the specified email address can access this link.

Options	Function Description
Invitation scope	Anyone: No user identity login verification is required. Anyone who obtains the link can upload files to the invited directory. Only people in your organization: After obtaining the link, the user needs to log in to the Raysync account to upload the file.
Specify the email to access	When the email address is specified, only users with the specified email address can log in and access the link. When no email address is specified, any user who obtains the link can log in and access the link.
Set a password	It need to verify the correctness of the password when accessing the link.
Link expiration time	Set link expiration time.
Allow deletion	When enabled, others can delete files in the invitation link.
Email notifications to partners	Notify others to open the link when it is created. Note: By default, the notification email use the administrator's email service as the sender. You can set your personal email as sender. This needs to be set up by the administrator at first. (For details, please refer to "Admin Portal Guide" - Local User - Mailbox sender.) If the administrator has set the user's mailbox as the email sender, you need to configure your own email notification service. (Please refer to "User Guide" - Profile - Email Settings.)
Send regularly	After setting the timer, the system will send emails to notify others to open the link at the set time.
Notify to recipients	It will send a separate identical notification email to the private recipient, and the email content can choose whether to include the access password.
Upload notification	Notification when upload starts and when upload is completed.

Click Create Link, a link and an access password will be generated by default
Click Copy Link and Password, you can copy the link and password and send it to your partner.

1.4 Visit the invite to upload link

Enter the link address of invite to upload in your browser, enter your password and click Log in
Enter the file list of invite to upload link, click Upload to start uploading files
Enter the file list of invite to upload link, click New Folder, you can create a new folder, or upload files to the new folder. Note: The file list shows all the files and folders in the invited directory, for example, if the invitation is uploaded to "Raysync" directory, it will show all the files and folders in the directory of "Raysync".

1.5 Manage invite to upload links

Cancel the link
Select the link you want to cancel and click cancel invitation

invite-8-en

invite-6-en

8.7) Cilent Settings

1 Transfer List

For high-speed transfer tasks created on the web page, you can view task details in the task list.

Click [Transfer List] in the upper right corner of the web page, click the client icon, or right-click the client and select [Transfer List] to enter the transfer list.

Displays the progress/speed of the transfer task/the number of files that have been transferred/the total number of files in the task/the file task details included in the task/task transfer speed curve and other information
Supports task (batch) deletion, (batch) pause, (batch) start, use Ctrl+standalone tasks for multiple selection, or Ctrl+A to select all. Supports operations such as opening local directories, retrying, pinning tasks, viewing details, etc. You can view the function of the button by hovering over it.
Sort tasks and filter by create time.

Double-click the task name to enter the task details and view the task transmission speed. Including curve graphs, transmission mode, average speed, delay, packet loss rate, and packet size

speed-en

Click the task details to view the file name, file size, progress, error reason, number of file transfers, and file transfer status

taskDetails

The transfer list includes three types of tasks: General task transfer tasks, Sync tasks, and Peer to Peer tasks.

1.1 General transfer tasks

Upload files (folders) locally on the client to the server, or download files (folders) from the server to the client, a one-time transfer task.

1.2 Sync directory task

1.2.1 Sync Directory Task List

It supports synchronous uploading of directories to the server locally on the client, or one-way scheduled synchronization tasks of downloading directories from the server to the client, or bidirectional directory synchronization between the client and the service.

Supports editing and modifying synchronization task synchronization, encryption, file processing methods and other configurations.

Sync task status description

Idle: when the task sync frequency mode is interval time and the time point has not yet reached
Schedule: When the task sync frequency method is daily fixed time point and the sync time has not yet arrived
Idle (completion time): When the task sync frequency mode is daily fixed time point and the sync has been completed, but the next sync time point has not yet reached

1.3 Peer to peer tasks

1.3.1 Peer-to-peer task list

Peer to-peer transfer between clients, direct transfer after network detection, without going through the server, saving server traffic

After the sender creates a direct transfer task successfully, the client of the sender and receiver will directly transfer the task transfer list, and you can view the current task progress, task speed, task file number, task status, task details, etc. of the sender and receiver

Peer to Peer Task Status Description

statusInstraction

2 Transfer Settings

2.1 Transfer

Function Description

Function	Description
Download path	Supports setting a default download path and manually selecting a path when downloading
Task parallel	Support to set the maximum number of upload tasks and the maximum number of download tasks, up to 10 Support setting parallel files per task. The default setting is automatic, which is calculated automatically based on the number of CPU cores. Support setting Muti-Channe tranfer. Multi-channel parallel transfers (for high-bandwidth networks) to send data concurrently and significantly boost transfer speeds. This requires the server to open port 2542, 2642, and 2472. If it is encrypted, please open ports 2453, 2643, and 2743.
Data compression	When enabled, the data will be compressed before being transmitted during transmission to improve transmission efficiency
UDP packet size	When the network bandwidth is good, it is recommended to set the large the UDP packet size, the better the transmisson effect. When the network bandwidth is poor, the smaller the setting, the better the transmisson effect.

2.2 Bandwidth

Function	Description
Limit max speed	Upload limit: maximum upload speed for a single task Download limit: maximum download speed for a single task If not set, the maximum speed of the local bandwidth will be used for transfer by default.
Limit min speed	When the network condition is unstable and the current client upload transmission speed does not fully utilize the bandwidth, you can manually set the minimum sending speed to increase the transmission speed. Minimum Send speed: indicates the minimum upload speed of the current client Minimum Accept speed: The minimum download speed of the current client (Usually set to 1/2 of the bandwidth with the current transmitting client. If the bandwidth of the transmission server is smaller than the current client bandwidth, it is set to the bandwidth value of the server)

Function

Description

Limit max speed

Upload limit: maximum upload speed for a single task

Download limit: maximum download speed for a single task

If not set, the maximum speed of the local bandwidth will be used for transfer by default.

Limit min speed

When the network condition is unstable and the current client upload transmission speed does not fully utilize the bandwidth, you can manually set the minimum sending speed to increase the transmission speed.

Minimum Send speed: indicates the minimum upload speed of the current client

Minimum Accept speed: The minimum download speed of the current client

(Usually set to 1/2 of the bandwidth with the current transmitting client. If the bandwidth of the transmission server is smaller than the current client bandwidth, it is set to the bandwidth value of the server)

2.3 Peer-to-Peer

Function	Description
ID	Support updating device ID for peer-to-peer reception
Receive file save path	In p2p transfer, the saving path of the receiver
Turn off reception	After closing, others will not be able to send files to the current device.

2.4 Advanced Settings

Function	Description
Automatically run at start up	Raysync client will automatically run when the computer reboot unexpectedly.
Enable hash check	Enabling hash verification can verify every single file when upload or download, and ensure the integrity and correctness of files. If the hash check of the local file and the server file are inconsistent, the file will be retransmitted. If the hash check of the two files is consistent, the transmission will continue.
Priority to use TCP	The tcp transmission mode will be preferentially used during the transmission after enabled. So that our files will be lost during transmission.
Priority to use encrypted transfer	Enable encrypted transmission, encrypt the transmission process, and ensure transmission security.
Preserve file timestamps after transfer completed	Keep the modification time of the transmitted file after enabled.
Enable Rsync check	If the local file and the server file Rsync check result are inconsistent, the file will be retransmitted; If only part of the two files is not the same, the consistent part will be skipped and the different part will be transferred. If the two file have the same Rsync verification, It will continue to transfer.
Rename file when the target file already exists	Rename the target file when it already exists
Only download new files	When the target file already exists,the user will fail to download when the file has not been modified.
Timeout	increasing the timeout time can maintain the effect of Raysync transmission when the network is poor.
Check before transfer start ，It will not start until file is no change in 3~30s	The transfer will be checked once at the beginning of the transfer, when the file has not changed within 3-30 years, the file will actually start the transfer. When the file is changed within the specified time, the file will not be transferred. Avoid transferring files that are in use and ensure the integrity of the transferred files.
Preserve file ACL attribute	It is a mechanism for permission control of files or directories. It can control the access permissions of users or groups to files or directories. Acls enable administrators to finer control file or directory access permissions to better protect system security. Retention is only supported between the same systems.
Preserve the full structure of the source directory when upload to the target	When uploading files, a complete directory structure will be automatically created on the target side.

2.5 Proxy

For the needs of company's security control, employees' computers do not have direct access to the Internet, but need to go through the company's proxy server to access the Internet. SOCKS5 is currently the most commonly used generic proxy server.
Click SOCKS5, enter the correct proxy service host, proxy port, proxy user and password. Click OK to connect to the SOCKS5 proxy.

2.6 Default server

After configuring the default server, the administrator can specify the client device when monitoring and controlling the client device in the backend management, and when creating server delivery tasks.

Enter the correct server address, login username and password, and click Save

3 Error detection

Right-click the client and select Error Detection to access error detection. You can view the client version number, program version number, port connectivity, whether it is started as administrator, UDP speed detection, client related configuration information, server related information, and in case of transmission abnormalities or failures, clicking this option will generate an error detection report and automatically fix the problem.
When the port connection of some services fails, it will affect the use of your client. Please contact your administrator to check whether the Raysync service has opened these ports.
If you use the UDP protocol for transfer and you feel that the current client transfer speed is very slow, you can also try to test the UDP speed. The system will check the UDP speed between your client and the server to help you check whether the current speed is normal.

4 Log Setting

Supports configuring the client log retention period. Logs that exceed the log period will be automatically cleared.
Automatically compress client logs 24 hours a day
Supports collection of client logs for the day so that you can provide them to our technical support for problem location.

5 About Raysync

Right-click the client and select About, check the client version number, and check whether it is the latest version of Raysync

6 Exit

Exit the client connection and use the web page to transfer files.

9) Raysync Cloud

1. Install the client

After the download is successful, double-click on it to start the installation

Select installation options and click [Next]
Select the path to install and click [Install]
After the installation is complete, click [Finish] to run the desktop client

2. Log in

After starting the desktop client, enter the Raysync server address, and click [Next]. Then enter your account and password, click to [Log In] to log in to the desktop client for high-speed transfer.

3. Create transfer task

We provide 3 transfer modes:

General transfer task: manually upload your local files to the storage, or download files from the storage .
Sync transfer task: regularly synchronize your local directory to the storage, or regularly synchronize from the storage directory to your local. You can also synchronize your local directory with the directory on the storage in both directions to keep the directories on both sides consistent.
Peer to peer transfer task: you can send your local files directly to other partners' devices without uploading the files to the storage first.

3.1 General task

Upload files or folders

In the [My files] , you can click [Upload] or drag and drop the files to upload the files or folders you want to upload.
You can view the upload transfer task progress in [General Task].

Download files or folders

Select the files or folders you want to download and click [Download].
You can view the download transfer task progress in [General Task].

View transfer tasks

In the [General Task], you can view manual upload/download transfer tasks and transfer history.
You can pause, delete, start, and view the transfer details of the task in progress.

3.2 Sync task

In the Sync Task, Click the [Create Sync Task] .
Enter the task name of the sync task, the source directory path to be synchronized, the target path, the sync frequency and other optional configuration. Then click [Create].

Function	Description
Task name	The name of a synchronization task is displayed in the task list after it is successfully created.
Direction	1) One-way Synchronize folder from the server to the local; Synchronize folder locally to the server. When the source path is the server,the folder is synchronized from the server to the local.When the source path is the computer ,the folder is synchronized from the local to the server. 2) Two-way Raysync service will conduct two-way synchronization between radium speed server and local directories. After the two-way sync is enabled, Raysync will first upload the locaI directory files to the server directory, and then download the files of the server directory to the local directory, so as to maintain the consistency between the server directory and the local client directory files.
Source path	Select the source folder path to be synchronized,support two-way. When the source path is the computer, it is a synchronous upload. When the source path is the server, it is a synchronous download. When two-way synch is used, the source and target paths are not distinguished. When selecting folder, you can select multiple paths of the same level to transfer.
Target path	Select the target path for synchronization to the server or local.
Sync schedule	Select the start time of the synchronization task,support two synchronization frequency settings. 1) Synchronize once a day at a fixed time. For example, select "Daily 18:22", the synchronization task will start synchronization at 18:22 every day. 2)Synchronize every time period. For example, select Every 60 seconds,the synchronization task will start synchronization every 60 seconds. 3)Synchronize once only. For example,select"Once 12:00",the synchronization task will start synchronization once at 12:00. 4)Synchronize by week If one or more dates are specified in a week,the synchronization will be performed at a certain time of the specified week. For example,if you set 20:14 synchronization on Monday and Wednesday every week,you can synchronize at 20:14 on Monday and Wednesday.
Security-enable encryption transfer	Use encrypted transfer to make transfer more secure.
File Handling-Preserve modification time Enabled	Enabled: After the synchronization task is completed, the modification time of the file is the same with the local modification time. Disabled: After the synchronization task transfer is completed, the modification time of the file is the same with the current client transfer completion time.
File Handling- Only transfer source files and folders in the source directory	Enabled: The folder of the first layer will not be transmitted Disabled: All files and folders in the directory will be transferred.
File Handling- Delete target file synchronously when source deleted	Enabled: if the file of the source or destination path is deleted, the other party's file will also be deleted synchronously. For example, if the local directory A is synchronized to the server, if the "test" file in the A directory is deleted, the "test" file on the server will be deleted synchronously. Tips: Root directory is not supported; "Delete Synchronously" and "Transfer source files only" can notenabled both.
File Handling-Preserve file ACL attribute	It is a mechanism for permission control of files or directories. It can control the access permissions of users or groups to files or directories. Acls enable administrators to finer control file or directory access permissions to better protect system security. Retention is only supported between the same systems.
File Handling- Check before transfer start ，It will not start until file is no change in 3~30s	The transfer will be checked once at the beginning of the transfer, when the file has not changed within 3-30 years, the file will actually start the transfer. When the file is changed within the specified time, the file will not be transferred. Avoid transferring files that are in use and ensure the integrity of the transferred files.
File Handling- The processing mode of source files after synchronization is complete	1, after synchronization, automatically delete the source directory (for synchronous upload, download) 1) Delete all source directories and files For example, after the synchronization is complete, directory A and the files in directory A are automatically deleted. 2) Retain the source directory structure and delete only the files in directory A. Neither directory A nor the directories in Directory A are deleted 2. After synchronization, transfer the source file and delete it (only applicable to upload) The uploaded source file is automatically transferred to the path xx after xx hours, and the source file is automatically cleared after xx days.
File Handling- Synchronous transfer Supports synchronization when the source file is updated	Synchronize only when the source file has been modified or added, which can avoid unnecessary duplicate synchronization operations
File Handling-handling of existing target files	When the target file already exists and content is inconsistent with the source file,you have two updatesways 1) Overwrite target file Directly overwrite existing file contents 2) Overwrite if sou rse newer Overwrite if the last modification time of the uploaded or downloaded file is newer than the time of the target file. 3) Append to the target file (Notapplicable to object storage) Append the new file contents to the end of the target file 4) Rename file Rename the source file when the source file has the same name as the target file For example: if test exists in the target path, if a test with different content is uploaded, the newly uploaded file will be renamed to test(1).
Filtering-transfer files and folder	Supports setting files that are allowed to be transferred or filtered. Files and folder that meet the conditions will be filtered or transferred. Supports the use of wildcards. For example, if you need to filter all files starting with "test" during transfer, you can enable the blacklist and enter test*.
Filtering-filter files of a specified size filter	Files file whose size exceeds the set size when transferring

After successful creation, you can see the transfer status of the sync task in the list. You can pause, start, delete, view task transfer details, and edit sync task configuration.

3.3 Peer to Peer task

3.3.1 Send Peer to Peer transfer file

In the Peer to Peer, click [Create Task].
In the Start to Transfer , Enter the recipient's device ID or Email. Click to [upload] or drag and drop to select the files or folders you want to send. Click [Start Sending].

Note: The recipient needs to turn on the [Allow to receive files]

If you want to create a scheduled Peer to Peer task, click [scheduled sending] to set the scheduled when creating it.

3.3.2 Receive peer to peer files

In the Peer to Peer, Enable [Allow to receive files], then others can send files to you.
If the recipient does not want to receive files sent by others, Disable [Allow to receive files].
You can set the default save path for accepted files in the [Settings]-[Transfer]-[Peer to Peer].

After successful creation, you can see the transfer status of the peer-to-peer task in the task list. You can pause, start, delete the task, and view the task transfer details.

4. Create share link

You can share the files (folders) on the storage with other partners to download.

Select the file/folder you need to share, support select multiple files/folders to share at the same time. Click [Share to download].

Click [Create Link], the link access password will be automatically generated.
Click [Copy Link and Password], you can copy the link and password and send it to your partner.

Options	Function Description
Sharing scope	Anyone with the link: No user authentication, anyone with the link can get the file. Only people in your organization: After obtaining the link, the user needs to log in to the Raysync account to get the file.
Whether to allow users to download	After turning it off, the shared files cannot be downloaded.
Download times	Anyone with the link: The total number of times the link was viewed, the number of downloads shared by all people who accessed the link. Only people in your organization: Individual downloads for each visiting user.
Whether to set a password	Without setting a password: any user who obtains the link can access the shared file. Set a password: You need to verify the correctness of the password when accessing the link.
Link expiration time	Set link expiration time.
File aliases	Only for files, you can set an alias for the file and then share it. The shared file will be displayed with the alias.
Email notifications to partners	Notify others to open the link when it is created. Supports scheduled email notifications. After setting the timer, the system will send emails to notify others to open the link at the set time.
Download notifications	Notification when download starts and when download is completed

4.1 Access the share link

Enter the share link address in the browser, enter the password, and click [Log in].

Enter the file list of shared download links and click [download] to start downloading.

share7-en

4.2 Share link management

In [Link Management]-[Share to download], Select the link you click [Detail] can view the details of the shared link.
Select the link that needs to be canceled in the sharing link, click [Disable] to cancel the shared link.

After canceling, the link will no longer be accessible

5. Create invite link

Invite other partners to upload files to your storage.

Enter the folder where you want to invite uploads, such as the "Raysync" directory, and click the [Invite to upload] button.

Click [Create Link], a link and an access password will be generated by default
Click [Copy Link and password], you can copy the link and password and send it to your partner.

Options	Function Description
Invitation scope	Anyone: No user identity login verification is required. Anyone who obtains the link can upload files to the invited directory. Only people in your organization: After obtaining the link, the user needs to log in to the Raysync account to upload the file.
Link expiration time	Set link expiration time.
Allow deletion	When enabled, others can delete files in the invitation link.
Email notifications to partners	Notify others to open the link when it is created.
Upload notification	Notification when upload starts and when upload is completed.

5.1 Visit the invite to upload link

Enter the link address of invite to upload in your browser, enter your password and click [Log in] .

Enter the file list of invite to upload link, click [Upload] to start uploading files.
Enter the file list of invite to upload link, click [New Folder], you can create a new folder, or upload files to the new folder. Note: The file list shows all the files and folders in the invited directory, for example, if the invitation is uploaded to "Raysync" directory, it will show all the files and folders in the directory of "Raysync".

invite-11-en

5.2 Manage invite to upload links

In [Link Management]-[Invite to upload], Select the link you click [Detail] can view the details of the shared link.
Select the link you want to cancel and click [Disable] to cancel.

6. Client setting

In the , You can perform client settings, error detection, and view client information.

	Function	Description
Basic	startup	Raysync client will automatically run when the computer reboot unexpectedly.
Upgrades	Automatically detect new versions and prompt to upgrade when a new version is available
Transfer	Download Path	Support setting the default download path and manually selecting the path when downloading.
Task and file parallel	Task parallel: Setting the maximum number of parallel upload tasks and the maximum number of parallel download task, up to 10. Parallel files per task: Setting parallel files per task, the default is automatic, and the parallel files per task is automatically calculated based on the number of cpu cores.
Bandwidth	Limit max speed Upload limit: maximum upload speed for a single task Download limit: maximum download speed for a single task If not set, the maximum speed of the local bandwidth will be used for transfer by default.
Limit min speed When the network condition is unstable and the current client upload transmission speed does not fully utilize the bandwidth, you can manually set the minimum sending speed to increase the transmission speed. Minimum Send speed: indicates the minimum upload speed of the current client Minimum Accept speed: The minimum download speed of the current client (Usually set to 1/2 of the bandwidth with the current transmitting client. If the bandwidth of the transmission server is smaller than the current client bandwidth, it is set to the bandwidth value of the server)
Transfer Security	Enable encrypted for transfer Enable encrypted transmission, encrypt the transmission process, and ensure transmission security.
Enable hash verification Enabling hash verification can verify every single file when upload or download, and ensure the integrity and correctness of files. If the hash check of the local file and the server file are inconsistent, the file will be retransmitted. If the hash check of the two files is consistent, the transmission will continue.
Transfer Protocol	Priority to use TCP When your network condition is good, you can enable TCP transmission. The tcp transmission mode will be preferentially used during the transmission after enabled. Ensure the reliability of file transfer.
Peer to Peer	Save path when receiving file Set the default save path for accepted files.
Incremental Transfer	Enable Rsync verification If the local file and the server file Rsync check result are inconsistent, the file will be retransmitted; If only part of the two files is not the same, the consistent part will be skipped and the different part will be transferred. If the two file have the same Rsync verification, It will continue to transfer.
Advanced	Enable data compression during transfer When enabled, the data will be compressed before being transfer during transfer to improve transfer efficiency.
Preserve the full structure of the source directory when upload to the target When uploading files, a complete directory structure will be automatically created on the target side.
UDP packet size When the network bandwidth is good, it is recommended to set the large the UDP packet size, the better the transfer effect.
Timeout Increasing the timeout time can maintain the effect of Raysync transfer when the network is poor.
File Handling	File Properties	Preserve file modification time Keep the modification time of the transmitted file after enabled.
Preserve file ACL attribute It is a mechanism for permission control of files or directories. It can control the access permissions of users or groups to files or directories. Acls enable administrators to finer control file or directory access permissions to better protect system security. Retention is only supported between the same systems.
Handling of existing target files	Overwrite target file Directly overwrite existing file contents Overwrite if sou rse newer Overwrite if the last modification time of the uploaded or downloaded file is newer than the time of the target file. Append to the target file (Notapplicable to object storage) Append the new file contents to the end of the target file Rename file Rename the source file when the source file has the same name as the target file For example: if test exists in the target path, if a test with different content is uploaded, the newly uploaded file will be renamed to test(1).
Source file handling	Check before transfer start, it will not start until file is no change in xx second. The transfer will be checked once at the beginning of the transfer, when the file has not changed within 3-30 second, the file will actually start the transfer. When the file is changed within the specified time, the file will not be transferred. Avoid transferring files that are in use and ensure the integrity of the transferred files.
Delete the source file after sync every file done 1) Delete all source directories and files For example, after the synchronization is complete, directory A and the files in directory A are automatically deleted. 2) Retain the source directory structure and delete only the files in directory A. Neither directory A nor the directories in Directory A are deleted 2. After synchronization, transfer the source file and delete it (only applicable to upload) The uploaded source file is automatically transferred to the path xx after xx hours, and the source file is automatically cleared after xx days.
Download files	Only download new files When the target file already exists,the user will fail to download when the file has not been modified.
Proxy	Proxy	For the needs of company's security control, employees' computers do not have direct access to the Internet, but need to go through the company's proxy server to access the Internet. SOCKS5 is currently the most commonly used generic proxy server. Click SOCKS5, enter the correct proxy service host, proxy port, proxy user and password. Click [save] to connect to the SOCKS5 proxy.
Log	Log	Save cycle xx days Configuring the client log retention period. Logs that exceed the log period will be automatically cleared.
Log operation Collect the Client logs for the day so that you can provide them to our technical support for problem location.

Function

Description

Basic

startup

Raysync client will automatically run when the computer reboot unexpectedly.

Upgrades

Automatically detect new versions and prompt to upgrade when a new version is available

Transfer

Download Path

Support setting the default download path and manually selecting the path when downloading.

Task and file parallel

Task parallel: Setting the maximum number of parallel upload tasks and the maximum number of parallel download task, up to 10.

Parallel files per task: Setting parallel files per task, the default is automatic, and the parallel files per task is automatically calculated based on the number of cpu cores.

Bandwidth

Limit max speed

Upload limit: maximum upload speed for a single task

Download limit: maximum download speed for a single task

If not set, the maximum speed of the local bandwidth will be used for transfer by default.

Limit min speed

Minimum Send speed: indicates the minimum upload speed of the current client

Minimum Accept speed: The minimum download speed of the current client

Transfer Security

Enable encrypted for transfer

Enable encrypted transmission, encrypt the transmission process, and ensure transmission security.

Enable hash verification

Enabling hash verification can verify every single file when upload or download, and ensure the integrity and correctness of files. If the hash check of the local file and the server file are inconsistent, the file will be retransmitted. If the hash check of the two files is consistent, the transmission will continue.

Transfer Protocol

Priority to use TCP

When your network condition is good, you can enable TCP transmission. The tcp transmission mode will be preferentially used during the transmission after enabled. Ensure the reliability of file transfer.

Peer to Peer

Save path when receiving file

Set the default save path for accepted files.

Incremental Transfer

Enable Rsync verification

If the local file and the server file Rsync check result are inconsistent, the file will be retransmitted; If only part of the two files is not the same, the consistent part will be skipped and the different part will be transferred. If the two file have the same Rsync verification, It will continue to transfer.

Advanced

Enable data compression during transfer

When enabled, the data will be compressed before being transfer during transfer to improve transfer efficiency.

Preserve the full structure of the source directory when upload to the target

When uploading files, a complete directory structure will be automatically created on the target side.

UDP packet size

When the network bandwidth is good, it is recommended to set the large the UDP packet size, the better the transfer effect.

Timeout

Increasing the timeout time can maintain the effect of Raysync transfer when the network is poor.

File Handling

File Properties

Preserve file modification time

Keep the modification time of the transmitted file after enabled.

Preserve file ACL attribute

It is a mechanism for permission control of files or directories. It can control the access permissions of users or groups to files or directories. Acls enable administrators to finer control file or directory access permissions to better protect system security. Retention is only supported between the same systems.

Handling of existing target files

Overwrite target file
Directly overwrite existing file contents
Overwrite if sou rse newer
Overwrite if the last modification time of the uploaded or downloaded file is newer than the time of the target file.
Append to the target file (Notapplicable to object storage)
Append the new file contents to the end of the target file
Rename file
Rename the source file when the source file has the same name as the target file
For example: if test exists in the target path, if a test with different content is uploaded, the newly uploaded file will be renamed to test(1).

Source file handling

Check before transfer start, it will not start until file is no change in xx second.

The transfer will be checked once at the beginning of the transfer, when the file has not changed within 3-30 second, the file will actually start the transfer. When the file is changed within the specified time, the file will not be transferred. Avoid transferring files that are in use and ensure the integrity of the transferred files.

Delete the source file after sync every file done

1) Delete all source directories and files

For example, after the synchronization is complete, directory A and the files in directory A are automatically deleted.

2) Retain the source directory structure and delete only the files in directory A. Neither directory A nor the directories in Directory A are deleted

2. After synchronization, transfer the source file and delete it (only applicable to upload)

The uploaded source file is automatically transferred to the path xx after xx hours, and the source file is automatically cleared after xx days.

Download files

Only download new files

When the target file already exists,the user will fail to download when the file has not been modified.

Proxy

For the needs of company's security control, employees' computers do not have direct access to the Internet, but need to go through the company's proxy server to access the Internet. SOCKS5 is currently the most commonly used generic proxy server.

Click SOCKS5, enter the correct proxy service host, proxy port, proxy user and password. Click [save] to connect to the SOCKS5 proxy.

Log

Save cycle xx days

Configuring the client log retention period. Logs that exceed the log period will be automatically cleared.

Log operation

Collect the Client logs for the day so that you can provide them to our technical support for problem location.

7. Notification

Click , You can view the notifications sent to you by the administrator.

8. Total Speed

Hover the mouse to , You can view the total upload and download speed of the current client.

9. Profile

In the [Profile], You can view your account information, modify your account, email, and password.

Click [Switch Account], You can log in to other accounts and log out of the current account.

Click [Exit Client], It will shut down the raysync client.