SoulTrade Software -- Easy Install (Docker) =========================================== Applies to: CrystalSolutions, PraxisClinic, SoleTrader REQUIREMENTS ------------ - Docker Desktop (free download from https://www.docker.com/products/docker-desktop) - Mac, Windows PC, Linux, NAS (Synology etc.) or VPS - 4GB RAM recommended FIRST TIME SETUP ---------------- 1. Install Docker Desktop from https://www.docker.com/products/docker-desktop 2. Start Docker Desktop and wait for it to show "Running" in the menu bar / system tray 3. Download the installer for your product and platform from: https://soul-trade.com/easy_download.html INSTALLING -- MAC ----------------- 1. Download the .app installer for your product 2. Double-click the installer 3. When asked "[product] Installer would like to access your [folder]" -- click Allow 4. Choose where to install when prompted (e.g. Documents) 5. Your browser opens automatically when ready INSTALLING -- WINDOWS --------------------- WINDOWS REQUIREMENTS: - Windows 10 version 2004 (Build 19041) or later, or Windows 11 - 64-bit processor with virtualisation enabled in BIOS - 4GB RAM minimum (8GB recommended) - WSL 2 -- Docker Desktop installs this automatically on most systems Windows IoT / LTSC editions may need WSL 2 enabled manually first. Open PowerShell as administrator and run: wsl --install Then restart before installing Docker Desktop. 1. Install Docker Desktop -- run the installer as Administrator (right-click the Docker Desktop installer -> Run as administrator) 2. Start Docker Desktop and wait until it shows "Running" in the system tray 3. Download the Docker zip for your product 4. Unzip to anywhere on your computer (e.g. Documents) 5. Right-click "Install [product].bat" and choose "Run as administrator" (if nothing happens when double-clicking, this is why) 6. Allow any PowerShell or firewall prompts 7. A window will appear showing installation progress -- leave it open 8. Your browser opens automatically when ready Note: If the installer window disappears immediately, right-click "Install [product].bat" and choose "Run as administrator". INSTALLING -- NAS (Synology etc.) ---------------------------------- The Synology Container Manager approach is relatively straightforward once Docker is enabled on your NAS. 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 your browser: http://[NAS-IP]:8080/cspractice (CrystalSolutions) http://[NAS-IP]:8081/soletrader (SoleTrader) http://[NAS-IP]:8082/praxis (PraxisClinic) STARTING AND STOPPING ON NAS After setup, use Container Manager in your Synology browser interface to start and stop the software -- just click the Start/Stop button. No command line needed after initial setup. Note: The start.command and start.bat scripts are Mac/Windows only and are not needed on a NAS. NOT COMFORTABLE WITH SSH OR COMMAND LINE? Ask your IT person to do the initial setup, or use the Mac or Windows installer instead. INSTALLING -- LINUX / VPS / RASPBERRY PI ----------------------------------------- 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 FIRST LOGIN ----------- Username: admin Password: changeme Change your password immediately: Setup -> Password BROWSER ADDRESSES ----------------- CrystalSolutions: http://localhost:8080/cspractice PraxisClinic: http://localhost:8082/praxis SoleTrader: http://localhost:8081/soletrader (Replace localhost with your server/NAS IP for network access) 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 NAS/Linux: docker compose up -d STOPPING -------- Use the Stop button in Docker Desktop, or double-click stop.command (Mac). NAS/Linux: docker compose down Quitting Docker Desktop also stops the software. YOUR DATA --------- Your data is stored in a Docker volume inside Docker Desktop -- NOT in the install folder. This means: - You can move the install folder anywhere without losing your data - Deleting the install folder does NOT delete your data - To back up your data, use Setup -> Backup inside the software (this exports your database to a file you can keep safely) - To fully remove the software AND data, use Docker Desktop to delete the container and volume for your product Back up regularly using Setup -> Backup. DOCKER DESKTOP DASHBOARD ------------------------ Open Docker Desktop to see your containers listed by product name (e.g. CrystalSolutions, SoleTrader). Start and Stop buttons are there for convenience alongside the start/stop scripts. UPDATING -------- Easiest method (Mac & Windows): Open Docker Desktop, click the dustbin next to each container for your product to remove them. Then double-click the Installer.app (Mac) or run "docker compose up -d" from the install folder (Windows) to reinstall. Your data is preserved unless you also delete the volume. To update files only (without reinstalling): Replace files directly in the app/ subfolder of your install folder. Changes take effect immediately -- no Docker restart needed. Mac .app users -- to find your install files: Right-click the .app -> Show Package Contents -> Contents/Resources/ [product]/ -> app/ to replace files. SUPPORT ------- jol@soul-trade.com https://soul-trade.com Full installation guide: https://soul-trade.com/install_guide.html Easy Install information: https://soul-trade.com/easy-install.html SoulTrade Software Terms & Conditions: https://soul-trade.com/terms.html Privacy Policy: https://soul-trade.com/mtd-privacy.html