summaryrefslogtreecommitdiff
path: root/templates/help.tmpl
blob: afba84a6176b00eff91e3dee547089d6b250ed48 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
#def title: help
#def header: help
#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>
		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>.
		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