You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,12 +31,12 @@ For the fuller explanation, use the [visual field guide](docs/visual-field-guide
31
31
32
32
For the first real run:
33
33
34
-
1. Download `ShareSurfer-0.1.0-pre.33.zip` and its SHA256 file from the [current prerelease](https://github.com/jonathanweinberg/ShareSurfer/releases/tag/v0.1.0-pre.33). If that tag is not visible, use the latest published prerelease and substitute its version in the paths below.
35
-
2. Extract to `C:\` so the release root is `C:\ShareSurfer-0.1.0-pre.33\`.
34
+
1. Download `ShareSurfer-0.1.0-pre.34.zip` and its SHA256 file from the [current prerelease](https://github.com/jonathanweinberg/ShareSurfer/releases/tag/v0.1.0-pre.34). If that tag is not visible, use the latest published prerelease and substitute its version in the paths below.
35
+
2. Extract to `C:\` so the release root is `C:\ShareSurfer-0.1.0-pre.34\`.
@@ -232,7 +232,7 @@ Current screenshots are under [docs/visuals/dashboard-screenshots/2026-06-09-cur
232
232
233
233
## Pre-1.0 Release Packaging
234
234
235
-
The first packages are unsigned but fully built. `v0.1.0-pre.33` includes the module, scripts, docs, SHA256 files, release manifest, dependency-age report, and prebuilt dashboard template assets. The manifest records `UnsignedPre1.0`.
235
+
The first packages are unsigned but fully built. `v0.1.0-pre.34` includes the module, scripts, docs, SHA256 files, release manifest, dependency-age report, and prebuilt dashboard template assets. The manifest records `UnsignedPre1.0`.
236
236
237
237
Release identity lives in [release-metadata.json](release-metadata.json). Update that file first when preparing a prerelease; packaging fails closed when the manual version or tag does not match.
Copy file name to clipboardExpand all lines: docs/admin-ownership-import.md
+20-3Lines changed: 20 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -133,10 +133,10 @@ Enriched rows can add these review fields:
133
133
134
134
## Step 1: Test The CSV
135
135
136
-
If `v0.1.0-pre.33` is not visible yet on the [ShareSurfer Releases page](https://github.com/jonathanweinberg/ShareSurfer/releases), use the latest published prerelease and substitute that version in `$releaseRoot`.
136
+
If `v0.1.0-pre.34` is not visible yet on the [ShareSurfer Releases page](https://github.com/jonathanweinberg/ShareSurfer/releases), use the latest published prerelease and substitute that version in `$releaseRoot`.
Press Enter to accept a suggested header, type another header name when you know it, press `S` to deliberately leave that ShareSurfer field blank, or press `B` to go back and fix the previous field. If there is no confident suggestion and the source has fewer than 10 headers, pressing Enter opens a small selector so you can choose the right header with arrow keys where the console supports them, or by number in simpler hosts.
In the picker, use the numbered folder and file choices to move around and toggle CSVs. The menu also lets you select all CSVs in the current folder, clear selected paths, show selected paths, go up to the parent folder, finish, or quit.
259
265
266
+
After you choose source CSV files, interactive ownership enrichment asks what each file mostly describes and how much trust to place in it. The prompts use the same `Enter`, `S`, `B`, `?`, and `Q` controls where they apply. Source type choices are written in business terms:
267
+
268
+
-`Identity`: people or accounts, usually HR or directory-aligned employee data.
269
+
-`ObsContext`: OBS/OID, business-unit, or owner clues.
270
+
-`ProjectContext`: projects, programs, apps, or WBS codes linked to OBS or owners.
271
+
-`PathOwnership`: share, folder, UNC, or path-prefix ownership clues.
272
+
-`GroupContext`: security groups linked to owners, OBS, projects, or business units.
273
+
-`Mixed`: several kinds of clues or a file whose purpose is not cleanly separated.
274
+
275
+
Authority choices tell reviewers how strongly to trust the file: `Authoritative` means a trusted source of record, `ReviewerHint` means useful but review-needed, `ContextOnly` means grouping context only, and `Unknown` means the trust level is unclear. `B` lets you return to an earlier source-classification prompt before the definition JSON is saved.
276
+
260
277
If you already know the exact files, you can still pass them directly:
Copy file name to clipboardExpand all lines: docs/command-recipes.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,10 @@ This page collects the most common first-run commands in one place. Use it when
5
5
The examples assume the current quickstart release is unpacked here:
6
6
7
7
```text
8
-
C:\ShareSurfer-0.1.0-pre.33\
8
+
C:\ShareSurfer-0.1.0-pre.34\
9
9
```
10
10
11
-
If `v0.1.0-pre.33` is not visible yet on the [ShareSurfer Releases page](https://github.com/jonathanweinberg/ShareSurfer/releases), use the latest published prerelease and substitute that version in every `ShareSurfer-0.1.0-pre.33` path and ZIP name below. The commands also assume Windows PowerShell 5.1 unless a command explicitly says otherwise.
11
+
If `v0.1.0-pre.34` is not visible yet on the [ShareSurfer Releases page](https://github.com/jonathanweinberg/ShareSurfer/releases), use the latest published prerelease and substitute that version in every `ShareSurfer-0.1.0-pre.34` path and ZIP name below. The commands also assume Windows PowerShell 5.1 unless a command explicitly says otherwise.
12
12
13
13
## Start Here
14
14
@@ -49,11 +49,11 @@ If `v0.1.0-pre.33` is not visible yet on the [ShareSurfer Releases page](https:/
49
49
50
50
## Recipe 1: Unpack and Import the Release
51
51
52
-
Use this on the Windows collector host after downloading `ShareSurfer-0.1.0-pre.33.zip` from the GitHub release on an approved connected workstation. If that checkpoint ZIP is not published yet, download the latest published prerelease ZIP and update `$releaseZip` and `$releaseRoot` to match it.
52
+
Use this on the Windows collector host after downloading `ShareSurfer-0.1.0-pre.34.zip` from the GitHub release on an approved connected workstation. If that checkpoint ZIP is not published yet, download the latest published prerelease ZIP and update `$releaseZip` and `$releaseRoot` to match it.
@@ -71,7 +71,7 @@ The `Unblock-File` line clears the Windows downloaded-file block from ShareSurfe
71
71
72
72
Run that manual unblock first for the no-prompt path. If you start `Start-ShareSurfer.ps1` before unblocking, Windows may still ask once for the launcher itself; after you choose **Run once**, the launcher attempts the same recursive unblock before importing ShareSurfer.
73
73
74
-
Both `Test-Path` commands should return `True`. If either returns `False`, check for a doubled folder such as `C:\ShareSurfer-0.1.0-pre.33\ShareSurfer-0.1.0-pre.33`.
74
+
Both `Test-Path` commands should return `True`. If either returns `False`, check for a doubled folder such as `C:\ShareSurfer-0.1.0-pre.34\ShareSurfer-0.1.0-pre.34`.
75
75
76
76
## Recipe 1A: Generate a Guided Startup Plan
77
77
@@ -84,7 +84,7 @@ If `ownership-enrichment.csv` is missing, interactive startup can offer to launc
@@ -206,12 +206,12 @@ This recipe creates three reusable files:
206
206
-`normalized-ownership.csv`: canonical ownership rows for review.
207
207
-`ownership-import-rerun.ps1`: reusable commands to retest the source and regenerate the normalized CSV without repeating the header interview.
208
208
209
-
If you need ShareSurfer to ask you about each header in the console, add `-Interactive` to `New-ShareSurferOwnershipMappingProfile`. The saved rerun file still uses the profile afterward.
209
+
If you need ShareSurfer to ask you about each header in the console, add `-Interactive` to `New-ShareSurferOwnershipMappingProfile`. The saved rerun file still uses the profile afterward. Interactive prompts show `Enter=accept/select | S=skip | B=back | ?=help | Q=quit`; use `B` to fix the previous field, `S` to intentionally leave a ShareSurfer field blank, and `?` for a reminder. When there is no suggestion and the source has fewer than 10 headers, Enter opens a small selector with arrow-key support where available and numbered fallback everywhere else.
210
210
211
211
To gather AD data from an HR or OBS file before scanning, create an enrichment CSV. ShareSurfer uses employee ID or employee number values from the source CSV to look up matching AD accounts when `-AdLookupMode Auto` or `ActiveDirectory` can read the directory. It fills available account, mail, title, office, manager, and OBS fields, then writes a local CSV that travels with the scan evidence.
@@ -379,7 +379,7 @@ When `NetShareGetInfo` returns a path like `C:\Public\Share` for a remote target
379
379
Use this when ShareSurfer can reach a share but `share_permissions.csv` is empty, `shares.csv` says `PartialData=True`, or `collection_errors.csv` shows share-permission or native security descriptor failures. This goes past "is the port open" and records each share-permission proof attempt.
@@ -430,7 +430,7 @@ Before owner signoff, open `evidence_confidence.csv` or the dashboard Scan Confi
430
430
Use this after a scan has produced `owner_review_packets.csv` and `related_data_areas.csv`. The draft files are plain CSVs that can be edited in Excel, reviewed in a meeting, and imported back into the export folder before rebuilding the report or standalone dashboard.
Copy file name to clipboardExpand all lines: docs/first-run-guide.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,8 @@ If report or command terms are unfamiliar, keep the [glossary](glossary.md) open
8
8
9
9
For a first useful scan:
10
10
11
-
1. Extract the current `v0.1.0-pre.33` release ZIP to `C:\`. If that checkpoint tag is not visible on the [ShareSurfer Releases page](https://github.com/jonathanweinberg/ShareSurfer/releases) yet, use the latest published prerelease and substitute that version in the paths below.
12
-
2. Use `C:\ShareSurfer-0.1.0-pre.33\` as `$releaseRoot`, or replace the version folder with the published prerelease you actually extracted.
11
+
1. Extract the current `v0.1.0-pre.34` release ZIP to `C:\`. If that checkpoint tag is not visible on the [ShareSurfer Releases page](https://github.com/jonathanweinberg/ShareSurfer/releases) yet, use the latest published prerelease and substitute that version in the paths below.
12
+
2. Use `C:\ShareSurfer-0.1.0-pre.34\` as `$releaseRoot`, or replace the version folder with the published prerelease you actually extracted.
13
13
3. Run the recursive `Unblock-File` command in Step 1 before importing the module.
14
14
4. Pick one known share and the correct `-ObsAttribute`.
15
15
5. Recommended: run `Start-ShareSurfer.ps1` or `Start-ShareSurferStartup` to generate a reusable first-run JSON config, plan, and rerun script.
@@ -92,17 +92,17 @@ $PSVersionTable.PSVersion
92
92
93
93
The major version should be `5`.
94
94
95
-
If you are using the `v0.1.0-pre.33` release ZIP, extract it to `C:\`. If that checkpoint tag is not visible yet, use the latest published prerelease and substitute that version in the paths below. The extracted release root should be:
95
+
If you are using the `v0.1.0-pre.34` release ZIP, extract it to `C:\`. If that checkpoint tag is not visible yet, use the latest published prerelease and substitute that version in the paths below. The extracted release root should be:
96
96
97
97
```text
98
-
C:\ShareSurfer-0.1.0-pre.33\
98
+
C:\ShareSurfer-0.1.0-pre.34\
99
99
```
100
100
101
-
If Windows Explorer suggests extracting to `C:\ShareSurfer-0.1.0-pre.33`, change the destination to `C:\` so you do not end up with a doubled nested folder. From PowerShell:
101
+
If Windows Explorer suggests extracting to `C:\ShareSurfer-0.1.0-pre.34`, change the destination to `C:\` so you do not end up with a doubled nested folder. From PowerShell:
@@ -716,12 +716,12 @@ For the longer version, see the [nonpermissive collector to dashboard host workf
716
716
717
717
## Optional: Generate the Standalone Dashboard
718
718
719
-
The legacy `report.html` remains the safest default report because it is generated directly by the PowerShell module. The v0.1.0-pre.33 release package from the [ShareSurfer Releases page](https://github.com/jonathanweinberg/ShareSurfer/releases), or the latest published prerelease while waiting for that checkpoint tag to appear, also includes prebuilt standalone dashboard template assets for richer novice-admin and business-owner review.
719
+
The legacy `report.html` remains the safest default report because it is generated directly by the PowerShell module. The v0.1.0-pre.34 release package from the [ShareSurfer Releases page](https://github.com/jonathanweinberg/ShareSurfer/releases), or the latest published prerelease while waiting for that checkpoint tag to appear, also includes prebuilt standalone dashboard template assets for richer novice-admin and business-owner review.
720
720
721
721
If you are using the release ZIP, you do not need Node, npm, Vite, a development server, or internet access to package the dashboard. Run the packager from Windows PowerShell 5.1 and point it at the extracted release root:
0 commit comments