| 192 |
- |
1 |
# Overview
|
|
|
2 |
|
|
|
3 |
easy-rsa is a CLI utility to build and manage a PKI CA. In laymen's terms,
|
|
|
4 |
this means to create a root certificate authority, and request and sign
|
|
|
5 |
certificates, including intermediate CAs and certificate revocation lists (CRL).
|
|
|
6 |
|
|
|
7 |
# Downloads
|
|
|
8 |
|
|
|
9 |
If you are looking for release downloads, please see the releases section on
|
|
|
10 |
GitHub. Releases are also available as source checkouts using named tags.
|
|
|
11 |
|
|
|
12 |
# Documentation
|
|
|
13 |
|
|
|
14 |
For 3.x project documentation and usage, see the [README.quickstart.md](README.quickstart.md) file or
|
|
|
15 |
the more detailed docs under the doc/ directory. The .md files are in Markdown
|
|
|
16 |
format and can be converted to html files as desired for release packages, or
|
|
|
17 |
read as-is in plaintext.
|
|
|
18 |
|
|
|
19 |
# Getting help using easy-rsa
|
|
|
20 |
|
|
|
21 |
Currently, Easy-RSA development co-exists with OpenVPN even though they are
|
|
|
22 |
separate projects. The following resources are good places as of this writing to
|
|
|
23 |
seek help using Easy-RSA:
|
|
|
24 |
|
|
|
25 |
The [openvpn-users mailing list](https://lists.sourceforge.net/lists/listinfo/openvpn-users)
|
|
|
26 |
is a good place to post usage or help questions.
|
|
|
27 |
|
|
|
28 |
You can also try IRC at Freenode/#openvpn for general support or Freenode/#easyrsa for development discussion.
|
|
|
29 |
|
|
|
30 |
# Branch structure
|
|
|
31 |
|
|
|
32 |
The easy-rsa master branch is currently tracking development for the 3.x release
|
|
|
33 |
cycle. Please note that, at any given time, master may be broken. Feel free to
|
|
|
34 |
create issues against master, but have patience when using the master branch. It
|
|
|
35 |
is recommended to use a release, and priority will be given to bugs identified in
|
|
|
36 |
the most recent release.
|
|
|
37 |
|
|
|
38 |
The prior 2.x and 1.x versions are available as release branches for
|
|
|
39 |
tracking and possible back-porting of relevant fixes. Branch layout is:
|
|
|
40 |
|
|
|
41 |
master <- 3.x, at present
|
|
|
42 |
v3.x.x pre-release branches, used for staging branches
|
|
|
43 |
release/2.x
|
|
|
44 |
release/1.x
|
|
|
45 |
|
|
|
46 |
LICENSING info for 3.x is in the [COPYING.md](COPYING.md) file
|
|
|
47 |
|
|
|
48 |
# Code style, standards
|
|
|
49 |
|
|
|
50 |
We are attempting to adhere to the POSIX standard, which can be found here:
|
|
|
51 |
|
|
|
52 |
https://pubs.opengroup.org/onlinepubs/9699919799/
|