What you need to run it

CrystalSolutions, SoleTrader and PraxisClinic run on a computer or server you control, so your records stay with you. There are two ways to install them. This page lists what each one needs, so you can check before you download.

On this page

Which way should I install?
Easy Install (Docker): what you need
Standard install: what you need
Platform by platform
For everyone

1. Which way should I install?

	Easy Install (Docker)	Standard install
Best for	Most people. A Mac, a Windows PC, or a NAS you can run Docker on.	Shared web hosting, a server you already run, a Raspberry Pi, or if you prefer to set things up yourself.
What it does	Installs the software, the database and the web server together, already set up.	You supply a web server, PHP and a database, then run our installer.
Technical skill	Low. Download, double-click, wait.	Moderate. Our guides walk through each platform.
You install	Docker Desktop (free), then our installer.	Apache, PHP, MySQL or MariaDB, or use XAMPP or MAMP.

Not sure? Choose Easy Install. Our Easy Install page has more detail, and you can download from the download page,

but do avail yourselves of the trial Live demos that don't need any installation (open in your browser) so you can see what the software can do SoleTrader and CrystalSolutions and PraxisClinic

2. Easy Install (Docker): what you need

For every computer

Docker Desktop, which is free from docker.com. You don't need a Docker account, so skip the sign-in screen.
Enough memory (RAM): 8GB or more is recommended, and 16GB is better if you also run other programs. Docker's own minimum is 8GB on Windows and 4GB on a Mac.
An internet connection for the first install, because Docker downloads PHP and MySQL.
Some free disk space for Docker and your records. A few gigabytes is plenty to start with.
Docker Desktop is free for personal use, education and small businesses (fewer than 250 employees and under $10 million a year in revenue). Larger organisations need a paid Docker subscription. See Docker's terms.
Nothing else. The Easy Install includes PHP 8.3 and MySQL 8.4, already set up.

Windows

Windows 11 (version 23H2 or later) or Windows 10 (version 22H2). Windows 10 no longer receives free updates from Microsoft, so Windows 11 is the better choice.
8GB of memory (RAM) at least.
A 64-bit processor with virtualisation switched on in the BIOS / UEFI. Most computers from the last eight years have it, and it is usually on. To check, open Task Manager, choose Performance, then CPU, and look for "Virtualization: Enabled".
WSL 2, which Docker Desktop normally installs for you.
The Windows edition: see Docker's current requirements to check that your edition (Home or Pro) is supported.
You will need administrator rights to install Docker Desktop and to run our installer. If double-clicking Install [product].bat does nothing, right-click it and choose Run as administrator.

Mac

An Apple chip (M1 or later) or an Intel Mac. Download the matching version of Docker Desktop.
A supported version of macOS: the current major release or one of the two before it. Docker drops the oldest as each new macOS comes out, so an old Mac that can't update may be left behind. See Docker's Mac requirements.
4GB of memory (RAM) at least, though more is better. Docker also recommends installing Rosetta 2 on Apple chip Macs. It is no longer strictly required.
Your Mac will warn you the first time you open our installer. It's normal and easy to get past. The Installing on a Mac page shows each step with screenshots.

Linux, VPS or server

A 64-bit Linux server with Docker Engine and the Docker Compose plugin. See Docker's install instructions.
For access over the internet, add HTTPS in front (for example with Let's Encrypt and Nginx). Don't expose the software without it.

Synology and other NAS

A Synology NAS running DSM with Container Manager, which you download and install from Package Center. If you can find it there, your NAS can run the Easy Install. If you can't, use the Standard install.
2GB of memory or more on the NAS is recommended, and more is better if it also does other jobs.
Other NAS brands work if they can run Docker Compose projects. We have only tested Synology.

Raspberry Pi

The Standard install is the tested route for a Raspberry Pi (see below). Docker on a Pi is not something we've tested.

3. Standard install: what you need

You need a web server with PHP and a database. This is the same list whatever the platform.

Component	Minimum	Recommended
PHP	8.0	8.2 or 8.3
Database	MySQL 8.0 or MariaDB 10.4	MySQL 8.4 or MariaDB 10.6
Web server	Apache 2.4, with `.htaccess` files allowed	Apache 2.4
PHP extensions	`pdo_mysql`, `mysqli`, `gd`	Same. `mbstring` and `fileinfo` are normally built in.
Disk space	500MB for the software and database	2GB or more for attachments and images
HTTPS (SSL certificate)	Needed for any use over the internet	Let's Encrypt (free)

.htaccess files. The software includes .htaccess files that stop anyone opening private files, such as your settings, by typing their address. Your Apache must allow them (AllowOverride All). Most hosts and XAMPP and MAMP do. Some Linux setups don't by default, so check with the test in the install guide. Nginx and Caddy ignore .htaccess, so they need their own rules.

4. Platform by platform

Platform	What you need	Notes
Shared web hosting	PHP 8.0 or newer and MySQL 8.0 or newer (or MariaDB 10.4), with cPanel, Plesk or similar	Ask your host if you are unsure. Use the full database host name from your hosting panel, not `localhost`.
Windows PC (XAMPP)	XAMPP with a PHP 8.x version, and a PC that stays on while you work	Good for trying it out or a single-room practice. XAMPP is free.
Mac (MAMP or Homebrew)	MAMP (free version) for testing, or Homebrew with PHP, MySQL and a web server for a permanent setup	The Easy Install is simpler on a Mac if you just want it running.
Synology or QNAP NAS	DSM 7.x (2018 or later) with Web Station, PHP 8.2 and MariaDB 10, or the equivalent on QNAP	At least 1GB of memory, 2GB recommended. Enable TCP/IP in MariaDB.
Raspberry Pi	Raspberry Pi 4 with 2GB of memory or more, running Raspberry Pi OS (64-bit) with Apache, PHP 8.2 and MariaDB	Silent and uses very little power. Use a good SD card or an SSD.
Linux or VPS	Apache, PHP 8.x and MySQL or MariaDB from your distribution	Check that `.htaccess` is allowed, as above.

Step-by-step instructions for each platform are in the install guide that comes with your download. Open the installation guide. For the Easy Install (Docker), the Easy Install README text has the latest instructions for starting, stopping, backing up and updating.

5. For everyone

Using it afterwards. Once it's installed, you use it in an ordinary web browser, on the same computer or from other devices on your network. No extra software is needed on those devices.
Always on. If you want to use it from other devices, the computer that runs it has to be switched on, and it needs a fixed address on your network.
Backups. Your records live on your own hardware, so backups are your responsibility. Use Setup, then Backup, regularly, and keep a copy somewhere else.
Real client or patient records. Before you use it for real records, read the data protection section of the install guide. It covers HTTPS, encryption and your obligations under UK GDPR.
Free trial. You can install and try it with up to 10 records before buying a licence.

Not sure your computer will work? Email jol@soul-trade.com with what you have (Windows or Mac, how much memory, and so on) and we'll tell you.