Skip to content

Commit

Permalink
Update Readme & Link to Terraform's registry (#12)
Browse files Browse the repository at this point in the history
* Update Readme & Link to Terraform's registry

* Update version
  • Loading branch information
adinhodovic authored May 9, 2021
1 parent f530c6e commit a399848
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 20 deletions.
23 changes: 5 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
Terraform module to create a responsive **Maintenance Page** using
Cloudflare Workers.

The module can be used through [Terraform's registry](https://registry.terraform.io/modules/adinhodovic/maintenance/cloudflare/latest).

## Preview

![Preview](https://i.imgur.com/CiguM4w.png)
Expand All @@ -20,28 +22,13 @@ TF_VAR_cloudflare_email=xxx
TF_VAR_cloudflare_api_key=xxx
TF_VAR_cloudflare_account_id=xxx
```
If using token, make sure it has all the necessary permissions

Simple maintenance page with your logo, fav icon, company name, font and email on a single route:

```terraform
module "hodovi_cc_maintenance" {
source = "git::git@github.com:adinhodovic/terraform-cloudflare-maintenance.git?ref=v0.3.0"
cloudflare_zone = "hodovi.cc"
patterns = ["hodovi.cc/maintenance/*"]
company_name = "HoneyLogic"
email = "support@honeylogic.io"
font = "Poppins"
logo_url = "https://s3.eu-west-1.amazonaws.com/honeylogic.io/media/images/Honeylogic-blue.original.png"
favicon_url = "https://s3.eu-west-1.amazonaws.com/honeylogic.io/media/images/Honeylogic_-_icon.original.height-80.png"
}
```
If using a token, make sure it has all the necessary permissions

Simple maintenance page with your logo, fav icon, company name, font and email with multiple routes on the same domain:

```terraform
module "hodovi_cc_maintenance" {
source = "git::git@github.com:adinhodovic/terraform-cloudflare-maintenance.git?ref=v0.3.0"
source = "git::git@github.com:adinhodovic/terraform-cloudflare-maintenance.git?ref=v0.4.0"
cloudflare_zone = "hodovi.cc"
patterns = ["hodovi.cc/maintenance/*", "hodovi.cc/example/*"]
company_name = "HoneyLogic"
Expand All @@ -57,7 +44,7 @@ maintenance starts/ends:

```terraform
module "hodovi_cc_maintenance" {
source = "git::git@github.com:adinhodovic/terraform-cloudflare-maintenance.git?ref=v0.3.0"
source = "git::git@github.com:adinhodovic/terraform-cloudflare-maintenance.git?ref=v0.4.0"
enabled = false
cloudflare_zone = "hodovi.cc"
patterns = ["hodovi.cc/maintenance/*"]
Expand Down
2 changes: 1 addition & 1 deletion examples/root-example/main.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module "hodovi_cc_maintenance" {
source = "git::git@github.com:adinhodovic/terraform-cloudflare-maintenance.git?ref=v0.3.0"
source = "git::git@github.com:adinhodovic/terraform-cloudflare-maintenance.git?ref=v0.4.0"
cloudflare_zone = "hodovi.cc"
patterns = ["hodovi.cc/maintenance/*", "hodovi.cc/example/*"]
company_name = "HoneyLogic"
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "terraform-cloudflare-maintenance",
"version": "0.3.0",
"version": "0.4.0",
"description": "Terraform module to create a responsive **Maintenance Page** using Cloudflare Workers.",
"main": "maintenance.js",
"directories": {
Expand Down

0 comments on commit a399848

Please sign in to comment.