diff options
| author | Jon Bergli Heier <snakebite@jvnv.net> | 2014-02-08 23:38:42 +0100 |
|---|---|---|
| committer | Jon Bergli Heier <snakebite@jvnv.net> | 2014-02-08 23:38:42 +0100 |
| commit | c118e804f949544979687ee865d1471e624ca801 (patch) | |
| tree | 693bfab146e05d1a7bab8579407bae8a18712ef7 | |
| parent | 5ec2df4183c11f947c056df6db3383e6557e5d20 (diff) | |
Updated help page.
| -rw-r--r-- | templates/help.tmpl | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/templates/help.tmpl b/templates/help.tmpl index afba84a..d33ca77 100644 --- a/templates/help.tmpl +++ b/templates/help.tmpl @@ -3,12 +3,18 @@ #extends templates.base #def content <p>Usage: POST to <a href="$scheme://${host}${settings.virtual_root}u">$scheme://${host}${settings.virtual_root}u</a> with filedata given to "file" and original filename to "filename". Login is done by generating a login token and sending it as the cookie "token".</p> - <p>TODO: Add info on how to generate a login token.</p> - <p>cURL example: - <blockquote><code>curl -b 'token=foo' -F 'file=@image.png' -F 'filename=image.png' -F 'api=1' http://myhost/u</code></blockquote> + <p>cURL examples, <code>get_token</code>: + <blockquote><pre><code>$ curl $scheme://${host}${settings.virtual_root}a?method=get_token -F username=foo -F password=bar +{"status": true, "message": null, "method": "get_token", "token": "cb42eb38eb516d9dfcaaa742d1da0b3ad454b2bd05a8b4daa6d01e9587d7c759"}</code></pre></blockquote> + Upload using the token: + <blockquote><pre><code>$ curl -b 'token=cb42eb38eb516d9dfcaaa742d1da0b3ad454b2bd05a8b4daa6d01e9587d7c759' -F 'file=@image.png' -F 'filename=image.png' -F 'api=1' $scheme://${host}${settings.virtual_root}u +OK sjLUD</code></pre></blockquote> + To expire the current token: + <blockquote><pre><code>$ curl $scheme://${host}${settings.virtual_root}a?method=expire_token -F token=cb42eb38eb516d9dfcaaa742d1da0b3ad454b2bd05a8b4daa6d01e9587d7c759 +{"status": true, "message": null, "method": "expire_token"}</code></pre></blockquote> If you get HTTP 417 responses, try adding:<code>-H 'Expect:'</code>.</p> <p>By adding the key-value pair "api=1" you will get machine-readable responses in the form: <code>response result</code> where <code>response</code> is either <code>ERROR</code> or <code>OK</code>, - and <code>result</code> is the file hash in the case of <code>OK</code>, or an error message in the case of <code>ERROR</code>. + and <code>result</code> is the file hash in the case of <code>OK</code>, or an error message in the case of <code>ERROR</code> (see example above). The hash can be used to construct URLs in which the paths begin with <code>/f/hash</code> where <code>hash</code> is the hash received.</p> <p>Any file extension an be appended to the hash, and for convenience the original filename (or whatever filename you prefer) can be appended after an additional slash after the hash.</p> #end def |