Improve readme and fix typos
This commit is contained in:
parent
592fed030d
commit
fdd5ae6903
2 changed files with 44 additions and 26 deletions
50
README.md
50
README.md
|
|
@ -1,28 +1,31 @@
|
|||
|
||||
# Table of Contents
|
||||
|
||||
1. [ldap0r](#org5453f05)
|
||||
1. [Installation](#org225ba27)
|
||||
2. [Todo List](#org54f2856)
|
||||
1. [Password reset <code>[5/10]</code>](#org09786dd)
|
||||
2. [Configuration <code>[0/5]</code>](#orgb93c7a2)
|
||||
3. [Login Section (not sure if going to happen)](#orga66a23f)
|
||||
1. [ldap0r](#orgf56b909)
|
||||
1. [Installation](#org6f0551a)
|
||||
2. [Contribution](#org8358327)
|
||||
3. [Todo List](#orga6f7ebf)
|
||||
1. [Password reset <code>[5/11]</code>](#org83950f1)
|
||||
2. [Configuration <code>[0/5]</code>](#orgf7ec86e)
|
||||
3. [Login Section (not sure if going to happen)](#org9f168b0)
|
||||
|
||||
|
||||
<a id="org5453f05"></a>
|
||||
<a id="orgf56b909"></a>
|
||||
|
||||
# ldap0r
|
||||
|
||||
So far `ldap0r` is simply a very small web application just to reset
|
||||
LDAP passwords. An user enters its email address, receives an email
|
||||
containing a link to reset its LDAP password, thats it so far.
|
||||
LDAP passwords. All it is capable of is to let an user enter its
|
||||
email address and send an email containing a generated link to reset
|
||||
the LDAP password, that's it so far. My motivation was to have
|
||||
something "suckless" which does not depend on PHP or similar insane.
|
||||
|
||||
|
||||
<a id="org225ba27"></a>
|
||||
<a id="org6f0551a"></a>
|
||||
|
||||
## Installation
|
||||
|
||||
A rust nightly toolchain which can be aquired via <https://rustup.rs>
|
||||
A rust nightly toolchain which can be acquired via <https://rustup.rs>
|
||||
is needed in order to successfully build `ldap0r`. Install `rustup`,
|
||||
download rust nightly, then clone this repository, set the
|
||||
toolchain inside the source directory to nightly, build and run it.
|
||||
|
|
@ -37,18 +40,25 @@ The application can be configured with the `Rocket.toml`
|
|||
configuration file.
|
||||
|
||||
|
||||
<a id="org54f2856"></a>
|
||||
<a id="org8358327"></a>
|
||||
|
||||
## Contribution
|
||||
|
||||
I am open for suggestions and appreciate any feedback.
|
||||
|
||||
|
||||
<a id="orga6f7ebf"></a>
|
||||
|
||||
## Todo List
|
||||
|
||||
|
||||
<a id="org09786dd"></a>
|
||||
<a id="org83950f1"></a>
|
||||
|
||||
### Password reset <code>[5/10]</code>
|
||||
### Password reset <code>[5/11]</code>
|
||||
|
||||
1. DONE Form to send resetlink
|
||||
1. DONE Form to send reset link
|
||||
|
||||
2. DONE Parse url with reset key
|
||||
2. DONE Parse URL with reset key
|
||||
|
||||
3. DONE Cleanup all unwraps
|
||||
|
||||
|
|
@ -64,10 +74,12 @@ configuration file.
|
|||
|
||||
9. TODO Implement proper tests
|
||||
|
||||
10. TODO Optionaly store key persistently between restarts
|
||||
10. TODO Optionally store key persistently between restarts
|
||||
|
||||
11. TODO Should `tera` templates instead of `handlebar` templates be used?
|
||||
|
||||
|
||||
<a id="orgb93c7a2"></a>
|
||||
<a id="orgf7ec86e"></a>
|
||||
|
||||
### Configuration <code>[0/5]</code>
|
||||
|
||||
|
|
@ -82,6 +94,6 @@ configuration file.
|
|||
5. TODO Make html/text emails configurable
|
||||
|
||||
|
||||
<a id="orga66a23f"></a>
|
||||
<a id="org9f168b0"></a>
|
||||
|
||||
### Login Section (not sure if going to happen)
|
||||
|
|
|
|||
20
README.org
20
README.org
|
|
@ -1,10 +1,12 @@
|
|||
* ldap0r
|
||||
So far =ldap0r= is simply a very small web application just to reset
|
||||
LDAP passwords. An user enters its email address, receives an email
|
||||
containing a link to reset its LDAP password, thats it so far.
|
||||
LDAP passwords. All it is capable of is to let an user enter its
|
||||
email address and send an email containing a generated link to reset
|
||||
the LDAP password, that's it so far. My motivation was to have
|
||||
something "suckless" which does not depend on PHP or similar insane.
|
||||
|
||||
** Installation
|
||||
A rust nightly toolchain which can be aquired via https://rustup.rs
|
||||
A rust nightly toolchain which can be acquired via https://rustup.rs
|
||||
is needed in order to successfully build =ldap0r=. Install =rustup=,
|
||||
download rust nightly, then clone this repository, set the
|
||||
toolchain inside the source directory to nightly, build and run it.
|
||||
|
|
@ -20,10 +22,13 @@
|
|||
The application can be configured with the =Rocket.toml=
|
||||
configuration file.
|
||||
|
||||
** Contribution
|
||||
I am open for suggestions and appreciate any feedback.
|
||||
|
||||
** Todo List
|
||||
*** Password reset [5/10]
|
||||
**** DONE Form to send resetlink
|
||||
**** DONE Parse url with reset key
|
||||
*** Password reset [5/11]
|
||||
**** DONE Form to send reset link
|
||||
**** DONE Parse URL with reset key
|
||||
**** DONE Cleanup all unwraps
|
||||
**** DONE Proper error handling
|
||||
**** DONE Implement proper logging
|
||||
|
|
@ -31,7 +36,8 @@
|
|||
**** TODO Check for existing keys
|
||||
**** TODO Implement key validity timeout
|
||||
**** TODO Implement proper tests
|
||||
**** TODO Optionaly store key persistently between restarts
|
||||
**** TODO Optionally store key persistently between restarts
|
||||
**** TODO Should =tera= templates instead of =handlebar= templates be used?
|
||||
|
||||
*** Configuration [0/5]
|
||||
**** TODO Fix domain config
|
||||
|
|
|
|||
Loading…
Reference in a new issue