Skip to content

Commit c4614d8

Browse files
committed
update README.md
1 parent c529714 commit c4614d8

File tree

1 file changed

+27
-22
lines changed

1 file changed

+27
-22
lines changed

README.md

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,27 @@
1313

1414
<p align="center">
1515

16-
<a href="https://www.terraform.io">
17-
<img src="https://img.shields.io/badge/Terraform-v0.15-green" alt="Terraform">
16+
<a href="https://github.com/terraform-do-modules/terraform-digitalocean-certificate/releases/latest">
17+
<img src="https://img.shields.io/github/release/terraform-do-modules/terraform-digitalocean-certificate.svg" alt="Latest Release">
18+
</a>
19+
<a href="https://github.com/terraform-do-modules/terraform-digitalocean-certificate/actions/workflows/tfsec.yml">
20+
<img src="https://github.com/terraform-do-modules/terraform-digitalocean-certificate/actions/workflows/tfsec.yml/badge.svg" alt="tfsec">
1821
</a>
1922
<a href="LICENSE.md">
20-
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence">
23+
<img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
2124
</a>
2225

2326

2427
</p>
2528
<p align="center">
2629

27-
<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-digitalocean-ssl-certificate'>
30+
<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/terraform-do-modules/terraform-digitalocean-certificate'>
2831
<img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" />
2932
</a>
30-
<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+DigitalOcean+SSL+Certificate&url=https://github.com/clouddrove/terraform-digitalocean-ssl-certificate'>
33+
<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+DigitalOcean+SSL+Certificate&url=https://github.com/terraform-do-modules/terraform-digitalocean-certificate'>
3134
<img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" />
3235
</a>
33-
<a href='https://twitter.com/intent/tweet/?text=Terraform+DigitalOcean+SSL+Certificate&url=https://github.com/clouddrove/terraform-digitalocean-ssl-certificate'>
36+
<a href='https://twitter.com/intent/tweet/?text=Terraform+DigitalOcean+SSL+Certificate&url=https://github.com/terraform-do-modules/terraform-digitalocean-certificate'>
3437
<img title="Share on Twitter" src="https://user-images.githubusercontent.com/50652676/62817740-4c69db00-bb59-11e9-8a79-3580fbbf6d5c.png" />
3538
</a>
3639

@@ -44,6 +47,7 @@
4447
## Prerequisites
4548

4649
This module has a few dependencies:
50+
- [Terraform 1.5.4](https://learn.hashicorp.com/terraform/getting-started/install.html)
4751

4852

4953

@@ -52,29 +56,28 @@ This module has a few dependencies:
5256

5357

5458

55-
**IMPORTANT:** Since the `master` branch used in `source` varies based on new modifications, we suggest that you use the release versions [here](https://github.com/clouddrove/terraform-digitalocean-ssl-certificate/releases).
59+
**IMPORTANT:** Since the `master` branch used in `source` varies based on new modifications, we suggest that you use the release versions [here](https://github.com/terraform-do-modules/terraform-digitalocean-certificate/releases).
5660

5761

5862
Here are examples of how you can use this module in your inventory structure:
5963
### custom-certificate
6064
```hcl
6165
module "custom_certificate" {
62-
source = "clouddrove/certificate/digitalocean"
63-
version = "0.15.0"
66+
source = "terraform-do-modules/certificate/digitalocean"
67+
version = "1.0.0"
6468
certificate_name = "test"
65-
private_key = "./../../../_ssl/private_key.pem"
66-
leaf_certificate = "./../../../_ssl/star.crt"
67-
custom_certificate = true
69+
private_key = "./../../private_key.pem"
70+
leaf_certificate = "./../../cert.pem"
71+
certificate_chain = "./../../fullchain.pem"
6872
}
6973
```
7074
### lets-encrypt-certificate
7175
```hcl
7276
module "lets_encrypt_certificate" {
73-
source = "clouddrove/certificate/digitalocean"
74-
version = "0.15.0"
77+
source = "terraform-do-modules/certificate/digitalocean"
78+
version = "1.0.0"
7579
certificate_name = "test"
76-
domain_names = ["clouddrove.com"]
77-
lets_encrypt_certificate = true
80+
domain_names = ["clouddrove.ca"]
7881
}
7982
```
8083

@@ -89,12 +92,13 @@ Here are examples of how you can use this module in your inventory structure:
8992
|------|-------------|------|---------|:--------:|
9093
| certificate\_chain | Path of certificate chain. | `string` | `""` | no |
9194
| certificate\_name | The name of the certificate for identification. | `string` | `""` | no |
95+
| certificate\_type | The type of certificate to provision | `string` | `"lets_encrypt"` | no |
9296
| custom\_certificate | A boolean flag to enable/disable custom\_certificate. | `bool` | `false` | no |
93-
| domain\_names | List of fully qualified domain names (FQDNs) for which the certificate will be issued. The domains must be managed using DigitalOcean's DNS. Only valid when type is lets\_encrypt. | `list` | `[]` | no |
94-
| enable\_certificate | A boolean flag to enable/disable certificate. | `bool` | `true` | no |
95-
| leaf\_certificate | Path of certificate body. | `string` | `"~"` | no |
96-
| lets\_encrypt\_certificate | A boolean flag to enable/disable lets\_encrypt\_certificate. | `bool` | `false` | no |
97+
| domain\_names | List of fully qualified domain names (FQDNs) for which the certificate will be issued. The domains must be managed using DigitalOcean's DNS. Only valid when type is lets\_encrypt. | `list(any)` | `[]` | no |
98+
| enabled | Flag to control the resources creation. | `bool` | `true` | no |
99+
| leaf\_certificate | Path of certificate body. | `string` | `""` | no |
97100
| private\_key | Path of private key. | `string` | `""` | no |
101+
| type | The type of certificate to provision | `string` | `"custom"` | no |
98102

99103
## Outputs
100104

@@ -104,16 +108,17 @@ Here are examples of how you can use this module in your inventory structure:
104108
| name | The name of the certificate. |
105109
| not\_after | The expiration date of the certificate. |
106110
| sha1\_fingerprint | The SHA-1 fingerprint of the certificate. |
111+
| uuid | The UUID of the certificate |
107112

108113

109114

110115

111116

112117

113118
## Feedback
114-
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-digitalocean-ssl-certificate/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]).
119+
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/terraform-do-modules/terraform-digitalocean-certificate/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]).
115120

116-
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-digitalocean-ssl-certificate)!
121+
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/terraform-do-modules/terraform-digitalocean-certificate)!
117122

118123
## About us
119124

0 commit comments

Comments
 (0)