SoulTrade Software

Installation Guide

Not very technical?

Use the Easy Install (Docker) tab -- a double-click installer that sets everything up automatically. No databases, no server configuration.

Easy Install information →

Easy Install -- Docker version

The Easy Install version uses Docker to set up everything automatically. No technical knowledge required.

Applies to: CrystalSolutions Easy Install, PraxisClinic Easy Install, SoleTrader Easy Install

Step 1 -- Install Docker Desktop

Download and install Docker Desktop from docker.com/products/docker-desktop -- it's free. Start it and wait until it shows Running in your menu bar / system tray.

Docker Desktop requires approximately 4GB of RAM. It runs quietly in the background and can be set to start automatically with your computer.

Step 2 -- Run the installer

Double-click the installer .app (Mac). When macOS asks "would like to access your [folder name]" -- click Allow. This just lets the installer put the software in the folder you choose.

Choose your install location when prompted -- Downloads, Documents, or anywhere you like. The installer handles everything else automatically.

That's it! The installer sets up the database, configures everything and opens your browser automatically.

Step 3 -- Log in

Default login: username admin password changeme. Change your password immediately in Setup → Password.

Managing via Docker Desktop

After installation, open Docker Desktop and you'll see your software listed with Start and Stop buttons. You can start and stop from there at any time.

Starting after first install

Mac

Double-click start.command in your install folder, or use the Start button in Docker Desktop.

Windows

Double-click start.bat in your install folder, or use the Start button in Docker Desktop.

Stopping the software

Use the Stop button in Docker Desktop, double-click stop.command (Mac), or simply quit Docker Desktop.

Full Easy Install README

The complete README covering Mac, Windows, login details, data storage and updating is available at: easy_install_readme.txt

NAS / Linux (Synology, Raspberry Pi etc.)

The Docker zip works directly on any Linux-based NAS or server. No Mac or Windows installer needed.

Synology NAS (Container Manager)

  1. Install Container Manager from Synology Package Centre
  2. Copy and unzip the Docker zip to your NAS (e.g. via File Station)
  3. In Container Manager go to Project → Create
  4. Point it at the docker-compose.yml in the unzipped folder
  5. Start the project -- database sets up automatically
  6. Access from any device on your network via http://[NAS-IP]:8080/cspractice

Linux VPS or Raspberry Pi (SSH)

  1. Copy and unzip the Docker zip to your server
  2. Install Docker: curl -fsSL https://get.docker.com | sh
  3. Run: docker compose up -d from the install folder
  4. Access via http://[server-IP]:8080/cspractice
  5. For internet access add HTTPS via Let's Encrypt / Nginx reverse proxy
The start.command and start.bat scripts are Mac/Windows only. On Linux just use docker compose up -d and docker compose down.

Your data

All your data is stored in a Docker volume on your computer and persists between restarts. Back up regularly using Setup → Backup.

Updating

Stop the software, replace the files in the app/ folder with the new version, restart. Your data is preserved.

Standard Self-Install

The standard version requires a PHP/MySQL server. The most common setup on a Mac or PC is MAMP.

Applies to: CrystalSolutions, PraxisClinic, SoleTrader (standard zip versions)

Full product-specific installation guides:

CrystalSolutions → PraxisClinic → SoleTrader →

Requirements

Using MAMP (recommended for Mac/PC)

Mac & Windows

  1. Download and install MAMP (free version is fine)
  2. Start MAMP and click Start Servers
  3. Open phpMyAdmin from the MAMP start page
  4. Create a new database (e.g. crystalsolutions)
  5. Unzip the software into MAMP's htdocs folder:
    Mac: /Applications/MAMP/htdocs/cspractice
    Windows: C:\MAMP\htdocs\cspractice
  6. Edit config.php -- set DB_HOST, DB_NAME, DB_USER, DB_PASS
  7. In phpMyAdmin, run all SQL files from the sql/ folder in order
  8. Visit http://localhost:8888/cspractice

On a web server (Fasthosts, SiteGround etc.)

  1. Create a MySQL database in your hosting control panel
  2. Upload the software files via FTP to a subfolder (e.g. public_html/cspractice)
  3. Edit config.php with your database credentials
  4. Run the SQL files via phpMyAdmin in your hosting panel
  5. Visit your URL (e.g. https://yourdomain.com/cspractice)
Keep your installation in a private subfolder or protect it with .htaccess. This software is designed for intranet/private use, not as a public website.

Folder names

These match the BASE_URL already set in config.php. If you use a different folder name, update BASE_URL to match.

First Run & Licence

First login

Username: admin   Password: admin

Change your password immediately in Setup → Password.

Trial mode

Without a licence the software runs in trial mode -- up to 10 patients/clients. All features are available in trial mode.

Entering your licence key

  1. Go to Setup → Licence
  2. Enter your licence key (format: XXXX-XXXX-XXXX-XXXX-XXX)
  3. Click Activate
  4. Unlimited records are unlocked immediately
Your licence key was emailed to you after purchase. Check your spam folder if you can't find it. Contact jol@soul-trade.com if you need it resent.

Initial setup

  1. Setup → Practice -- enter your practice name and details
  2. Setup → Users -- add any additional users
  3. Setup → Value Lists -- customise treatment types and other lists
  4. Setup → Backup -- configure regular backups

MTD (Making Tax Digital)

The MTD module for direct HMRC quarterly submissions is built in. Go to Setup → MTD / HMRC to connect your HMRC account. You'll need your own HMRC developer credentials -- see the in-software help for full instructions.

Frequently Asked Questions

Can I run this on a shared practice computer?

Yes -- the software is designed for intranet use. Multiple users can connect from different computers on the same network by pointing their browsers at the server's IP address.

Is my data safe?

All data is stored on your own computer or server -- it never leaves your machine. There is no cloud storage or third-party access. Back up regularly using Setup → Backup.

Can I move to a different computer?

Yes -- use Setup → Backup to create a backup, install on the new machine, then restore the backup. For Docker, simply copy the entire folder to the new machine.

The software shows a blank page or error

Check that your web server (MAMP or Docker) is running. Check that the database credentials in config.php are correct. Check that all SQL files were run in order.

I've forgotten my admin password

Update the password directly in the database via phpMyAdmin -- find your user in the users table and update the password field with a new SHA-256 hash. Or email jol@soul-trade.com for help.

Can I use this on a Mac and Windows at the same time?

Yes -- install on one machine as the server, then access from other machines on the same network via the server's IP address in a browser.

Full installation guides

CrystalSolutions install guide
PraxisClinic install guide
SoleTrader install guide
Easy install guides

Support

Email: jol@soul-trade.com
Forum: soul-trade.com/CSForum/