Skip to content

Commit 1500a4f

Browse files
committed
Adding a proper readme.md
1 parent fee4272 commit 1500a4f

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# EasyCert
2+
3+
Use EasyCert to easily generate webserver certificates against a private certificate authority that is also generated by this tool.
4+
Why would you want to use this? This should only be used within company networks, never public facing. You would use this to implement
5+
your own TLS connections where you are dealing in a test environment where the security doesn't really matter. This is more about making
6+
sure things work across https correctly. In other words, when you are working on anything production-level you'd want to acquire a genuine
7+
certificate from a trust certificate authority and probably pay for it.
8+
9+
## Requirements
10+
11+
This has been test and run on OSX which is comes pre-installed with openssl, that is all you need.
12+
13+
## Installation
14+
15+
Simple as it takes to type the following command:
16+
17+
go get github.com/deckarep/EasyCert
18+
19+
## Usage
20+
21+
EasyCert just requires a certificate authority name which can be an arbitrary name but should reflect your company and a host name that the certificate/key pair will end up on.
22+
~~~
23+
Usage: EasyCert [options...]
24+
25+
Options:
26+
-cn Certificate Authority Name (can be any name, but should reflect your company name.)
27+
-h Hostname of TLS server to install the private cert/key
28+
~~~
29+
30+
## License
31+
32+
Copyright 2014 Ralph Caraveo All Rights Reserved.
33+
34+
Licensed under the Apache License, Version 2.0 (the "License");
35+
you may not use this file except in compliance with the License.
36+
You may obtain a copy of the License at
37+
38+
http://www.apache.org/licenses/LICENSE-2.0
39+
40+
Unless required by applicable law or agreed to in writing, software
41+
distributed under the License is distributed on an "AS IS" BASIS,
42+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
43+
See the License for the specific language governing permissions and
44+
limitations under the License.

0 commit comments

Comments
 (0)