diff options
| author | elijah <elijah@riseup.net> | 2013-05-19 22:28:01 -0700 |
|---|---|---|
| committer | elijah <elijah@riseup.net> | 2013-05-19 22:28:01 -0700 |
| commit | f9d6b218be3bdbb2d3c544849b2ab92348d0e394 (patch) | |
| tree | 71cd7ab6e5e9ffb4571b555324ada743c3d29387 /README.md | |
| parent | 5d2e69ad4f2b6214df52c617f5e6cb23d9f40944 (diff) | |
many related changes -- allow command line configs, validate addresses, overhaul bootstrap.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 23 insertions, 5 deletions
@@ -1,9 +1,15 @@ Nickserver ================================== -Nickserver is a server running the Nicknym protocol. This daemon can be run by service providers in order to support Nicknym. +Nickserver is a server running the Nicknym protocol. This daemon can be run by +service providers in order to support Nicknym. -Nicknym is a protocol to map user nicknames to public keys. With Nicknym, the user is able to think solely in terms of nickname, while still being able to communicate with a high degree of security (confidentiality, integrity, and authenticity). Essentially, Nicknym is a system for binding human-memorable nicknames to a cryptographic key via automatic discovery and automatic validation. +Nicknym is a protocol to map user nicknames to public keys. With Nicknym, the +user is able to think solely in terms of nickname, while still being able to +communicate with a high degree of security (confidentiality, integrity, and +authenticity). Essentially, Nicknym is a system for binding human-memorable +nicknames to a cryptographic key via automatic discovery and automatic +validation. For more information, see https://leap.se/nicknym @@ -20,7 +26,8 @@ You query the nickserver via HTTP. The API is very minimal: curl -X POST -d address=alice@domain.org https://nicknym.domain.org:6425 -The response consists of a signed JSON document with fields for the available public keys corresponding to the address. +The response consists of a signed JSON document with fields for the available +public keys corresponding to the address. For more details, see https://leap.se/nicknym @@ -35,6 +42,13 @@ Installation You have three fine options for installing nickserver: +Install prerequisites + + $ sudo apt-get install ruby1.9.1-dev libssl-dev + +Note: libssl-dev must be installed before installing the gem EventMachine, +otherwise the gem will get built without TLS support. + Install from source: $ git clone git://leap.se/nickserver @@ -52,9 +66,13 @@ Install for development: Configuration ================================== -Nickserver loads the configuration files `config/default.yml` and `/etc/leap/nickserver.yml`, if it exists. See `config/default.yml` for the available options. +Nickserver loads the configuration files `config/default.yml` and +`/etc/leap/nickserver.yml`, if it exists. See `config/default.yml` for the +available options. -The default HKP host is set to https://hkps.pool.sks-keyservers.net. The CA for this pool is available here https://sks-keyservers.net/sks-keyservers.netCA.pem +The default HKP host is set to https://hkps.pool.sks-keyservers.net. The CA +for this pool is available here https://sks-keyservers.net/sks- +keyservers.netCA.pem Usage ================================== |