docs: add project overview and setup instructions to README

Browse Source
This commit is contained in:
retoor 2024-11-26 07:13:31 +00:00
parent ee2e3ce0e5
commit 2cfb9f4b52
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -5,10 +5,10 @@ Easiest file manager for your server made for public use.
It doesn't have captcha or whatsoever. It's designed for public use, as long the domain isn't listed in a search engine. It has a limitation for file size, that's it's only security. Rate limiting is in consideration. The default file size is 50Mb. The default storage quota for whole directory is 10Gb. Default config will prevent your server for heavy abuse.
## Installation
```
python3 -m venv .venv
./venv/bin/python -m pip install .
```
1. `make ensure_venv`
2. `make install`
3. `source ./.venv/bin.activate`
4. `rupload.serve` (See parameters below. Running with default config using no parameters works too.)
## Usage
```bash