You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
127 lines
3.5 KiB
127 lines
3.5 KiB
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>Taskrambler - Documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="/style/common.css">
|
|
<link rel="stylesheet" type="text/css" href="/style/taskrambler.css" />
|
|
<link rel="shortcut icon" href="/favicon.ico?v=2" />
|
|
<script type="text/javascript" src="/js/jquery.js"></script>
|
|
<script type="text/javascript" src="/js/serverval.js"></script>
|
|
<script type="text/javascript" src="/js/session.js"></script>
|
|
<script type="text/javascript" src="/js/init.js"></script>
|
|
</head>
|
|
|
|
<body>
|
|
<div id="login" class="hide">
|
|
</div>
|
|
|
|
<div id="signup" class="hide">
|
|
</div>
|
|
|
|
<div id="page">
|
|
<div id="statusline">
|
|
</div>
|
|
|
|
<div id="title">
|
|
</div>
|
|
|
|
<div id="menu">
|
|
</div>
|
|
|
|
<div id="main">
|
|
<h1>Documentation</h1>
|
|
|
|
<hr />
|
|
<p class="abstract">
|
|
<span class="author">[GH]</span>
|
|
Currently this is more a changelog and a description
|
|
how to use new features.
|
|
</p>
|
|
<hr />
|
|
|
|
<h2>API Doc and test coverage</h2>
|
|
|
|
<p>
|
|
There is the beginning of a api doc and automated
|
|
test coverage reports.<br />
|
|
Both don't cover the complete code.<br />
|
|
|
|
There is the beginning of a generated API doc
|
|
<a href="/doc/index.html" target="_blank">here</a>.<br />
|
|
|
|
I also started automated regression tests. The
|
|
results can be seen
|
|
<a href="/coverage/index.html" target="_blank">here</a>.
|
|
</p>
|
|
|
|
<h2>Version 0.1.5</h2>
|
|
|
|
<p>
|
|
Another step on the way. Now basic signup is possible.
|
|
Users and credential will be stored in gdbm files.
|
|
If you do not want to signup you can use the pre created
|
|
guest account to login.<br/><br/>
|
|
<b>username:</b> guest<br/>
|
|
<b>password:</b> guest<br/><br/>
|
|
This user will not be available if you build your own
|
|
version of taskrambler.
|
|
</p>
|
|
|
|
<h3>Usage</h3>
|
|
|
|
<p>
|
|
The signup and login can be testes by clicking on
|
|
signup or login in the menu. A popup should occur where
|
|
you can enter the neccessary informations. Currently
|
|
no sanity checks are done on the given data. The key
|
|
is the email address.
|
|
</p>
|
|
|
|
<p>
|
|
If you signup with an email address
|
|
that is already in the database nothing happens, else
|
|
a user will be created and logged in.
|
|
</p>
|
|
|
|
<p>
|
|
After a successful login the first and surname will be
|
|
visible in the upper right corner of the page.
|
|
</p>
|
|
|
|
<p>
|
|
Additionally to the name you can find the version,
|
|
session id as well as an indicator how long the session
|
|
lasts. A session lasts 5 minutes since the last preocessed
|
|
request.
|
|
</p>
|
|
|
|
<h3>Changes</h3>
|
|
|
|
<p>
|
|
<ul>
|
|
<li>add storage layer</li>
|
|
<li>add signup functionality</li>
|
|
<ul>
|
|
<li>store users</li>
|
|
<li>store passwords as PBKDF2 sha512</li>
|
|
</ul>
|
|
<li>make login work agains ldap and stored passwords</li>
|
|
<li>add favicon</li>
|
|
<li>show version, session info and login info on each page</li>
|
|
</ul>
|
|
</p>
|
|
</div>
|
|
|
|
<div id="footer">
|
|
<hr />
|
|
© 2013 Georg Hopp -
|
|
<a href="mailto:georg@steffers.org">contact-email</a>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
|
|
<!-- vim: set ts=4 sw=4: -->
|