Skip to content

Commit c86b6f9

Browse files
committed
update readme
1 parent 81bc01a commit c86b6f9

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,16 +59,19 @@ We welcome contributions! Please:
5959

6060
**Sereni Storage Provider** is an open-source, enterprise-grade storage platform that provides S3-compatible storage, MinIO support, and local file system integration. Built for scalability and flexibility, it enables developers to manage and store data securely across cloud-native and on-premise infrastructures. With API compatibility, robust access control mechanisms, and a scalable backend architecture, Sereni simplifies storage management for modern, distributed applications.
6161

62-
## Key Features
62+
**MinIO vs Amazon S3:** MinIO is an S3-compatible open-source object store — the same client code works against both. In production, point S3_ENDPOINT at your Amazon S3 region endpoint. In development, MinIO runs locally via Docker as a drop-in replacement with no code changes.
6363

6464
- **S3-Compatible APIs**: Full compatibility with Amazon S3 client libraries and tools
6565
- **Advanced Access Control**: Role-based permissions with fine-grained access policies
6666
- **Multi-Tenant Architecture**: Isolated storage contexts for different organizations
67-
- **High Performance**: Optimized for large file uploads with resumable transfers
67+
- **High Performance**: Optimized for large file uploads with high throughput
6868
- **Data Security**: Encryption at rest and in transit with comprehensive audit logging
6969
- **Storage Microservice**: Complete object storage API with file upload service capabilities
7070
- **Cloud-Native Design**: Kubernetes deployment with auto-scaling capabilities
7171

72+
### Antivirus Integration
73+
When used with [sereni-antivirus-clamav](https://github.com/aptlogica/sereni-antivirus-clamav), all file uploads are scanned for malware before being committed to storage. The scanning step is handled by the sereni-base orchestration layer — neither service calls the other directly. Configure `ANTIVIRUS_SERVICE_URL` in sereni-base to enable this behaviour.
74+
7275
## Architecture
7376
- Go 1.26.2+, idiomatic design
7477
- Modular, testable codebase
@@ -186,5 +189,13 @@ S3_ENDPOINT=http://localhost:9000
186189
## Security
187190
See [SECURITY.md](SECURITY.md) for reporting vulnerabilities.
188191

192+
## SereniBase Ecosystem
193+
194+
Sereni Storage Provider is part of the [SereniBase](https://github.com/aptlogica/sereni-base) ecosystem, a collection of microservices designed to build robust, scalable applications.
195+
196+
- [sereni-base](https://github.com/aptlogica/sereni-base) - Core orchestration layer
197+
- [sereni-antivirus-clamav](https://github.com/aptlogica/sereni-antivirus-clamav) - Antivirus scanning service
198+
- [sereni-auth-provider](https://github.com/aptlogica/sereni-auth-provider) - Authentication and authorization service
199+
189200
## License
190201
Apache License 2.0. Copyright (c) 2026 Aptlogica Technologies.

0 commit comments

Comments
 (0)