Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Adding IP validation variable into readme.
  • Loading branch information
sarooghi authored Jun 10, 2022
1 parent 72da098 commit ea7b004
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ Installing the edge worker the first time requires uploading an archive file (TG
- **Section [QueueIT variables](#queueit-variables) describes queue-it variables in detail.**
- Step 7: In Akamai Property, create a behaviour for the URL/Hostname/Conditions where the edge worker will apply choose the name of EdgeWorker created in the upper section (make sure you are not executing edgeworker for static resources)
- [Step 8: Add a Site Failover behavior to retry if EdgeWorker fails](#adding-a-site-failover-behaviour)
- Step 9: Add integration config download criteria condition, behavior and cache if integration config download method is used.
- Step 10: Deploy the updated Akamai Property configuration
- [Step 9: Add a user varible PMUSER_TRUE_CLIENT_IP and a behaviour to set PMUSER_TRUE_CLIENT_IP variable to {{builtin.AK_CLIENT_REAL_IP}}](#adding-set-ip-behaviour)
- Step 10: Add integration config download criteria condition, behavior and cache if integration config download method is used.
- Step 11: Deploy the updated Akamai Property configuration

** https://learn.akamai.com/en-us/webhelp/edgeworkers/edgeworkers-user-guide/GUID-53F43F70-BEBC-4BA4-A2FB-3F23A6125106.html

Expand All @@ -37,6 +38,10 @@ First, create a PMUSER variable, with an arbitrary name, and set the value to %(
Then add a Site Failover behaviour that uses the PMUSER variable from above, and has the following settings:
![Site Failover Behaviour](https://github.com/queueit/KnownUser.V3.Akamai/blob/master/documentation/failover2.png)

## Adding Set IP behaviour
Connector might need to validate visitor IP, so you need to define a PMUSER variable with name PMUSER_TRUE_CLIENT_IP and add a behaviour to set the value for this by {{builtin.AK_CLIENT_REAL_IP}} expression.

![Visitor IP Behaviour](https://github.com/queueit/KnownUser.V3.Akamai/blob/master/documentation/setIpVariableBehaviour.png)
## QueueIT variables
To integrate with QueueIT Akamai connector it is required to define queueit variables in your Akamai property.
These variables should be named as 'PMUSER_QUEUEIT_CUSTOMERID', 'PMUSER_QUEUEIT_CONFIG_TYPE', 'PMUSER_QUEUEIT_SECRET_KEY', 'PMUSER_QUEUEIT_API_KEY'
Expand All @@ -48,10 +53,12 @@ and of type **Hidden** in Akamai property manager. The following table describes
| PMUSER_QUEUEIT_SECRET_KEY | Yes | Find your Secret key in the GO Queue-it Platform. |
| PMUSER_QUEUEIT_CONFIG_TYPE | Yes | 'inline' or 'cache' or 'edgekv' |
| PMUSER_QUEUEIT_API_KEY | If 'PMUSER_QUEUEIT_CONFIG_TYPE' is set to cache | Find your Api key in the GO Queue-it Platform. |
| PMUSER_TRUE_CLIENT_IP | Yes | If enabled at waitingroom, it is used to validate the vistor IP by connector |
| PMUSER_QUEUEIT_EXECUTED | For validation that the Queue-It EdgeWorker was executed | The Queue-It EdgeWorker will set the variable to `true`. This variable can be used in Akamai Property Manager to apply alternative logic if the EdgeWorker was not executed. |
| PMUSER_QUEUEIT_GENERATE_EQTOKEN| [Advanced enqueue token feature](#using-enqueueToken) | Optional boolean value ('true'/'false') where default is 'false'. |
| PMUSER_QUEUEIT_EQTOKEN_VALIDITY_TIME | No | Default: 240000 ms if provided value is null or less than 30000 ms |


## Advanced features

### Ignoring OPTIONS requests
Expand Down

0 comments on commit ea7b004

Please sign in to comment.