Skip to content

Commit

Permalink
Merge pull request #7 from jaredhendrickson13/v110
Browse files Browse the repository at this point in the history
v1.1.0 Features & Fixes
  • Loading branch information
jaredhendrickson13 authored Sep 19, 2021
2 parents 42f1fb5 + b472f21 commit de4e660
Show file tree
Hide file tree
Showing 14 changed files with 3,356 additions and 13 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: jaredhendrickson13
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,38 @@ must be enabled in System > SAML2 for this option to appear.</sub><br>
## Key Features
- Easily integrates SSO logins for pfSense without losing any existing authentication functionality.
- Automatically maps groups returned within the SAML2 assertion to groups within pfSense to inherit existing privileges.
No need to create locate users before authenticating.
No need to create local users before authenticating.
- Retains pfSense's built-in authentication and change logs.
- Adds the System > SAML2 settings page within the webConfigurator to make setup a breeze.

## Installation
To install, simply run the following command from the pfSense command line:<br>
`pkg add https://github.com/jaredhendrickson13/pfsense-saml2-auth/releases/latest/download/pfSense-2.5-pkg-saml2-auth.txz`
```
pkg add https://github.com/jaredhendrickson13/pfsense-saml2-auth/releases/latest/download/pfSense-2.5-pkg-saml2-auth.txz
```

To uninstall:<br>
`pkg delete pfSense-pkg-saml2-auth`
```
pkg delete pfSense-pkg-saml2-auth
```

_Note: when pfSense updates this package will be uninstalled. After updating pfSense, the package will need to be
_Note: when pfSense updates, this package will be uninstalled. After updating pfSense, the package will need to be
reinstalled to match the updated version_

## Supported Versions
Currently, the package fully supports the following pfSense versions including patched versions of the same release:

<details>
<summary>List of Supported pfSense Releases</summary>

- pfSense 2.5.2-RELEASE
- pfSense 2.5.1-RELEASE
- pfSense 2.5.0-RELEASE
- pfSense 2.4.5-RELEASE
- pfSense 2.4.4-RELEASE

</details>

Any version not listed is technically unsupported, but may still function. Proceed with caution.

## Setup
Expand Down
Loading

0 comments on commit de4e660

Please sign in to comment.