Skip to content

Commit cdcc1d2

Browse files
author
Bob Pokorny
committed
Merge branch '81018-Adding_JEA_Support' of https://github.com/Keyfactor/iis-orchestrator into 81018-Adding_JEA_Support
2 parents aa8d504 + 6395a23 commit cdcc1d2

1 file changed

Lines changed: 40 additions & 5 deletions

File tree

README.md

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -239,15 +239,32 @@ You should see entries for each module you installed.
239239

240240
---
241241

242-
#### Step 3: Create the Audit Transcript Directory
242+
#### Step 3: (Optional) Create the Audit Transcript Directory
243243

244-
JEA records a full transcript of every session for audit purposes. The transcript directory must exist before you register the session configuration.
244+
Transcript logging is **disabled by default** in the session configuration file. When enabled, JEA records a full transcript of every session — every function called, with its parameters and output — to a directory on the target server. This is highly recommended while you are first testing the JEA setup, and may be required by your organization's security policy in production.
245+
246+
To enable transcription, you must do two things: create the directory (this step), and uncomment the `TranscriptDirectory` line in the `.pssc` file (covered in Step 4).
245247

246248
```powershell
247249
New-Item -ItemType Directory -Path 'C:\ProgramData\Keyfactor\JEA\Transcripts' -Force
248250
```
249251

250-
Transcripts are written here automatically for every connection made through the JEA endpoint. Review these files periodically to audit orchestrator activity. Each transcript file is named with the date, time, and a unique identifier so that sessions are never overwritten.
252+
Each transcript file is named with the date, time, and a unique identifier so sessions are never overwritten. To review recent transcripts:
253+
254+
```powershell
255+
# List the 10 most recent transcript files
256+
Get-ChildItem 'C:\ProgramData\Keyfactor\JEA\Transcripts\' |
257+
Sort-Object LastWriteTime -Descending |
258+
Select-Object -First 10
259+
260+
# View the most recent transcript
261+
Get-ChildItem 'C:\ProgramData\Keyfactor\JEA\Transcripts\' |
262+
Sort-Object LastWriteTime -Descending |
263+
Select-Object -First 1 |
264+
Get-Content
265+
```
266+
267+
If you choose not to enable transcript logging, skip this step entirely — no directory is needed when `TranscriptDirectory` remains commented out in the `.pssc`.
251268

252269
---
253270

@@ -308,6 +325,24 @@ Only list the `RoleCapabilities` whose corresponding modules are installed on th
308325
| WinSQL only or WinCert + WinSQL | `'Keyfactor.WinCert.Common', 'Keyfactor.WinCert.SQL'` |
309326
| WinCert + WinIIS + WinSQL | `'Keyfactor.WinCert.Common', 'Keyfactor.WinCert.IIS', 'Keyfactor.WinCert.SQL'` |
310327

328+
**Transcript Logging (Optional):**
329+
330+
The `TranscriptDirectory` setting in the `.pssc` file is **commented out by default**. When commented out, no transcript files are written and the directory created in Step 3 is not needed. This is a reasonable choice for production environments where the volume of orchestrator activity would generate a large number of transcript files, or where audit logging is handled by another mechanism (e.g., WinRM event logs or a SIEM).
331+
332+
To enable transcript logging, locate the `TranscriptDirectory` line in the `.pssc` file and remove the `#` comment character:
333+
334+
```powershell
335+
# Before (transcription disabled — default):
336+
# TranscriptDirectory = 'C:\ProgramData\Keyfactor\JEA\Transcripts'
337+
338+
# After (transcription enabled):
339+
TranscriptDirectory = 'C:\ProgramData\Keyfactor\JEA\Transcripts'
340+
```
341+
342+
> **Recommendation:** Enable transcript logging during initial setup and testing. It makes it easy to confirm that the orchestrator is calling the correct functions with the correct parameters, and to diagnose any unexpected failures. Once you are confident the configuration is working correctly in production, you may choose to disable it to reduce disk usage — or keep it enabled to satisfy your organization's audit requirements.
343+
344+
> **Important:** If you enable `TranscriptDirectory`, you must also create the directory before registering the session configuration (Step 3). If the directory does not exist at registration time, `Register-PSSessionConfiguration` will fail.
345+
311346
---
312347

313348
#### Step 5: Register the JEA Session Configuration
@@ -443,9 +478,9 @@ This typically indicates a WinRM connectivity issue rather than a JEA-specific p
443478

444479
A **JEA Endpoint Name** was entered in the certificate store but the **Client Machine** is set to `localhost`, `LocalMachine`, or uses the `|LocalMachine` suffix. JEA is not compatible with local-machine (agent) mode. Either remove the JEA endpoint name to use direct local access, or change the Client Machine to the server's actual hostname or IP address to use JEA over WinRM.
445480

446-
**Reviewing JEA Transcripts**
481+
**Reviewing JEA Transcripts (if transcript logging is enabled)**
447482

448-
All JEA sessions are transcribed to `C:\ProgramData\Keyfactor\JEA\Transcripts\` on the target server. Each transcript file records the session start time, the connecting user, all commands executed (including parameter values), and the session end time. These files are invaluable for diagnosing job failures and for security audits.
483+
If `TranscriptDirectory` is uncommented in the `.pssc` file, JEA writes a full transcript of every session to that directory on the target server. Each transcript file records the session start time, the connecting user, all commands executed (including parameter values), and the session end time. These files are invaluable for diagnosing job failures and for security audits. See Steps 3 and 4 for instructions on enabling this feature.
449484

450485
```powershell
451486
# List recent transcript files

0 commit comments

Comments
 (0)