Skip to content

Syncplify Server! V7

Main Navigation www.syncplify.com

Appearance

Sidebar Navigation

Manual & Docs

READ THIS FIRST

General concepts

BREAKING CHANGES

Glossary

Logical structure

Log levels

BlockList, SafeList, AllowList

Variables (parametric stuff)

Installation and Setup

Minimum hardware

Download the installer

Install on Windows

Install on Linux

Administration (Web UI)

SuperAdmin UI

Logging in

Managing "self"

Managing virtual sites

Creating virtual sites

What is "draining"?

Global Configuration

JWT

CORS

Security

SMTP (e-mail)

Log Settings

Binding

Trusted Proxies

Metrics

Telegram Bot

SuperAdmin profiles

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

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

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

Server!-specific SyncJS

Helper functions

Exit()

GetCurrentVFS()

EventHandler()

ScriptID()

ScriptName()

HandlerPriority()

ExecutionTimeout()

SecondsLeft()

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()

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

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)

FileType (identify MIME-type)

StatFileSystemObject (file/dir)

HashFile (file hashing)

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

Cloud and integration functions

Send to Slack (webhook)

Send SMS via Twilio

Messaging functions

SendMail (sending emails)

NotifyViaTelegramBot

Process management

Run (execute a process)

RunAsync (async execution)

Image processing

JPEGResample (resize a JPG)

PNGResample (resize a PNG)

JPEGMetadata (extract EXIF)

PNGMetadata (PNG info)

Security/encryption functions

Generate a PGP key-pair

PGP encrypt file

PGP decrypt file

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()

More (cool) stuff

Requiring a Node.js module

The "underscore.js" library

WebClient! UI

Usage

Settings

On this page

Security and Encryption Functions

This section covers additional security and cryptographic functions available for use in your SyncJS scripts.

Pager

Previous pagePNGMetadata (PNG info)

Next pageGenerate a PGP key-pair