mbiryukova/lego
1
0
Fork 0
forked from TrueCloudLab/lego
Code Pull requests Activity

README.md fix + include godoc link

Browse source
This commit is contained in:
xenolf 2015-10-19 01:02:44 +02:00
parent 0cd31861d3
commit 006242198b
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -1,11 +1,12 @@
# lego # lego
Let's Encrypt client and library in go! Let's Encrypt client and library in go!
[![GoDoc](https://godoc.org/github.com/xenolf/lego/acme?status.svg)](https://godoc.org/github.com/xenolf/lego/acme)
[![Build Status](https://travis-ci.org/xenolf/lego.svg?branch=master)](https://travis-ci.org/xenolf/lego) [![Build Status](https://travis-ci.org/xenolf/lego.svg?branch=master)](https://travis-ci.org/xenolf/lego)
This is a work in progress. Please do *NOT* run this on a production server. This is a work in progress. Please do *NOT* run this on a production server.
####Current Status #### Current Status
The code in this repository is currently quite raw. The code in this repository is currently quite raw.
You are currently able to register an account with the ACME server as well as request certificates through the CLI. You are currently able to register an account with the ACME server as well as request certificates through the CLI.
@ -13,7 +14,7 @@ Please keep in mind that CLI switches and APIs are still subject to change.
When using the standard --path option, all certificates and account configurations are saved to a folder *.lego* in the current working directory. When using the standard --path option, all certificates and account configurations are saved to a folder *.lego* in the current working directory.
####Sudo #### Sudo
I tried to not need sudo apart from challenges where binding to a privileged port is necessary. I tried to not need sudo apart from challenges where binding to a privileged port is necessary.
To run the CLI without sudo, you have two options: To run the CLI without sudo, you have two options:
- Use ```setcap 'cap_net_bind_service=+ep' /path/to/program``` - Use ```setcap 'cap_net_bind_service=+ep' /path/to/program```
@ -108,7 +109,7 @@ if err != nil {
log.Fatal(err) log.Fatal(err)
} }
// Each certificate comes back with the cert bytes, the bytes of the server's // Each certificate comes back with the cert bytes, the bytes of the client's
// private key, and a certificate URL. This is where you should save them to files! // private key, and a certificate URL. This is where you should save them to files!
fmt.Printf("%#v\n", certificates) fmt.Printf("%#v\n", certificates)