{"id":13812482,"url":"https://github.com/dcmjs-org/dicomweb-server","last_synced_at":"2025-05-14T22:30:47.702Z","repository":{"id":35529172,"uuid":"167460684","full_name":"dcmjs-org/dicomweb-server","owner":"dcmjs-org","description":"Lightweight DICOMweb Server with CouchDB","archived":false,"fork":false,"pushed_at":"2024-06-03T21:19:36.000Z","size":6760,"stargazers_count":100,"open_issues_count":18,"forks_count":28,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-11-19T07:38:51.884Z","etag":null,"topics":["couchdb","dicom","dicomweb","dicomweb-client","dicomweb-server-js","javascript","lightweight-dicomweb-server","nci-itcr","nci-qin"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dcmjs-org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-25T00:48:33.000Z","updated_at":"2024-10-25T12:23:55.000Z","dependencies_parsed_at":"2023-11-22T22:30:56.863Z","dependency_job_id":"35c8ae3c-9aae-48f2-af09-9664749420fd","html_url":"https://github.com/dcmjs-org/dicomweb-server","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcmjs-org%2Fdicomweb-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcmjs-org%2Fdicomweb-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcmjs-org%2Fdicomweb-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dcmjs-org%2Fdicomweb-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dcmjs-org","download_url":"https://codeload.github.com/dcmjs-org/dicomweb-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254239452,"owners_count":22037713,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["couchdb","dicom","dicomweb","dicomweb-client","dicomweb-server-js","javascript","lightweight-dicomweb-server","nci-itcr","nci-qin"],"created_at":"2024-08-04T04:00:52.406Z","updated_at":"2025-05-14T22:30:43.706Z","avatar_url":"https://github.com/dcmjs-org.png","language":"JavaScript","funding_links":[],"categories":["Libraries"],"sub_categories":["JavaScript"],"readme":"# dicomweb-server\nLightweight DICOMweb Server with CouchDB\n\n*Note: this is a work in progress and not intended for production or clinical use.*\n\nMore background information can found in https://na-mic.github.io/ProjectWeek/PW30_2019_GranCanaria/Projects/DICOMweb-CouchDB/\n\n## Architecture\n\nThe dicomweb-server is a fastify server that speaks DICOMweb to clients and fullfills their requests using CouchDB or other plugin services.\n![Overall design](image.png)\n\n## Authentification\n\nBy default, the authentication is none and the application mode is development.\nYou can change the authentication method by changing the auth attribute in config/development.js\nThe value you put in should be the name of a json file in the config directory. A sample config for authentication should have the following information\n\n\n`{\n    \"realm\": \"your-realm\",\n    \"authServerUrl\": \"your-auth-server-port-and-port\",\n    \"clientId\": \"your-client-id\",\n    \"clientSecret\": \"your-secret\"\n}`\n\nIf using the default authentication of couchdb with an admin account, you will need to specify the admin username and password in config/development.js in the below style:\n\n`{\n    dbServer: process.env.DB_SERVER || 'http://username:password@localhost'\n}`\n\n\n\n## Installation\n\n```\ngit clone git://github.com/dcmjs-org/dicomweb-server\n\ncd dicomweb-server\nnpm install\n```\n\nInstall [CouchDB](http://couchdb.apache.org/).\n\nInitially your CouchDB database starts empty, but dicomweb-server will set up the internal database\nand design documents so there is no need to configure it.\n\nYou can run tests by running `npm test`.\n\n## Running\n\nBe sure to have [CouchDB](http://couchdb.apache.org/) running at localhost:5984 (the default), then start the dicomweb-server:\n\n```\nnpm start\n```\n\n## Usage\n\nThe server should be ultimately compatible with any DICOMweb client library.\n\nWe test with a Python implementation [dicomweb_client](https://github.com/clindatsci/dicomweb-client).\n\nGet study list:\n\n`dicomweb_client --url http://localhost:5985 search studies`\n\nStore a DATA_DIRECTORY of DICOM image files (here with the \".IMA\" extension).  Adjust the command line to match the location and naming of your files.  (The `-n25` option to xargs is for batching files, leading to fewer calls and thus less overhead.)\n\n`find DATA_DIRECTORY -iname \\*.IMA -print0 | xargs -0 -n25 dicomweb_client --url http://localhost:5985 store instances`\n\n\n## Use with a viewer\n\nIt's possible to use this server as a backend to the [OHIF Viewer](http://ohif.org) using a configuration like this. (See [this file](https://github.com/OHIF/Viewers/blob/master/platform/viewer/public/config/default.js#L1-L31)).\n\n```\n     const dicomweb_serverConfig = {\n        routerBasename: \"/ohif\",\n        rootUrl: \"http://localhost:2016/ohif\",\n        servers: {\n          \"dicomWeb\": [\n            {\n              \"name\": \"dicomweb_server\",\n              \"wadoUriRoot\": \"http://localhost:5985\",\n              \"qidoRoot\": \"http://localhost:5985\",\n              \"wadoRoot\": \"http://localhost:5985\",\n              \"qidoSupportsIncludeField\": true,\n              \"imageRendering\": \"wadouri\",\n              \"thumbnailRendering\": \"wadors\",\n              \"requestOptions\": {\n                  \"requestFromBrowser\": true\n              }\n            },\n          ]\n        }\n      };\n```\n\nNote that currently the `imageRendering` option must be `wadouri`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdcmjs-org%2Fdicomweb-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdcmjs-org%2Fdicomweb-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdcmjs-org%2Fdicomweb-server/lists"}