From b36f9c05071ea549ed59e703270fcf223b60df03 Mon Sep 17 00:00:00 2001
From: Jon Bergli Heier <snakebite@jvnv.net>
Date: Sun, 9 Apr 2017 09:02:09 +0200
Subject: Major rewrite to use jab/oauth.

Highlights:

- Uses the oauth branch of jab.
- Changed design to use bootstrap.
- Some minor changes to functionality in file uploading and listing.
- API is currently disabled and incomplete.
---
 fbin/templates/help.html | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 fbin/templates/help.html

(limited to 'fbin/templates/help.html')

diff --git a/fbin/templates/help.html b/fbin/templates/help.html
new file mode 100644
index 0000000..899cd78
--- /dev/null
+++ b/fbin/templates/help.html
@@ -0,0 +1,30 @@
+{% extends "base.html" %}
+{% block content %}
+<div class="alert alert-danger">
+	<h2>
+		<span class="glyphicon glyphicon-alert" aria-hidden="true"></span>
+		TODO: Update this page.
+	</h2>
+</div>
+<div class="alert alert-warning">
+	<span class="glyphicon glyphicon-alert" aria-hidden="true"></span>
+	Everything below this point is outdated and should be disregarded until further notice.
+</div>
+<s>
+<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>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> (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>
+</s>
+{% endblock %}
-- 
cgit v1.2.3