Docs
Documentation
The guides live next to the code on GitHub, so they always match the version you run.
- DeploymentPrerequisites, PUBLIC_URL, Docker Compose and Google Cloud.
- Configuration guideServers, runtime server selection, annotation colors, read-only mode and the worklist.
- Mixed content and HTTPSServing Slim over HTTPS next to plain-HTTP archives.
- AuthenticationOpenID Connect sign-in with the authorization code or implicit flow.
- DICOM conformance statementSupported SOP classes, transfer syntaxes and DICOMweb transactions.
- DevelopmentLocal setup, scripts, and linking a local dicom-microscopy-viewer.
- ContributingCoding style, pull requests and the release workflow.
- WikiA mirror of the configuration guide and further notes.
Quick start
Run Slim in a few minutes
Runs Slim behind NGINX together with a dcm4chee-arc-light archive. The app is served at http://localhost:8008 and DICOMweb at /dcm4chee-arc/aets/DCM4CHEE/rs.
git clone https://github.com/ImagingDataCommons/slim.git
cd slim
docker-compose up -dThen store slides in the archive with STOW-RS, for example:
pip install dicomweb-client
dicomweb_client --url http://localhost:8008/dcm4chee-arc/aets/DCM4CHEE/rs \
store instances /path/to/slide/*.dcmSlim builds to plain static files, so any web server or bucket can host it. Download the source of a release, then build with Node.js 24 and pnpm:
pnpm install
REACT_APP_CONFIG=local PUBLIC_URL=/ pnpm run build
# serve the build/ folder at PUBLIC_URLPUBLIC_URL is where the viewer will live, either a path such as /slim or a full URL.
Each deployment has a configuration file in public/config/, picked at build time with REACT_APP_CONFIG. It sets the DICOMweb servers, sign-in, annotation presets and which panels are shown.
window.config = {
path: '/',
servers: [
{
id: 'orthanc',
url: 'http://localhost:8042/dicom-web',
write: true,
},
],
enableServerSelection: true,
}Start the Vite development server on http://localhost:3000. It talks to the Docker Compose archive by default.
pnpm install
pnpm run start