XPACS Installation Guide (Docker)¶
Prerequisites¶
Linux¶
First, update the system's package list with apt update. Docker Engine is often preinstalled on Linux machines; if not, then read https://docs.docker.com/engine/install/. Docker Compose (V2 plugin, the docker compose command) can be installed by following https://docs.docker.com/compose/install/.
Windows¶
- Docker Desktop
- Docker Compose
- WSL2 (Windows 10+, Windows Server 2022)
Installation¶
Create a folder and change the current directory to it. Download and unzip the file XPacs-ndt.zip using the following commands:
wget -O XPacs-ndt.zip https://www.dropbox.com/scl/fi/1sxndkr30tji4i2rh5cyp/XPacs-ndt.zip?rlkey=4yqvp9ra6i7youmuaos8s32wq
unzip XPacs-ndt.zip
Synology NAS does not include unzip, so use the following command:
Open the file .env and edit the settings:
| Setting | Description |
|---|---|
DOCKER_REGISTRY |
Docker Hub namespace prefix for XPACS images (iberisoft/) |
STORAGE_FOLDER |
The absolute folder path where XPACS stores data |
IMPORT_FOLDER |
The absolute folder path where one puts files to be imported by XPACS |
DB_PASSWORD |
Password for the SQL Server sa account used by XPACS containers |
The XPACS repositories are not public, so you must be authenticated by the following command (enter user credentials that are authorized to pull these repositories):
Make the script executable and run it by the following commands (select the install option in the script):
After finishing the script, check that all XPACS-related containers are up and running (prefix can be xpacs, root, etc.):
| Container Name | Description |
|---|---|
prefix_core_* |
XPACS core service |
prefix_web_* |
XPACS web portal |
prefix_api_* |
XPACS web API |
prefix_import_* |
XPACS import service |
prefix_router_* |
XPACS router service |
prefix_db_* |
Microsoft SQL Server |
prefix_logger_* |
Seq log service |
prefix_broker_* |
RabbitMQ message broker |
Getting Updates¶
XPACS repositories might have updates on Docker Hub. If so, run the docker-setup.sh script (select the update option in the script) to pull and apply changes.