From 6d5ca0f46c55519aff239684639c5278d3bd2425 Mon Sep 17 00:00:00 2001
From: cbdev <cb@cbcdn.com>
Date: Sat, 7 May 2022 15:32:29 +0200
Subject: Extend README, implement cargohold-cli

---
 README.md | 36 ++++++++++++++++++++++++++++++++----
 1 file changed, 32 insertions(+), 4 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 30588ac..7827385 100644
--- a/README.md
+++ b/README.md
@@ -6,22 +6,50 @@ that lets them download or view the files you want them to have.
 
 ## Installation
 
-* Install nginx and uwsgi
+Required dependencies
+
+* nginx
+* uwsgi
+* uwsgi-plugin-python3
+* sqlite3
+* python3
+
+Basic infrastructure
+
 * Create a directory where cargohold will store the uploaded files
 * Set the directory's owner to the user you want uwsgi to run the application under
 * Edit `backend/config.py` to match your setup
 * Edit `configs/nginx.config` to match your setup
 	* Note that the `client_max_body_size` directive will limit the maximum size of a single uploaded file
-* Install `configs/nginx.config` to `/etc/nginx/sites-enabled`
+* Install `configs/nginx.config` to `/etc/nginx/sites-enabled/`
 * Edit `configs/uwsgi.ini` to match your setup
 	* Note that the `limit-post` option will limit the maximum size of a single uploaded file
-* Install `configs/uwsgi.ini` to `/etc/uwsgi/apps-enabled/cargohold.ini`
+* Install `configs/uwsgi.ini` to `/etc/uwsgi/apps-enabled/`
+
+Initial configuration
+
+* Create the cargohold database by running `sqlite3 cargohold.db3 < backend/cargohold.sql`
+* Update `backend/config.py` with the path to your database
 
 TBD: Extend this.
 
 ## Usage
 
-TBD
+The database stores the the following data for each alias
+
+* *Alias*: The identifier to be appended to the base URL
+* *User*: The user the identifier belongs to, for administrative and storage accounting purposes
+* *Real path*: The on-disk directory name where, when prepended with both the `fileroot` and optionally, the `userdir`, the data is stored. Multiple aliases may point to the same real path.
+* *Access level*: The access level this alias permits to the real path. A string consisting of any of the characters *c* (*C*reate / Upload), *r* (*R*etrieve / Read), *u* (*U*pdate), *d* (*D*elete) in any order.
+* *Storage limit*: Per-alias storage limit (applied when uploading)
+* *Display mode*: Parameter 
+
+The storage limit for each alias (applied when uploading files) is calculated as the minimum of the following parameters
+
+* Global disk size limit
+* `global_limit` in `backend/config.py`
+* The per-user limit
+* The per-alias limit
 
 ## Interface
 
-- 
cgit v1.2.3