Skip to content

Commit 82d57a6

Browse files
committed
Add README.md
Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>
1 parent b30c0ab commit 82d57a6

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# KernelCI Storage Server
2+
3+
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.
5+
It caches the files in a local directory and serves them from there.
6+
Range requests are supported, but only for start offset, end limit is not implemented yet.
7+
8+
## Configuration
9+
10+
The server is configured using toml configuration file, the default configuration file is `config.toml`.
11+
12+
```toml
13+
jwt_secret="JWT_SECRET"
14+
[azure]
15+
account=""
16+
key=""
17+
container=""
18+
sastoken=""
19+
```
20+
21+
## API
22+
23+
### Upload
24+
25+
`POST /upload`
26+
27+
Upload a file to the server.
28+
29+
field path: the path to store the file in the server.
30+
field file0: the file to upload.
31+
32+
### Download
33+
34+
`GET /path/to/file`
35+
36+
Download a file from the server.
37+

0 commit comments

Comments
 (0)