Skip to content

Commit 141629f

Browse files
author
Simon Kowallik
committed
doc: updated readme
1 parent 1c94d74 commit 141629f

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,15 @@
33
[![Test Build](https://github.com/simonkowallik/irulescan/actions/workflows/test.yaml/badge.svg)](https://github.com/simonkowallik/irulescan/actions/workflows/test.yaml)
44
![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/simonkowallik/irulescan)
55

6-
7-
`irulescan` is a tool to scan iRules for unexpected/unsafe expressions that may have undesirable effects like double substitution.
6+
`irulescan` is a tool to scan iRules for unexpected/unsafe expressions that may have undesirable effects like double substitution. It is available as a Github Action [`irulescan-action`](https://github.com/marketplace/actions/irules-security-scan).
87

98
`irulescan` would not exist without [tclscan](https://github.com/aidanhs/tclscan).
109

1110
## Usage
1211

13-
It is easiest to use the irulescan container to scan any irules.
12+
It is easiest to use the irulescan container to scan your irules.
1413

15-
By default the container will scan any `.tcl` and `.irule` file within the `/scandir` folder of the container.
14+
The container will scan any `.tcl` and `.irule` file within the `/scandir` folder of the container and return the result in YAML format.
1615

1716
Here is an example:
1817

@@ -44,4 +43,21 @@ Invoking irulescan directly:
4443

4544
```sh
4645
docker run -it --rm simonkowallik/irulescan irulescan
47-
```
46+
```
47+
48+
The container ships with a simple shell script, `scandir.sh`, which can be invoked directly.
49+
This is especially useful when using a CI system with custom mount points (eg. `/my/custom/path`), here is an example:
50+
51+
```sh
52+
docker run -it --rm simonkowallik/irulescan /scandir.sh /my/custom/path
53+
```
54+
55+
## Additional resources
56+
57+
For safer authoring the VS Code iRules Extension is highly recommended:
58+
59+
- [F5 Networks iRules by bitwisecook](https://marketplace.visualstudio.com/items?itemName=bitwisecook.iRule) [on github](https://github.com/bitwisecook/vscode-iRule)
60+
61+
- [Avoiding Common iRules Security Pitfalls on F5 DevCentral](https://community.f5.com/t5/technical-articles/avoiding-common-irules-security-pitfalls/ta-p/306623)
62+
63+
- [iRules Style Guide on F5 DevCentral](https://community.f5.com/t5/technical-articles/irules-style-guide/ta-p/305921)

0 commit comments

Comments
 (0)