commit 3227d99e8d14d56e88f07355c04fc1618c4a9cbf parent 2dc276e4114538d41399da9105cc60f30db56de6 Author: Martin Schanzenbach <mschanzenbach@posteo.de> Date: Tue, 19 Apr 2022 15:26:08 +0200 Add readme Diffstat:
| A | README.md | | | 36 | ++++++++++++++++++++++++++++++++++++ |
1 file changed, 36 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,36 @@ +# External Dependencies + + - "github.com/gorilla/mux" + - "gorm.io/gorm" + - "gorm.io/driver/sqlite" + - "golang.org/x/crypto/argon2" + +# Build and Run + +Run for testing: + +``` +$ go run . +``` + +Compile and run: + +``` +$ go build +$ ./taldir +``` +# Configuration + +The configuration file of taldir is ```config.json```. +The following configuration varaibles exist: + + + * "production" (boolean): true for a production deployment. Causes verbose log messages to be inhibited. + * "db_backend" (string): "sqlite" for the SQLite database backend to be used. + * "validators" (array): An array of strings for the validators/identity types that can be used. Currently supported values: "email" + * "email_sender" (string): For email validations, what should the sender address be. + * "host" (string): For the validation link, which hostname should be used (useful if behind proxy). + * "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 ```config.json``` file shipped with this software.