Skip to content

Syncplify.me Server v8

Main Navigation www.syncplify.com

Appearance

Sidebar Navigation

Manual & Docs

READ THIS FIRST

General concepts

BREAKING CHANGES

Glossary

High Availability (HA)

Logical structure

Log levels

BlockList, SafeList, AllowList

Variables (parametric stuff)

Installation and Setup

System requirements

Download the installer

Install on Windows

Install on Linux

Deploy with Docker

HA Cluster Setup

Administration (Web UI)

SuperAdmin UI

Logging in

Managing "self"

Managing virtual sites

Creating virtual sites

Editing a virtual site

What is "draining"?

Global Configuration

JWT

CORS

Security

Custom Response Headers

SMTP (e-mail)

Single Sign-On

Language

Log Settings

Binding

Trusted Proxies

Metrics

Telegram Bot

SuperAdmin profiles

Cluster Health

Backup/Restore

Certificates

License

Admin UI

Logging into the Admin UI

The dashboard

The blocklist

Virtual file systems (VFS)

LDAP (Active Directory)

Managing users

Security

One-click!

General settings

R2FS settings

Safe/Allow lists

Password constraints

Single Sign-On

Protocols

General SSH/SFTP settings

Advanced SSH/SFTP settings

General FTP(E/S) settings

Advanced FTP(E/S) settings

General WebClient! settings

Advanced WebClient! settings

Additional WebClient! settings

WebClient! "Share" Settings

WebClient! "Email" Settings

Scripting/event-handling

Scripts

Event handlers

Secrets

Other settings

Global speed limits

SMTP settings

Logging

Certificates & Keys

SSL/TLS Certificates

SSH Host Keys

Miscellaneous concepts

Dynamic "banners"

Reporting

Administration (REST API)

OpenAPI definitions

Scripting/Event-Handling

Event-Handlers

VS Code Extension and MCP Servers

Server!-specific SyncJS

Helper functions

Exit()

GetCurrentVFS()

EventHandler()

ScriptID()

ScriptName()

HandlerPriority()

CtxRelPath()

ExecutionTimeout()

ExecutionTimeLeft()

MakeTOTP()

ValidateTOTP()

Terminate (disconnect the session)

The "Session" object

GetID()

GetUser()

GetUserID()

GetVirtualSite()

GetRemoteAddress()

GetClientVersion()

GetProtocol()

GetStartTime()

GetLastActivity()

BlockOperation()

AddCustomData()

GetCustomData()

GetAllCustomData()

AddQuestion()

AddQuestionPassword()

AddQuestionTOTP()

AuthenticateUserFromScript()

GetAbsPath()

GetAbsTargetPath()

GetRelPath()

GetRelTargetPath()

RemoveFromDirList()

GetLastCommand / GetLastCommandWithParm

GetLastCommandTime()

GetLastError()

GetLastErrorTime()

The "User" object

GetID()

The "VFS" object

Response types

VFS Constructors

GetCurrentVFS()

Stat() and Lstat()

ReadDir()

Mkdir()

MkdirAll()

Rmdir()

Rename()

Remove()

RemoveAll()

TreeSize()

Symlink()

Chown()

Chmod()

Chtimes()

Truncate()

ReadFileAsText()

ReadFileAsHex()

ReadFileAsBytes()

WriteFileAsText()

WriteFileAsHex()

WriteFileAsBytes()

ImportFile()

ExportFile()

CopyToVFS()

MoveToVFS()

The SyncJS language

SyncJS types

Directory list items

Global constants

Local file-system functions

ListDir (list a directory)

ListDirR (recursive ListDir)

CopyFile (copy a file)

MoveFile (move/rename a file)

DelFile (delete a file)

SecureErase (secure file deletion)

MakeDir (create a directory)

DelDir (delete an empty directory)

DelTree (delete directory-tree)

ReadTextFile (read a text file)

ReadFileAsHex (read file bytes)

Write text to file (2 ways)

Zip (compress files)

Unzip (extract an archive)

FileType (identify MIME-type)

StatFileSystemObject (file/dir)

FileExists (check for file)

HashFile (file hashing)

DirExists (check for directory)

GetTempFileName (temp file path)

Chown (change file owner)

FileAgeSecs (file age in seconds)

FileSizeOf (file size)

WaitForFile (wait until a file appears)

SplitFileByLines (split text file into chunks)

SplitFileBySize (split file into fixed-size chunks)

GzipFile / GunzipFile (gzip compression)

Web (HTTP/HTTPS) functions

Configuration methods

HTTP(S) verbs

HttpRes response object

SQL database functions

Supported database servers

Configuring SqlCli

Connecting to a DB server

Querying a dataset

Insert/Update/Delete

AMQP message queue protocol

AMQP object properties

Connecting to an AMQP queue

Monitoring a queue

Processing messages

Posting messages to a queue

Cloud and integration functions

Send to Slack (webhook)

SendToTeamsWebHook (Microsoft Teams)

Send SMS via Twilio

Messaging functions

SendMail (sending emails)

NotifyViaTelegramBot

Process management

Run (execute a process)

RunAsync (async execution)

RunCapture (run and capture output)

Encoding, hashing, and data functions

Base64Encode / Base64Decode

HashString (hash a string)

HmacSign / HmacVerify (HMAC signatures)

ParseCSV / FormatCSV (CSV data)

ParseXML (parse XML data)

TcpConnect (TCP connectivity check)

Image processing

JPEGResample (resize a JPG)

PNGResample (resize a PNG)

JPEGMetadata (extract EXIF)

PNGMetadata (PNG info)

Remote client objects

Client constructors and connection fields

Configure() — URL + payload setup

ClientOptions (transfer settings)

Operations reference

Security/encryption functions

GetSecret

Generate a PGP key-pair

PGP encrypt file

PGP decrypt file

PGPSignFile (create a detached signature)

PGPVerifyFile (verify a detached signature)

Miscellaneous functions

Log (custom log line)

Sleep (pause execution)

Extract file path

Extract file name

Extract file extension

Num-to-string (padded)

Unique IDs (UUID)

ToDate()

FormatDateTime (date/time formatting)

Exit (stop script execution)

ScriptID / ScriptName (script identity)

ExecutionTimeout / ExecutionTimeLeft

More (cool) stuff

Requiring a Node.js module

The "underscore.js" library

WebClient! UI

Usage

Sharing

Settings

On this page

Image processing

This section covers SyncJS functions for image and picture manipulation and management.

Last updated:

Pager

Previous pageTcpConnect (TCP connectivity check)

Next pageJPEGResample (resize a JPG)