{"id":20356037,"url":"https://github.com/project-monai/monai-deploy-storage","last_synced_at":"2025-04-12T02:51:03.702Z","repository":{"id":37056280,"uuid":"476065222","full_name":"Project-MONAI/monai-deploy-storage","owner":"Project-MONAI","description":"Storage layer for MONAI Deploy clinical data pipelines system","archived":false,"fork":false,"pushed_at":"2025-03-24T22:51:59.000Z","size":41263,"stargazers_count":6,"open_issues_count":14,"forks_count":3,"subscribers_count":13,"default_branch":"develop","last_synced_at":"2025-03-24T23:06:40.468Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","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/Project-MONAI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2022-03-30T22:02:57.000Z","updated_at":"2025-03-24T22:32:07.000Z","dependencies_parsed_at":"2024-01-04T19:30:44.311Z","dependency_job_id":"2d8be2a8-0cc7-41f4-bfac-ba6dd8acf643","html_url":"https://github.com/Project-MONAI/monai-deploy-storage","commit_stats":{"total_commits":174,"total_committers":11,"mean_commits":"15.818181818181818","dds":0.6724137931034483,"last_synced_commit":"e7f640e166e1d5fd0e202b49bf47441d00587018"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Project-MONAI%2Fmonai-deploy-storage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Project-MONAI%2Fmonai-deploy-storage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Project-MONAI%2Fmonai-deploy-storage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Project-MONAI%2Fmonai-deploy-storage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Project-MONAI","download_url":"https://codeload.github.com/Project-MONAI/monai-deploy-storage/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248509220,"owners_count":21115965,"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":[],"created_at":"2024-11-14T23:14:49.029Z","updated_at":"2025-04-12T02:51:03.681Z","avatar_url":"https://github.com/Project-MONAI.png","language":"C#","readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/Project-MONAI/MONAI/dev/docs/images/MONAI-logo-color.png\" width=\"50%\" alt='project-monai'\u003e\n\u003c/p\u003e\n\n💡 If you want to know more about MONAI Deploy WG vision, overall structure, and guidelines, please read [MONAI Deploy](https://github.com/Project-MONAI/monai-deploy) first.\n\n# MONAI Deploy Storage\n\n[![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](LICENSE)\n[![codecov](https://codecov.io/gh/Project-MONAI/monai-deploy-storage/branch/master/graph/badge.svg?token=a7lu3x6kEo)](https://codecov.io/gh/Project-MONAI/monai-deploy-storage)\n[![ci](https://github.com/Project-MONAI/monai-deploy-storage/actions/workflows/ci.yml/badge.svg)](https://github.com/Project-MONAI/monai-deploy-storage/actions/workflows/ci.yml)\n[![Nuget](https://img.shields.io/nuget/dt/Monai.Deploy.Storage?label=NuGet%20Download)](https://www.nuget.org/packages/Monai.Deploy.Storage/)\n\nThe MONAI Deploy Storage library for MONAI Deploy clinical data pipelines system enables users to extend the system to external storage services by implementing the [IStorageService API](src/Storage/API/IStorageService.cs), which allows the users to plug in any other storage services, such as [AWS S3](https://aws.amazon.com/pm/serv-s3/) and [Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/).\n\nCurrently supported storage services:\n\n- [MinIO](./src/Plugins//MinIO/)*\n- [Amazon S3](./src/Plugins/AWSS3/)\n\n\\* Services provided may not be free or requires special license agreements. Please refer to the service providers' website for additional terms and conditions.\n\nIf you would like to use a storage service provider not listed above, please file an [issue](https://github.com/Project-MONAI/monai-deploy-storage/issues) and contribute to the repository.\n\n---\n\n## Installation\n\n### 1. Configure the Service\nTo use the MONAI Deploy Storage library, install the [NuGet.Org](https://www.nuget.org/packages/Monai.Deploy.Storage/) package and call the `AddMonaiDeployStorageService(...)` method to register the dependencies:\n\n```csharp\n\nHost.CreateDefaultBuilder(args)\n    .ConfigureServices((hostContext, services) =\u003e\n    {\n        ...\n        services.AddMonaiDeployStorageService(hostContext.Configuration.GetSection(\"InformaticsGateway:storage:serviceAssemblyName\").Value);\n        ...\n    });\n```\n\n### 2. Install the Plug-in\n\n1. Create a subdirectory named `plug-ins` in the directory where your main application is installed.\n2. Download the zipped plug-in of your choice and extract the files to the `plug-ins` directory.\n3. Update `appsettings.json` and set the `serviceAssemblyName`, e.g.:  \n   ```json\n    \"storage\": {\n      \"serviceAssemblyName\": \"Monai.Deploy.Storage.MinIo.MinIoStorageService, Monai.Deploy.Storage.MinIO\"\n    }\n   ```\n\n### 3. Restrict Access to the Plug-ins Directory\n\nTo avoid tampering of the plug-ins, it is recommended to set access rights to the plug-ins directory.\n\n---\n\n## Releases\n\nThe MONAI Deploy Storage library is released in NuGet \u0026 zip formats. NuGet packages are available on both [NuGet.Org](https://www.nuget.org/packages/Monai.Deploy.Storage/) and [GitHub](https://github.com/Project-MONAI/monai-deploy-storage/packages/1350678). Zip files may be found in the build artifacts or the [Releases](https://github.com/Project-MONAI/monai-deploy-storage/releases) section.\n\n### Official Builds\n\nOfficial releases are built and released from the `main` branch.\n\n### RC Builds\n\nRelease candidates are built and released from the `release/*` branches.\n\n### Development Builds\n\nDevelopment builds are made from all branches except the `main` branch and the `release/*` branches. The NuGet packages are released to [GitHub](https://github.com/Project-MONAI/monai-deploy-storage/packages/1350678) only.\n\n## Contributing\n\nFor guidance on contributing to MONAI Deploy Workflow Manager, see the [contributing guidelines](https://github.com/Project-MONAI/monai-deploy/blob/main/CONTRIBUTING.md).\n\n### Writing Your Plug-in\n\nTo extend MONAI Deploy with your custom storage service provider, you must implement the [IStorageService](./src/Storage/API/IStorageService.cs) interface and extend the [ServiceRegistrationBase](./src/Storage/ServiceRegistrationBase.cs) base class.\n\n* The **IStorageService** interface provides a set of methods required to interact with the storage layer.\n* The **ServiceRegistrationBase** base class provides an abstract method _Configure()_ to configure service dependencies based on [.NET Dependency injection](https://docs.microsoft.com/en-us/dotnet/core/extensions/dependency-injection). The derived instance is dynamically activated during runtime based on the *ServiceAssemblyName* value defined in the [StorageServiceConfiguration](./src/Storage/Configuration/StorageServiceConfiguration.cs).\n\n## Community\n\nTo participate, please join the MONAI Deploy Workflow Manager weekly meetings on the [calendar](https://calendar.google.com/calendar/u/0/embed?src=c_954820qfk2pdbge9ofnj5pnt0g@group.calendar.google.com\u0026ctz=America/New_York) and review the [meeting notes](https://docs.google.com/document/d/1ipCGxlq0Pd7Xnil2zGa1va99K7VbdhwcJiqel9aWzyA/edit?usp=sharing).\n\nJoin the conversation on Twitter [@ProjectMONAI](https://twitter.com/ProjectMONAI) or join our [Slack channel](https://forms.gle/QTxJq3hFictp31UM9).\n\nAsk and answer questions over on [MONAI Deploy Storage's GitHub Discussions tab](https://github.com/Project-MONAI/monai-deploy-storage/discussions).\n\n## License\n\nCopyright (c) MONAI Consortium. All rights reserved.\nLicensed under the [Apache-2.0](LICENSE) license.\n\nThis software uses the Microsoft .NET 6.0 library, and the use of this software is subject to the [Microsoft software license terms](https://dotnet.microsoft.com/en-us/dotnet_library_license.htm).\n\nBy downloading this software, you agree to the license terms \u0026 all licenses listed on the [third-party licenses](third-party-licenses.md) page.\n\n## Links\n\n- Website: \u003chttps://monai.io\u003e\n- Code: \u003chttps://github.com/Project-MONAI/monai-deploy-storage\u003e\n- Project tracker: \u003chttps://github.com/Project-MONAI/monai-deploy-storage/projects\u003e\n- Issue tracker: \u003chttps://github.com/Project-MONAI/monai-deploy-storage/issues\u003e\n- Test status: \u003chttps://github.com/Project-MONAI/monai-deploy-storage/actions\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproject-monai%2Fmonai-deploy-storage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fproject-monai%2Fmonai-deploy-storage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproject-monai%2Fmonai-deploy-storage/lists"}