Skip to content

Commit 1f216b5

Browse files
committed
Documentation update for local storage
Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
1 parent cacb538 commit 1f216b5

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# KernelCI Storage Server
22

33
This is a simple storage server that supports file upload and download, with token based authentication.
4-
It supports multiple backends, currently only Azure Blob is supported, to provide user transparent storage.
4+
It supports multiple backends: Azure Blob Storage and local filesystem, to provide user transparent storage.
55
It caches the files in a local directory and serves them from there.
66
Range requests are supported, but only for start offset, end limit is not implemented yet.
77
Files are protected by upload locking to prevent concurrent uploads to the same path.
@@ -10,7 +10,10 @@ Files are protected by upload locking to prevent concurrent uploads to the same
1010

1111
The server is configured using toml configuration file, the default configuration file is `config.toml`.
1212

13+
### Azure Backend Configuration
14+
1315
```toml
16+
driver="azure" # Optional, defaults to "azure"
1417
jwt_secret="JWT_SECRET"
1518
[azure]
1619
account=""
@@ -24,6 +27,20 @@ name = "user@email.com"
2427
prefixes = ["/allowed/path"]
2528
```
2629

30+
### Local Filesystem Backend Configuration
31+
32+
```toml
33+
driver="local"
34+
jwt_secret="JWT_SECRET"
35+
[local]
36+
storage_path="./storage" # Optional, defaults to "./storage"
37+
38+
# User upload permissions (optional)
39+
[[users]]
40+
name = "user@email.com"
41+
prefixes = ["/allowed/path"]
42+
```
43+
2744
## Creating user tokens
2845

2946
The server uses JWT token based authentication. The token is passed in the `Authorization` header as a Bearer token.

0 commit comments

Comments
 (0)