-implemented some http caching hints

-some documentation

Author: aczwink

README.md

@@ -2,3 +2,13 @@
 [![Build docker images](https://github.com/aczwink/OpenDistributedFileStorage/actions/workflows/docker-image.yml/badge.svg)](https://github.com/aczwink/OpenDistributedFileStorage/actions/workflows/docker-image.yml)
 
 A web-based file storage service with distributed storage targets
+
+## Documentation
+
+### Concepts
+* A blob is an immutable sequence of bytes defined by its sha256 hash.
+* A blob is partitioned into multiple blocks.
+* A blob block is also an immutable sequence of bytes defined by its sha256 hash.
+* A blob block is stored within one storage block.
+
+TODO: documentation about storage blocks

service/src/api/files.ts

@@ -1,6 +1,6 @@
 /**
  * OpenDistributedFileStorage
- * Copyright (C) 2024 Amir Czwink ([email protected])
+ * Copyright (C) 2024-2025 Amir Czwink ([email protected])
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
@@ -279,6 +279,7 @@ class _api_
         const result = await this.fileDownloadService.DownloadBlob(blobId, accessToken.sub);
         return Ok(result.stream, {
             "Content-Length": result.size,
+            "Cache-Control": "max-age=31536000, immutable"
         });
     }
 

service/src/api/stream.ts

@@ -1,6 +1,6 @@
 /**
  * OpenDistributedFileStorage
- * Copyright (C) 2024 Amir Czwink ([email protected])
+ * Copyright (C) 2024-2025 Amir Czwink ([email protected])
  * 
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
@@ -46,6 +46,7 @@ class _api_
         {
             const result = await this.fileDownloadService.DownloadBlob(blobId, userId);
             return Ok(result.stream, {
+                "Cache-Control": "max-age=31536000, immutable",
                 "Content-Length": result.size,
             });
         }
@@ -58,6 +59,7 @@ class _api_
         const slice = await this.fileDownloadService.DownloadBlobSlice(blobId, parsed.start, parsed.length);
         return PartialContent(slice, {
             "Accept-Ranges": "bytes",
+            "Cache-Control": "max-age=31536000, immutable",
             "Content-Range": `bytes ${parsed.start}-${parsed.end}/${totalSize}`,
             "Content-Length": slice.byteLength,
             "Content-Type": {