System Requirements
What you need to run SyncriTab: a supported platform, enough memory and disk space, a web browser, and network access to your databases.
SyncriTab runs on one server, and everyone else uses it from a web browser. The requirements below apply to the server, except where a section says otherwise.
At a glance
| Item | Requirement |
|---|---|
| Platform | Windows, Linux, or Docker |
| Memory (RAM) | 4 GB minimum |
| Disk space for the installation | About 500 MB |
| Disk space for data | Depends on how much your users save. See Disk space. |
| Web browser (for users) | A current version of Google Chrome, Microsoft Edge, Mozilla Firefox, or Apple Safari |
| Network | Users can reach the server on port 21786 (and later on 80 and 443, if enabled), and the server can reach your databases |
Supported platforms
You can run SyncriTab in any of these ways:
- Windows: install it with the SyncriTab setup program.
- Linux: install it from the SyncriTab package for 64-bit Linux.
- Docker: build an image from the SyncriTabDocker repository and run it as a container on any host that runs Docker.
The server can be a physical machine or a virtual machine, in your own data center or in the cloud. Choose a server that stays on, because scheduled tasks run on the server even when no one is signed in.
For step-by-step instructions for each platform, see Installing SyncriTab.
Memory
The server needs at least 4 GB of RAM.
Consider more memory if many developers use SyncriTab at the same time, if they often run queries or exports that return very large results, or if the server also runs other applications, such as a database. The Dashboard shows how much memory SyncriTab is using, so you can check whether the server needs more.
Disk space
The installation folder needs about 500 MB. Beyond that, disk usage depends on how much your users save. A small team that mostly runs ad hoc queries uses little space. A large team that saves big result sets and exports files every day can use much more.
SyncriTab stores the following on the server:
| What | How it grows |
|---|---|
| Temporary query results | While a query page is open, its results are kept in a temporary file on the server. A query that returns millions of rows can temporarily use a lot of space. The file is removed when the page is closed, the query is replaced, or the user disconnects. |
| Saved sessions | When auto-save is on, SyncriTab keeps a copy of each user's query pages and results so they can be restored later. By default, it saves up to 10,000 rows or 25 MB per result set, whichever is smaller. |
| Exported files | Files created by the Export wizard and by scheduled export tasks are kept on the server. |
| Saved scripts and workbooks | Usually small. Grows with the number of scripts and workbooks users save. |
| Query history, reports, and schema comparison reports | Grows steadily as users run queries and tools. |
| Log files | Grow with server activity. |
| JDBC drivers | Grows with each driver a manager adds. Most drivers are a few megabytes. |
Put the SyncriTab data on a disk with room to grow, and check the disk usage chart on the Dashboard from time to time. If you run SyncriTab in Docker, store its data on a persistent volume so that it survives when the container is replaced.
Saved sessions, query history, and exported files can contain data from your databases. Include the SyncriTab data folder in your backups, and consider turning on encryption at rest. See Security & Encryption.
Web browsers
Users need only a web browser. Nothing else is installed on their computers. Use a current version of one of these browsers:
- Google Chrome
- Microsoft Edge
- Mozilla Firefox
- Apple Safari
JavaScript and cookies must be enabled for the SyncriTab site. Use a desktop or laptop screen for the query workspace. It has several side-by-side panes and is not designed for phones.
Network access
Connections to the SyncriTab server
Users connect to SyncriTab over HTTP or HTTPS. When SyncriTab first starts, it listens only on port 21786, so you open it at an address such as http://your-server:21786. After setup, an administrator can turn on the standard web ports on the Server Configuration page, so users don't have to type a port number.
| Port | Used for | When |
|---|---|---|
21786 | HTTP (primary port) | Enabled by default, from the first start |
80 | HTTP (secondary port). Also needed from the internet if you use Let's Encrypt with web-based (HTTP-01) validation. | Optional; an administrator turns it on later |
443 | HTTPS | Optional; an administrator turns it on later |
Open port 21786 in the server's firewall before you start setup, and open ports 80 and 443 when you turn them on. If another program on the server already uses one of these ports, choose a different port for SyncriTab.
Connections from the SyncriTab server
The SyncriTab server makes these outgoing connections:
| Destination | Why |
|---|---|
| Your databases | Every query runs from the server, so it must reach each database on its port. Common defaults are 1433 for SQL Server, 1521 for Oracle, 3306 for MySQL and MariaDB, and 5432 for PostgreSQL. Your users' computers don't need to reach the databases. |
| Your email (SMTP) server | Two-factor verification codes, password reset links, alerts, and emailed exports. The default port is 587. |
| Synametrics over the internet (HTTPS) | Registering during Initial Setup, checking for updates, downloading SyncriTab JDBC drivers when they're first used, purchasing licenses, and sending support requests. |
| Let's Encrypt (HTTPS) | Only if you get your SSL certificate from Let's Encrypt. |
If the server has no internet access, you can still register SyncriTab manually and upload updates by hand. See Initial Setup and Updating & Restarting.
Databases
SyncriTab works with any database that has a JDBC driver. For the list of databases and which drivers are included, see Supported databases in the Introduction.