[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-taldir] branch master updated: update readme
From: |
gnunet |
Subject: |
[taler-taldir] branch master updated: update readme |
Date: |
Thu, 07 Jul 2022 16:44:15 +0200 |
This is an automated email from the git hooks/post-receive script.
martin-schanzenbach pushed a commit to branch master
in repository taldir.
The following commit(s) were added to refs/heads/master by this push:
new c89cd44 update readme
c89cd44 is described below
commit c89cd448763710db0fc287131cccb785dc3f78aa
Author: Martin Schanzenbach <schanzen@gnunet.org>
AuthorDate: Thu Jul 7 16:44:11 2022 +0200
update readme
---
README.md | 47 +++++++++++++++++++++++++++++++++++++++--------
1 file changed, 39 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 7ceb23d..368cb84 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,6 @@
-# External Dependencies
+# Taler Directory
- - "github.com/gorilla/mux"
- - "gorm.io/gorm"
- - "gorm.io/driver/sqlite"
- - "golang.org/x/crypto/argon2"
+This is the Taler Directory (TalDir) implementation.
# Build and Run
@@ -13,10 +10,18 @@ Compile and run:
$ make
$ ./taldir-server
```
+
+# Test
+
+```
+$ go test -v ./cmd/talidir-server
+```
+
# Configuration
-The configuration file of taldir is ```taldir.conf```.
-The following configuration varaibles exist:
+The configuration file of taldir is `taldir.conf`.
+
+The following configuration variables exist:
* "production" (boolean): true for a production deployment. Causes verbose
log messages to be inhibited.
@@ -27,4 +32,30 @@ The following configuration varaibles exist:
* "bind_to" (string): Where to bind and listen (HTTP server).
* "salt" (string): The salt to use for identity key hashes in the databse.
-Examples and defaults for the configuration can be found in the
```taldir.conf``` file shipped with this software.
+Examples and defaults for the configuration can be found in the `taldir.conf`
file shipped with this software.
+
+# Validators
+
+Taldir validators are executable programs which are used to transfer a
validation
+code out of band to the client.
+A Taldir validator is uniquely identified by a name.
+In order to enable a validator, its `<name>` must be present in the
`validators` field
+in the `taldir` section in the Taldir configuration file.
+Further, a `taldir-<name>` section must exists which contains the following
+variables:
+
+ * "challenge_fee" (amount): The cost of a single challenge using this
validation method.
+ * "command" (string): The program to use to trigger the out of band transfer
of the validation code.
+
+## Validator command
+
+The validator command is an executable program which takes exactly two
arguments:
+For example:
+
+```
+$ validator-test <address> <code>
+```
+
+The first argument of the validator command is the address in a validation
method-specific format.
+For example, the email validation expects an email address, the Twitter
validator expects a Twitter handle, etc.
+The second argument is the activation code generated by Taldir and which is
expected to be transferred using the validation method to the user.
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.