-
Notifications
You must be signed in to change notification settings - Fork 0
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
Showing
1 changed file
with
25 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,25 @@ | ||
# fwsync | ||
|
||
![CI](https://github.com/jharshman/fwsync/actions/workflows/ci.yaml/badge.svg?branch=master) | ||
|
||
Provides CLI interface to update your personal Firewall Rules | ||
associated with your Cloud Development VM. | ||
|
||
## Installation | ||
|
||
TODO how to install | ||
|
||
## Usage | ||
|
||
### Init | ||
After installing, you can invoke the CLI by typing `fwsync` in your terminal. | ||
This by default will display some usage information. | ||
|
||
To initialize fwsync type `fwsync init`. This will walk you through steps in | ||
selecting the correct firewall to manage and will write out fwsync's config file | ||
which will be located at `$HOME/.bitly_firewall`. | ||
|
||
### Update | ||
If your IP updates and you notice you've lost access to your CloudVM, | ||
you can invoke `fwsync update` to automatically detect your new IP address | ||
and update your Firewall Rule. |