From 43b64cb530c59d67b8d12f48ea75050fdbde37c6 Mon Sep 17 00:00:00 2001 From: Linus Nordberg Date: Wed, 4 Jun 2014 14:43:16 +0200 Subject: Turn README into README.md. --- README | 27 --------------------------- README.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 27 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 5e96842..0000000 --- a/README +++ /dev/null @@ -1,27 +0,0 @@ -ctls is a Certificate Transparency log server (RFC 6962). - -Compile - - $ erl -make - -Requirements - - A running plop application, which in turn requires mnesia to be - running. - - jiffie for JSON encoding and decoding. - -Start - - NOTE: Kludge ahead! ctls will turn into a proper OTP application at - some point in the future. - - Make sure mnesia and plop are running and that plop has been - installed, i.e. has a database. See plop/README. Also, you might - want to code:add_pathz("path/to/plop/ebin"). - - 1> inets:start(httpd, [{proplist_file, "httpd_props.conf"}]). - -To do - - Stop using inets httpd mod_ets and make it a proper application. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e9fe990 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# ctls + +ctls is a Certificate Transparency log server (RFC 6962). + +# Compile + + $ erl -make + +# Requirements + +A running plop application, which in turn requires mnesia to be +running. + +jiffie for JSON encoding and decoding. + +# Start + +NOTE: Kludge ahead! ctls will turn into a proper OTP application at +some point in the future. + +Make sure mnesia and plop are running and that plop has been +installed, i.e. has a database. See `plop/README`. You might also want +to `code:add_pathz("path/to/plop/ebin")`. + + 1> inets:start(httpd, [{proplist_file, "httpd_props.conf"}]). + +# Logs and traces + +As configured in httpd_props.conf, logs can be found in webroot/log/. + +To enable a crazy amount of tracing information from inets, do + + 1> inets_trace:enable(max, io). + +# To do + +- Stop using inets httpd mod_esi and make ctls a proper application. -- cgit v1.1