Skip to content

Commit

Permalink
code
Browse files Browse the repository at this point in the history
  • Loading branch information
opoplawski committed Jan 31, 2025
1 parent 20eab1f commit 07d43ee
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions GENERATING_MODULES.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ the pfsensible-generate-module script. The basic workflow is as follows:

* Navigate in the pfSense web interface to the area you want to write a module for. This should be a page where you can edit
settings or one where you are adding an item.
* Copy the URL of the page - you will pass it to the --url option of the script.
* Copy the URL of the page - you will pass it to the `--url` option of the script.

## Modules that manage multiple items

Expand All @@ -19,20 +19,20 @@ helpful to change as many options away from the default as possible. Focus on se

misc/pfsensible-generate-module --url URL

if you needed to use different names for the items than "item_min" and "item_full" you can set them with the --item-min and
--item-full options.
if you needed to use different names for the items than "item_min" and "item_full" you can set them with the `--item-min` and
`--item-full` options.

## Modules that configure something

If this is a module that will just configure something, add the --is-config option:
If this is a module that will just configure something, add the `--is-config` option:

misc/pfsensible-generate-module --url URL --is-config
misc/pfsensible-generate-module --url URL --is-config

## Other options

* Pass the --author-name, --author-email, and --author-handle options to give yourself credit!
* You will need to add the --user and/or --password options if you have changed from the install defaults.
* If the automatically determined module name does not seem correct, you can change it with the --module-name option.
* Pass the `--author-name`, `--author-email`, and `--author-handle` options to give yourself credit!
* You will need to add the `--user` and/or `--password` options if you have changed from the install defaults.
* If the automatically determined module name does not seem correct, you can change it with the `--module-name` option.
* It may make sense to create a module for different types of items if the parameters are wildly different (as is the case
with the different types of authentication servers for example). If so, add the --type-suffix option to add the "type"
with the different types of authentication servers for example). If so, add the `--type-suffix` option to add the "type"
of the item as a suffix to the module name.

0 comments on commit 07d43ee

Please sign in to comment.