Skip to content

docs: Akamai getting started guide. #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jharshman merged 1 commit into from
Jan 24, 2026
Merged

docs: Akamai getting started guide. #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions docs/akamai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<todo>
```

Create and associate to the instance:
```bash
<todo>
# Keep this variable exported in your shells's rc file.
$ export LINODE_TOKEN="YOUR_LINODE_API_TOKEN"
$ fwsync init --provider linode
```
Comment thread
jharshman marked this conversation as resolved.

Whenever your ISP leases you a new IP, you can run `fwsync update` to seemlessly update your managed firewall rule.

28 changes: 7 additions & 21 deletions docs/google_cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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 <ZONE> \
--project <PROJECT> \
--machine-type <MACHINE_TYPE> \
--image-family <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 <NETWORK> \
--source-ranges <YOUR PUBLIC IP> \
--target-tags <my-dev-vm> \
--project <PROJECT>
$ fwsync init --provider google --project YOUR_PROJECT
Comment thread
jharshman marked this conversation as resolved.
```
Comment thread
jharshman marked this conversation as resolved.

> **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.

Loading