diff --git a/README.md b/README.md index 7086188..7985c10 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,20 @@ FileGator Header Auth Plugin ============================ -Auth extension to the JsonFile Auth +**`JsonFile` Auth extension using Headers to Authenticate Users** This code will allow you to authenticate via HTTP headers instead of a username/password. -It also has the ability to be configured to allow some users to authenticate via username/password, +An exclusion list can be given to let certain users fallback to the original authentication, such as an admin user. Setup Instructions ------------------ -Copy the `backend/Services/Auth/Adapters/Header.php` to the `$FILEGATOR_HOME`. There +Copy the `backend/Services/Auth/Adapters/Header.php` to +`$FILEGATOR_HOME/backend/Services/Auth/Adapters/Header.php`. There should be other files in that folder, including `JsonFile.php`, which `Header.php` extends. -You will also need to modify the `$FILEGATOR_HOME/configuration.php` file to point to the +You will also need to modify the `$FILEGATOR_HOME/configuration.php` file to point to **the** `Header.php` to facilitate the authentication: - Locate the `Filegator\Services\Auth\AuthInterface` section @@ -34,9 +35,9 @@ You will also need to modify the `$FILEGATOR_HOME/configuration.php` file to poi Properties ---------- -| Property | Description | -|---------------------|----------------------| -|`file` |Leave this as is, this is the same property that the `JsonFile` auth uses| -|`username_header_key`|HTTP Header Key that will contain the username value| -|`fullname_header_key`|HTTP Header Key that will contain the full name value| -|`ignore_users` |Array of usernames that should not use the header auth, but fallback to the JsonFile auth| +| Property | Description | +|---------------------|--------------------------------------------------------------------------| +|`file` |Leave this as is, this is the same property that the `JsonFile` auth uses | +|`username_header_key`|HTTP Header Key that will contain the username value | +|`fullname_header_key`|HTTP Header Key that will contain the full name value | +|`ignore_users` |Array of usernames that should fallback to `JsonFile` auth |