From 3fb1ab94d758ebe7bfa2b4def7db923345176fed Mon Sep 17 00:00:00 2001 From: Peter Eckersley Date: Mon, 17 Nov 2014 15:34:00 -0800 Subject: [PATCH] New README for Let's Encrypt --- README | 27 +++++++-------------------- attic/README.md | 27 +++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 20 deletions(-) diff --git a/README b/README index 13126c956..07ade422e 100644 --- a/README +++ b/README @@ -1,24 +1,11 @@ -The Chocolate project to implement sweet automatic encryption for webservers. +This is the Let's Encrypt Agent DEVELOPER PREVIEW repository. -There are two portions to the Chocolate protocol. +DO NOT RUN THIS CODE ON A PRODUCTION WEBSERVER. IT WILL INSTALL CERTIFICATES +SIGNED BY A TEST CA, AND WILL CAUSE CERT WARNINGS FOR USERS. -trustify/ contains code that can be run on any webserver (eventually, -email, XMPP and other SSL-securable servers too); it is used to automatically -request and install a CA-signed certificate for that server's public names. +This code intended for testing, demonstration, and integration engineering +with OSes and hosting platforms. -server-ca/ contains a reference implementation for CAs to receive requests for -certs, set challenges for the requesting servers to prove that they really -control the names, and issue certificates. -Debian dependencies: - -build deps: -swig -protobuf-compiler -python-dev - -others: -gnutls-bin # for make cert requests -python-protobuf -python-dialog -hashcash +Debian packaging work will continue in the separate "debian" branch of this +repo. diff --git a/attic/README.md b/attic/README.md index da0dc30cf..a88e0daa4 100644 --- a/attic/README.md +++ b/attic/README.md @@ -2,3 +2,30 @@ The attic contains code and documentation about the trustify protocol, an alternative method for client webservers to request certificates from a server CA. Lets Encrypt does not plan to speak this protocol, though some of the things here may be of future use. + +Notes on this code: + +The Chocolate project to implement sweet automatic encryption for webservers. + +There are two portions to the Chocolate protocol. + +trustify/ contains code that can be run on any webserver (eventually, +email, XMPP and other SSL-securable servers too); it is used to automatically +request and install a CA-signed certificate for that server's public names. + +server-ca/ contains a reference implementation for CAs to receive requests for +certs, set challenges for the requesting servers to prove that they really +control the names, and issue certificates. + +Debian dependencies: + +build deps: +swig +protobuf-compiler +python-dev + +others: +gnutls-bin # for make cert requests +python-protobuf +python-dialog +hashcash