|
1 | 1 | # Common Object Management Service
|
2 | 2 |
|
3 |
| -A microservice for managing access control to S3 Objects |
| 3 | +A microservice for managing access control to files in S3-compatible Object Storage |
4 | 4 |
|
5 |
| -## Wiki Contents |
| 5 | +Take advantage of more cost-effective storage solutions for your new or existing business applications. Common Object Management Service (COMS) is a secure REST API that lets you connect your application to an S3 bucket. In S3, you can store and share files, images, and documents with co-workers, partners, or the public. |
6 | 6 |
|
7 |
| -**API User Guide:** |
| 7 | +## Onboarding Options |
8 | 8 |
|
9 |
| -- [Authentication](Authentication.md) |
10 |
| -- [Endpoint Notes](Endpoint-Notes.md) |
11 |
| -- [Permissions](Permissions.md) |
12 |
| -- [Metadata and Tags](Metadata-Tag.md) |
13 |
| -- [Managing buckets](Buckets.md) |
14 |
| -- [Synchronization](Synchronization.md) |
15 |
| -- [Use-Case Examples](Use-Case-Examples.md) |
| 9 | +COMS is now available as a shared hosted service as well as an application that you can customise and deploy in your own infrastructure. See documentation on [Hosting Considerations](Hosting-Considerations.md). |
16 | 10 |
|
17 |
| -**Deployment Guide:**<br /> |
18 |
| -Install COMS in your own environment for extra features |
| 11 | +We have also launched [BCBox](https://bcbox.nrs.gov.bc.ca), a DropBox-like user-interface for managing files, integrated with the hosted COMS service. |
19 | 12 |
|
20 |
| -- [Self-Hosting COMS](Self-Hosting-COMS.md) |
21 |
| -- [Architecture](Architecture.md) |
22 |
| - - [Database](Architecture.md#database-structure) |
23 |
| - - [Code Design](Architecture.md#code-design) |
24 |
| -- [Configuration Options](Configuration.md) |
25 |
| -- [Testing](Testing.md) |
| 13 | +## Feature List |
26 | 14 |
|
27 |
| -**The Hosted Service:**<br /> |
28 |
| -Find out if the BC Gov Hosted COMS service will work for you? |
| 15 | +- Upload, download, manage and delete files |
| 16 | +- Manage file versions and soft-deletes |
| 17 | +- Enable general public access to files |
| 18 | +- Grant permissions on buckets and files to authenticated users (eg IDIR or BCeID) |
| 19 | +- Share and invite users to work with your files |
| 20 | +- Manage metadata and tags on objects |
| 21 | +- Flexible search and filter capabilities based on objects attributes and user permissions |
| 22 | +- Sync COMS with files that already exist in your bucket |
29 | 23 |
|
30 |
| -- [Hosted Service Onboarding](Hosted-Service-Onboarding.md) |
31 |
| -- [Hosting Considerations](Hosting-Considerations.md) |
32 |
| -- [Hosted Service Architecture](Architecture-Hosted.md) |
| 24 | +## Product Reference |
33 | 25 |
|
| 26 | +Please follow the links in the side menu to learn more about COMS. |
34 | 27 |
|
35 |
| -<br /> |
| 28 | +- Hosted COMS service URL: [https://coms.api.gov.bc.ca](https://coms.api.gov.bc.ca) |
| 29 | +- GitHub Repository: [https://github.com/bcgov/common-object-management-service/](https://github.com/bcgov/common-object-management-service/) |
| 30 | +- API Specification: [https://coms.api.gov.bc.ca/api/v1/docs](https://coms.api.gov.bc.ca/api/v1/docs) |
| 31 | +- UI Integration: [BCBox](https://bcbox.nrs.gov.bc.ca) |
36 | 32 |
|
37 | 33 | **[Product Roadmap](Product-Roadmap.md)**
|
38 | 34 |
|
|
0 commit comments