Skip to content

Commit

Permalink
Added run section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cschlesselmann committed Sep 21, 2019
1 parent beefdb6 commit 11236fd
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ ZoBo helps you bootstrap your VyOS Zone-Based Firewall through an easy config fi

## Running

### Docker
```sh
docker run --rm -it -v $(pwd)/zones.yaml:/app/zones.yaml ebrithil/zobo
```

### From Source

*Note*: You need to have the [Dotnet Core SDK](https://dotnet.microsoft.com/download) installed!

```sh
git clone https://github.com/Ebrithil95/zobo.git
cd zobo
dotnet restore
dotnet run
```

## Config Syntax

TODO

## Example
Expand Down Expand Up @@ -174,6 +192,10 @@ set firewall name 'mgmt-lan' rule 50 destination port 22
set zone-policy zone lan from mgmt firewall name mgmt-lan
```

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/Ebrithil95/zobo/tags).

## License

This project is licensed under the AGPLv3 License - see the [LICENSE](LICENSE) file for details.

0 comments on commit 11236fd

Please sign in to comment.