diff --git a/docs/akamai.md b/docs/akamai.md index 3e40354..fae921d 100644 --- a/docs/akamai.md +++ b/docs/akamai.md @@ -4,18 +4,23 @@ Protect your VM on Akamai. Create and associate a Firewall Policy with a new or existing Linode Instance and manage its allowed IPv4 Addresses with fwsync. +## Prerequisites +1. Linode account +1. API Key +1. Linode Instance +1. Firewall Rule associated with running Instance + ## Authentication To authenticate with Linode, login to your account and create and copy a new API Key. Set the `LINODE_TOKEN` environment variable for your shell. ## Quick Start -Create a Linode instance or use an existing instance: -```bash - ``` - -Create and associate to the instance: -```bash - +# Keep this variable exported in your shells's rc file. +$ export LINODE_TOKEN="YOUR_LINODE_API_TOKEN" +$ fwsync init --provider linode ``` + +Whenever your ISP leases you a new IP, you can run `fwsync update` to seemlessly update your managed firewall rule. + diff --git a/docs/google_cloud.md b/docs/google_cloud.md index abaf5f0..aa4c98c 100644 --- a/docs/google_cloud.md +++ b/docs/google_cloud.md @@ -4,6 +4,11 @@ Protect your VM with a Google Cloud Firewall Rule. Create and associate a Firewall Policy with a new or existing Google Cloud Instance and manage its allowed IPv4 Addresses with fwsync. +## Prerequisites +1. GCP account +1. VM Instance +1. Firewall Rule associated with running Instance + ## Authentication The recommended method of authentication is to run the following command: @@ -13,28 +18,9 @@ $ gcloud auth application-default login ## Quick Start -Create an instance or use an existing instance: -```bash -gcloud compute instances create my-dev-vm \ - --zone \ - --project \ - --machine-type \ - --image-family \ - --tags my-dev-vm ``` - -Create and associate to the instance: -```bash -$ gcloud compute firewall-rules create allow-dev-vm \ - --allow TCP \ - --direction INGRESS \ - --network \ - --source-ranges \ - --target-tags \ - --project +$ fwsync init --provider google --project YOUR_PROJECT ``` -> **Important:** Instance association is done via Instance Tag and Target Tag. -The Target Tag on the Firewall must match one of the defined Tags -on the Instance. +Whenever your ISP leases you a new IP, you can run `fwsync update` to seemlessly update your managed firewall rule.