Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8544d6d
commit c80f60b
Showing
3 changed files
with
122 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Contributor Code of Conduct | ||
|
||
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. | ||
|
||
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery | ||
* Personal attacks | ||
* Trolling or insulting/derogatory comments | ||
* Public or private harassment | ||
* Publishing others' private information, such as physical or electronic addresses, without explicit permission | ||
* Other unethical or unprofessional conduct. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team. | ||
|
||
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# freshcerts [![unlicense](https://img.shields.io/badge/un-license-green.svg?style=flat)](http://unlicense.org) | ||
|
||
[ACME](https://letsencrypt.github.io/acme-spec/) (currently implemented by [Let's Encrypt](https://letsencrypt.org)) is a way to automatically (re)issue TLS certificates. | ||
|
||
Most ACME clients are designed to run on the same machine as your TLS services. | ||
But if you have a lot of servers, there are two problems with that: | ||
- you either have to copy your account private key onto all of them, or register multiple accounts; | ||
- you don't have a nice monitoring dashboard! | ||
|
||
freshcerts solves both problems. | ||
It runs a server that exposes a much simpler API to your servers (they'll use a tiny shell script that's pretty much `openssl | curl | tar`) and a dashboard to your system administrators. | ||
|
||
## Installation | ||
|
||
It's a typical Ruby app, so you'll need [Bundler](http://bundler.io): | ||
|
||
```bash | ||
$ git clone https://github.com/myfreeweb/freshcerts.git | ||
$ cd freshcerts | ||
$ bundle install --path vendor/bundle | ||
$ mkdir data | ||
``` | ||
|
||
Use environment variables to change the ACME endpoint (by default, Let's Encrypt **staging** is used, not production): | ||
|
||
```bash | ||
$ export ACME_ENDPOINT="https://acme-v01.api.letsencrypt.org/" | ||
``` | ||
|
||
Generate and register an account key: | ||
|
||
```bash | ||
$ openssl genrsa -out data/account.key.pem 4096 | ||
$ chmod 0400 data/account.key.pem | ||
$ bundle exec ./register-account-key | ||
``` | ||
|
||
Run: | ||
|
||
```bash | ||
$ bundle exec rackup -p 9393 | ||
``` | ||
|
||
In production, you'll want to configure your process manager to run it. | ||
Set `RACK_ENV=production` there. | ||
|
||
## Usage | ||
|
||
For every domain: | ||
|
||
Configure the HTTP server to forward `/.well-known/acme-challenge/*` requests to the freshcerts server. | ||
|
||
Configure cron to run the `freshcerts-client` script every day. | ||
|
||
Don't forget to change the configuration inside of the script. | ||
|
||
Args: domain, subject, ports (comma separated), reload command. Like this: | ||
|
||
``` | ||
freshcerts-client example.com /CN=example.com 443 "service nginx reload" | ||
``` | ||
|
||
Figure out cert paths and file permissions :-) | ||
|
||
## Contributing | ||
|
||
Please feel free to submit pull requests! | ||
|
||
By participating in this project you agree to follow the [Contributor Code of Conduct](http://contributor-covenant.org/version/1/2/0/). | ||
|
||
[The list of contributors is available on GitHub](https://github.com/myfreeweb/freshcerts/graphs/contributors). | ||
|
||
## License | ||
|
||
This is free and unencumbered software released into the public domain. | ||
For more information, please refer to the `UNLICENSE` file or [unlicense.org](http://unlicense.org). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
This is free and unencumbered software released into the public domain. | ||
|
||
Anyone is free to copy, modify, publish, use, compile, sell, or | ||
distribute this software, either in source code form or as a compiled | ||
binary, for any purpose, commercial or non-commercial, and by any | ||
means. | ||
|
||
In jurisdictions that recognize copyright laws, the author or authors | ||
of this software dedicate any and all copyright interest in the | ||
software to the public domain. We make this dedication for the benefit | ||
of the public at large and to the detriment of our heirs and | ||
successors. We intend this dedication to be an overt act of | ||
relinquishment in perpetuity of all present and future rights to this | ||
software under copyright law. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. | ||
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR | ||
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, | ||
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | ||
OTHER DEALINGS IN THE SOFTWARE. | ||
|
||
For more information, please refer to <http://unlicense.org/> |