Skip to content

Commit f0b6f50

Browse files
committed
📝 (api) Add installation instructions
1 parent 042e8db commit f0b6f50

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/api.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
`leakrfc` provides a simpel api powered by [FastAPI](https://fastapi.tiangolo.com/) for clients to retrieve file metadata and blobs. It therefore acts as a proxy between client and archive, so that the client doesn't need to know where the actual blobs live. The api can handle authorization via [JSON Web Tokens](https://jwt.io).
22

3+
## Installation
4+
5+
The API feature needs some extra packages that are not installed by default. Install `leakrfc` with api dependencies:
6+
7+
pip install leakrfc[api]
8+
39
## Start local api server
410

511
This is for a quick testing setup:

0 commit comments

Comments
 (0)