Commits

Devin Martin committed 13d0e10

Edited online

Comments (0)

Files changed (1)

-# Welcome
+## Overview
 
-Welcome to your wiki! This is the default page we've installed for your convenience. Go ahead and edit it.
+KeeCloud is a simple plugin that adds support to the built in URL file access in KeePass. The UI and setup is minimal. It is designed to work with the built in opening/saving/synchronization/trigger options in KeePass without duplicating any of that functionality.
 
-## Wiki features
+## Use
 
-This wiki uses the [Markdown](http://daringfireball.net/projects/markdown/) syntax.
+Once the plugin is installed, there are automatically more protocol prefixes that can be used with a URL. KeePass comes with built in support for http(s):// and ftp://. KeeCloud will add other options to that list. The username and password fields will work as appropriate for the specific protocol being used.
 
-The wiki itself is actually a mercurial repository, which means you can clone it, edit it locally/offline, add images or any other file type, and push it back to us. It will be live immediately.
+[Supported Protocols](Supported-Protocols)
 
-Go ahead and try:
+## Example
 
-```
-$ hg clone https://bitbucket.org/devinmartin/keecloud/wiki
-```
+One of the protocols that has been added is support for Amazon Simple Storage Service or S3. The protocol prefix is s3://.
 
-Wiki pages are normal files, with the .md extension. You can edit them locally, as well as creating new ones.
+[[img src=open-s3-example.png alt=open-s3]]
 
-## Syntax highlighting
+The username should be a valid API key that has access to the specified bucket and file and the password should contain the corresponding secret key.
 
+The URL, username, and password are all entered in like normal, and you can now open, save, or synchronize directly with a file located in Amazon S3!
 
-You can also highlight snippets of text (we use the excellent [Pygments][] library).
+## Configuration
 
-[Pygments]: http://www.pygments.org/
+When possible there is no configuration required and credentials are just entered directly into the 'Open From URL' dialog box. However, most of the cloud APIs require some additional steps. This is due to the popularity of an authentication technology called OAuth. 
 
+When using a protocol that is authenticated by OAuth, you don't enter your credentials for your account into the URL dialog box. The service won't accept that. Instead, you use the get protocol credentials wizard located in tools. You craft your URL according to the protocol specific guidelines and then the wizard will open a web browser. You will log into your account and authorize KeePass to access your account. Once this is done, the wizard will create a KeePass entry (or just display them for you) that has your credentials for use with the specified URL.
 
-Here's an example of some Python code:
-
-```
-#!python
-
-def wiki_rocks(text):
-    formatter = lambda t: "funky"+t
-    return formatter(text)
-```
-
-
-You can check out the source of this page to see how that's done, and make sure to bookmark [the vast library of Pygment lexers][lexers], we accept the 'short name' or the 'mimetype' of anything in there.
-[lexers]: http://pygments.org/docs/lexers/
-
-
-Have fun!
+[[download_button]]