[TASK] Updated documentation and removed old doc folder - closes #14

derhansen · Nov 9, 2014 · 4b13616 · 4b13616
1 parent cdba3cf
commit 4b13616
Show file tree

Hide file tree

Showing 24 changed files with 578 additions and 40 deletions.
diff --git a/Documentation/.gitignore b/Documentation/.gitignore
@@ -0,0 +1,23 @@
+#########################
+# Git
+# global ignore file
+########################
+# ignoring temporary files (left by e.g. vim)
+# ignoring by common IDE's used directories/files
+# dont ignore .rej and .orig as we want to see/clean files after conflict resolution
+#
+# for local exclude patterns please edit .git/info/exclude
+#
+*~
+*.bak
+*.idea
+*.project
+*.swp
+.buildpath
+.cache
+.project
+.session
+.settings
+.TemporaryItems
+.webprj
+nbproject
diff --git a/...mentation/Administration/ConfiguringTypo3FeloginExtensionToUseYubikey/Index.rst b/...mentation/Administration/ConfiguringTypo3FeloginExtensionToUseYubikey/Index.rst
@@ -0,0 +1,39 @@
+
+
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. ==================================================
+.. DEFINE SOME TEXTROLES
+.. --------------------------------------------------
+.. role::   underline
+.. role::   typoscript(code)
+.. role::   ts(typoscript)
+   :class:  typoscript
+.. role::   php(code)
+
+
+Configuring TYPO3 felogin extension to use YubiKey
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If you have enables YubiKey Authentication for frontend users, you
+have to add an extra field to your felogin template.
+
+First you have to configure felogin, so it uses an own template.
+
+styles.content.loginform.templateFile =
+fileadmin/templates/ext\_felogin/template.html
+
+Then you must add the following HTML to the ###TEMPLATE\_LOGIN###
+section right after the password field.::
+
+ <div>
+   <label for="t3-yubikey">YubiKey</label>
+   <input type="password" id="t3-yubikey" name="t3-yubikey" value="" />
+ </div>
+
+Finally, you can add your own CSS Styles to the new field, so it looks
+like a YubiKey enabled input field.
+
diff --git a/Documentation/Administration/Index.rst b/Documentation/Administration/Index.rst
@@ -0,0 +1,29 @@
+
+
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. ==================================================
+.. DEFINE SOME TEXTROLES
+.. --------------------------------------------------
+.. role::   underline
+.. role::   typoscript(code)
+.. role::   ts(typoscript)
+   :class:  typoscript
+.. role::   php(code)
+
+
+Administration
+--------------
+
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :glob:
+
+   SettingTheYubicoApiKey/Index
+   ConfiguringTypo3FeloginExtensionToUseYubikey/Index
+
diff --git a/Documentation/Administration/SettingTheYubicoApiKey/Images.txt b/Documentation/Administration/SettingTheYubicoApiKey/Images.txt
@@ -0,0 +1,6 @@
+.. |ext-settings|      image:: ../../Images/yubikey-ext-settings.png
+   :height: 870
+   :width: 584
+.. :align: left
+.. :border: 0
+.. :name: Extension settings
diff --git a/Documentation/Administration/SettingTheYubicoApiKey/Index.rst b/Documentation/Administration/SettingTheYubicoApiKey/Index.rst
@@ -0,0 +1,36 @@
+.. include:: Images.txt
+
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. ==================================================
+.. DEFINE SOME TEXTROLES
+.. --------------------------------------------------
+.. role::   underline
+.. role::   typoscript(code)
+.. role::   ts(typoscript)
+   :class:  typoscript
+.. role::   php(code)
+
+
+Setting the Yubico API Key
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+After installing the extension from the extension repository, you need
+to configure the extension settings. The authentication process only
+works, if you provide a Yubico API Key, which can by obtained at
+`https://upgrade.yubico.com/getapikey/
+<https://upgrade.yubico.com/getapikey/>`_
+
+The Yubico API Key is necessary to use the free YubiCloud OTP
+validation service.
+
+After you have obtained your Yubico API Key, enter the Client ID and
+the Client Key in the extension settings.
+
+|ext-settings|
+
+Extension settings for the Yubico API Key
+
diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
@@ -0,0 +1,136 @@
+
+
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. ==================================================
+.. DEFINE SOME TEXTROLES
+.. --------------------------------------------------
+.. role::   underline
+.. role::   typoscript(code)
+.. role::   ts(typoscript)
+   :class:  typoscript
+.. role::   php(code)
+
+
+Configuration
+-------------
+
+The extension can be configured in the extension settings from the
+extension manager. Besides the Yubico API Key and the Client ID, there
+are four other settings that can be configured.
+
+.. t3-field-list-table::
+ :header-rows: 1
+
+ - :Property:
+         Property:
+
+   :Date type:
+         Data type:
+
+   :Description:
+         Description:
+
+   :Default:
+         Default:
+
+ - :Property:
+         yubikeyEnableBE
+
+   :Date type:
+         boolean
+
+   :Description:
+         Enable YubiKey authentication for TYPO3 backend users
+
+   :Default:
+         True
+
+ - :Property:
+         yubikeyEnableFE
+
+   :Date type:
+         boolean
+
+   :Description:
+         Enable YubiKey authentication for TYPO3 backend users
+
+   :Default:
+         False
+
+ - :Property:
+         yubikeyUseSSL
+
+   :Date type:
+         boolean
+
+   :Description:
+         Uses SSL to communicate with the YubiCloud authentication servers. Only respected, if [usePear] is enabled.
+
+   :Default:
+         True
+
+ - :Property:
+         usePear
+
+   :Date type:
+         boolean
+
+   :Description:
+         If checked, the YubiKey pear library will be used to validate YubiKey OTPs. Since version 0.7.0, the
+         extension contains a native YubiKey OTP validation through Yubico API server configured in [yubikeyApiUrl]
+         If you enable this option, make sure that pear is available on you server!
+
+   :Default:
+         False
+
+ - :Property:
+         devlog
+
+   :Date type:
+         boolean
+
+   :Description:
+         Writes debugging messages to the TYPO3 devlog
+
+   :Default:
+         False
+
+ - :Property:
+         yubikeyClientId
+
+   :Date type:
+         string
+
+   :Description:
+         Your Yubico API Client ID
+
+   :Default:
+         Empty
+
+ - :Property:
+         yubikeyClientKey
+
+   :Date type:
+         string
+
+   :Description:
+         Your Yubico API Client Key
+
+   :Default:
+         Empty
+
+ - :Property:
+         yubikeyApiUrl
+
+   :Date type:
+         string
+
+   :Description:
+         The Yubico API URL to validate YubiKey OTPs
+
+   :Default:
+         https://api.yubico.com/wsapi/verify
diff --git a/Documentation/Images.txt b/Documentation/Images.txt
@@ -0,0 +1,11 @@
+.. |img-1|      image:: Images/manual_html_72264b4e.png
+   :height: 44
+   :width: 161
+.. :align: left
+.. :border: 0
+.. :name: graphics5
+.. :vspace: 57
+
+.. |img-2|      image:: Images/manual_html_m12b2d25f.gif
+.. :align: left
+
diff --git a/Documentation/Images/yubikey-be-user.png b/Documentation/Images/yubikey-be-user.png
diff --git a/Documentation/Images/yubikey-ext-settings.png b/Documentation/Images/yubikey-ext-settings.png
diff --git a/Documentation/Images/yubikey-login.png b/Documentation/Images/yubikey-login.png
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -0,0 +1,70 @@
+
+
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. ==================================================
+.. DEFINE SOME TEXTROLES
+.. --------------------------------------------------
+.. role::   underline
+.. role::   typoscript(code)
+.. role::   ts(typoscript)
+   :class:  typoscript
+.. role::   php(code)
+
+=====================================
+YubiKey two-factor OTP authentication
+=====================================
+
+.. only:: html
+
+:Classification:
+	sf_yubikey
+
+:Version:
+	|release|
+
+:Language:
+	en
+
+:Description:
+	YubiKey two-factor OTP authentication
+
+:Keywords:
+	yubikey, yubico, two-factor, authentication, service
+
+:Copyright:
+	2012 - 2014
+
+:Author:
+	Torben Hansen
+
+:Email:
+	derhansen@gmail.com
+
+:License:
+	This document is published under the Open Content License
+	available from http://www.opencontent.org/opl.shtml
+
+:Rendered:
+	|today|
+
+The content of this document is related to TYPO3,
+a GNU/GPL CMS/Framework available from `www.typo3.org <http://www.typo3.org/>`_.
+
+**Table of Contents**
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :glob:
+
+   Introduction/Index
+   UsersManual/Index
+   Administration/Index
+   Configuration/Index
+   KnownProblems/Index
+   To-doList/Index
+
diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst
@@ -0,0 +1,29 @@
+
+
+.. ==================================================
+.. FOR YOUR INFORMATION
+.. --------------------------------------------------
+.. -*- coding: utf-8 -*- with BOM.
+
+.. ==================================================
+.. DEFINE SOME TEXTROLES
+.. --------------------------------------------------
+.. role::   underline
+.. role::   typoscript(code)
+.. role::   ts(typoscript)
+   :class:  typoscript
+.. role::   php(code)
+
+
+Introduction
+------------
+
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :glob:
+
+   WhatDoesItDo/Index
+   Screenshots/Index
+
diff --git a/Documentation/Introduction/Screenshots/Images.txt b/Documentation/Introduction/Screenshots/Images.txt
@@ -0,0 +1,7 @@
+.. |login|      image:: ../../Images/yubikey-login.png
+   :height: 338
+   :width: 470
+.. :align: left
+.. :border: 0
+.. :name: YubiKey TYPO3 backend login
+