Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 3, 2024
1 parent e3d3819 commit 487236f
Show file tree
Hide file tree
Showing 15 changed files with 158 additions and 102 deletions.
16 changes: 10 additions & 6 deletions Content/MessagesFromSandboxie.html
Original file line number Diff line number Diff line change
Expand Up @@ -887,9 +887,11 @@ <h2 id="log-messages-to-a-file">Log Messages To A File</h2>
<p>It's possible to log <em>Messages From Sandboxie</em> to a file with a simple configuration inside the registry:</p>
<pre><code class="language-cmd">reg.exe add &quot;HKLM\SYSTEM\CurrentControlSet\Services\SbieSvc&quot; /t REG_SZ /v LogFile /d &quot;2;C:\Windows\System32\LogFiles\Sandboxie.log&quot; /f
</code></pre>
<p>The <code>LogFile</code> value consists of two pieces of information:
- <code>2</code> is the log level. Only two values are correct: <code>2</code> (classic log) or <code>3</code> (log with process SID)
- <code>C:\Windows\System32\LogFiles\Sandboxie.log</code> is the full path of the log</p>
<p>The <code>LogFile</code> value consists of two pieces of information:</p>
<ul>
<li><code>2</code> is the log level. Only two values are correct: <code>2</code> (classic log) or <code>3</code> (log with process SID)</li>
<li><code>C:\Windows\System32\LogFiles\Sandboxie.log</code> is the full path of the log</li>
</ul>
<p>Example of output for a log level of 2:</p>
<pre><code>2022-09-02 01:04:18 SBIE1308 Program cannot start due to restrictions - powershell.exe [ChromeBox]
2022-09-02 01:04:18 SBIE1308 Program cannot start due to restrictions - powershell.exe [ChromeBox]
Expand All @@ -905,9 +907,11 @@ <h2 id="log-messages-to-a-file">Log Messages To A File</h2>
<pre><code class="language-cmd">reg.exe add &quot;HKLM\SYSTEM\CurrentControlSet\Services\SbieSvc&quot; /t REG_SZ /v LogFile /d &quot;2;C:\Windows\System32\LogFiles\Sandboxie.log&quot; /f
reg.exe add &quot;HKLM\SYSTEM\CurrentControlSet\Services\SbieSvc&quot; /t REG_SZ /v MultiLog /d &quot;1308,1307&quot; /f
</code></pre>
<p>This simple configuration will:
- put all logs without filter inside <code>C:\Windows\System32\LogFiles\Sandboxie.log</code>
- create <em>one file per box</em> (ie: <code>C:\Windows\System32\LogFiles\Sandboxie_DefaultBox.log</code>) with only event 1308 and 1307</p>
<p>This simple configuration will:</p>
<ul>
<li>put all logs without filter inside <code>C:\Windows\System32\LogFiles\Sandboxie.log</code></li>
<li>create <em>one file per box</em> (ie: <code>C:\Windows\System32\LogFiles\Sandboxie_DefaultBox.log</code>) with only event 1308 and 1307</li>
</ul>

</div>
</div><footer>
Expand Down
16 changes: 10 additions & 6 deletions Content/MessagesFromSandboxie/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -887,9 +887,11 @@ <h2 id="log-messages-to-a-file">Log Messages To A File</h2>
<p>It's possible to log <em>Messages From Sandboxie</em> to a file with a simple configuration inside the registry:</p>
<pre><code class="language-cmd">reg.exe add &quot;HKLM\SYSTEM\CurrentControlSet\Services\SbieSvc&quot; /t REG_SZ /v LogFile /d &quot;2;C:\Windows\System32\LogFiles\Sandboxie.log&quot; /f
</code></pre>
<p>The <code>LogFile</code> value consists of two pieces of information:
- <code>2</code> is the log level. Only two values are correct: <code>2</code> (classic log) or <code>3</code> (log with process SID)
- <code>C:\Windows\System32\LogFiles\Sandboxie.log</code> is the full path of the log</p>
<p>The <code>LogFile</code> value consists of two pieces of information:</p>
<ul>
<li><code>2</code> is the log level. Only two values are correct: <code>2</code> (classic log) or <code>3</code> (log with process SID)</li>
<li><code>C:\Windows\System32\LogFiles\Sandboxie.log</code> is the full path of the log</li>
</ul>
<p>Example of output for a log level of 2:</p>
<pre><code>2022-09-02 01:04:18 SBIE1308 Program cannot start due to restrictions - powershell.exe [ChromeBox]
2022-09-02 01:04:18 SBIE1308 Program cannot start due to restrictions - powershell.exe [ChromeBox]
Expand All @@ -905,9 +907,11 @@ <h2 id="log-messages-to-a-file">Log Messages To A File</h2>
<pre><code class="language-cmd">reg.exe add &quot;HKLM\SYSTEM\CurrentControlSet\Services\SbieSvc&quot; /t REG_SZ /v LogFile /d &quot;2;C:\Windows\System32\LogFiles\Sandboxie.log&quot; /f
reg.exe add &quot;HKLM\SYSTEM\CurrentControlSet\Services\SbieSvc&quot; /t REG_SZ /v MultiLog /d &quot;1308,1307&quot; /f
</code></pre>
<p>This simple configuration will:
- put all logs without filter inside <code>C:\Windows\System32\LogFiles\Sandboxie.log</code>
- create <em>one file per box</em> (ie: <code>C:\Windows\System32\LogFiles\Sandboxie_DefaultBox.log</code>) with only event 1308 and 1307</p>
<p>This simple configuration will:</p>
<ul>
<li>put all logs without filter inside <code>C:\Windows\System32\LogFiles\Sandboxie.log</code></li>
<li>create <em>one file per box</em> (ie: <code>C:\Windows\System32\LogFiles\Sandboxie_DefaultBox.log</code>) with only event 1308 and 1307</li>
</ul>

</div>
</div><footer>
Expand Down
40 changes: 23 additions & 17 deletions PlusContent/BoxSnapshots.html
Original file line number Diff line number Diff line change
Expand Up @@ -885,25 +885,31 @@ <h1 id="box-snapshots-for-sandboxie-plus">Box Snapshots (for Sandboxie Plus)</h1
<p><img alt="" src="../Media/Box_Snapshot2.png" /></p>
<p><strong>Caveat:</strong> Snapshots must be created with box AutoDelete disabled. To do so, open the Sandman GUI and double-click on the desired box to bring up the box options window. Then, click on 'File Options' and, under 'Box Delete Options', uncheck the option to AutoDelete content, and press OK (bottom right) to apply any changes. See image below.</p>
<p><img alt="" src="../Media/Box_AutoDelete.png" /></p>
<p><strong>Installing Software to a Box and Creating a Snapshot:</strong>
- Select a box, disable AutoDelete, install the software to this box, set it up just the way you like.
- Then, close the box, create a snapshot and enable box AutoDelete.
- Now, this box will revert to the snapshot you created whenever it is closed.</p>
<p><strong>Updating Software Installed to a Box:</strong>
- Create a pre-update snapshot (for a baseline you can revert to, if need be).
- Disable box AutoDelete, update the software and test.
- If all is well, create a post-update snapshot, enable box AutoDelete.
- This automatically makes the last (post-update) snapshot the default.
- If there are problems, you can revert to the pre-update snapshot.
- You can always revert to any of the snapshots that you create for a box!</p>
<p><strong>Installing Software to a Box and Creating a Snapshot:</strong></p>
<ul>
<li>Select a box, disable AutoDelete, install the software to this box, set it up just the way you like.</li>
<li>Then, close the box, create a snapshot and enable box AutoDelete.</li>
<li>Now, this box will revert to the snapshot you created whenever it is closed.</li>
</ul>
<p><strong>Updating Software Installed to a Box:</strong></p>
<ul>
<li>Create a pre-update snapshot (for a baseline you can revert to, if need be).</li>
<li>Disable box AutoDelete, update the software and test.</li>
<li>If all is well, create a post-update snapshot, enable box AutoDelete.</li>
<li>This automatically makes the last (post-update) snapshot the default.</li>
<li>If there are problems, you can revert to the pre-update snapshot.</li>
<li>You can always revert to any of the snapshots that you create for a box!</li>
</ul>
<p>You have the ability to create a snapshot, remove a snapshot, revert to a snapshot or (starting with <strong>Sandboxie Plus v1.0.9</strong>) revert to an empty box while retaining all snapshots.</p>
<p><strong>Caveat:</strong> It is wise to use the snapshot features only for boxes whose location is on a real disk (and not on a ramdisk).</p>
<p><strong>Additional Details:</strong>
- Each snapshot is created its own folder, labeled snapshot-n, where the number n is the snapshot id. You can change this label.
- All snapshot folders for a given box are inside the box folder.
- The snapshot layout and information on the current (default) snapshot are saved in the file <strong>snapshot.ini</strong> in the box folder.
- The <strong>File-System</strong> snapshots are incremental. Files are duplicated only when changed (just as with real files on the host).
- The <strong>Registry</strong> snapshots are NOT incremental. Each snapshot has a full copy and only the most recent reg hive file is used.</p>
<p><strong>Additional Details:</strong></p>
<ul>
<li>Each snapshot is created its own folder, labeled snapshot-n, where the number n is the snapshot id. You can change this label.</li>
<li>All snapshot folders for a given box are inside the box folder.</li>
<li>The snapshot layout and information on the current (default) snapshot are saved in the file <strong>snapshot.ini</strong> in the box folder.</li>
<li>The <strong>File-System</strong> snapshots are incremental. Files are duplicated only when changed (just as with real files on the host).</li>
<li>The <strong>Registry</strong> snapshots are NOT incremental. Each snapshot has a full copy and only the most recent reg hive file is used.</li>
</ul>

</div>
</div><footer>
Expand Down
40 changes: 23 additions & 17 deletions PlusContent/BoxSnapshots/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -885,25 +885,31 @@ <h1 id="box-snapshots-for-sandboxie-plus">Box Snapshots (for Sandboxie Plus)</h1
<p><img alt="" src="../../Media/Box_Snapshot2.png" /></p>
<p><strong>Caveat:</strong> Snapshots must be created with box AutoDelete disabled. To do so, open the Sandman GUI and double-click on the desired box to bring up the box options window. Then, click on 'File Options' and, under 'Box Delete Options', uncheck the option to AutoDelete content, and press OK (bottom right) to apply any changes. See image below.</p>
<p><img alt="" src="../../Media/Box_AutoDelete.png" /></p>
<p><strong>Installing Software to a Box and Creating a Snapshot:</strong>
- Select a box, disable AutoDelete, install the software to this box, set it up just the way you like.
- Then, close the box, create a snapshot and enable box AutoDelete.
- Now, this box will revert to the snapshot you created whenever it is closed.</p>
<p><strong>Updating Software Installed to a Box:</strong>
- Create a pre-update snapshot (for a baseline you can revert to, if need be).
- Disable box AutoDelete, update the software and test.
- If all is well, create a post-update snapshot, enable box AutoDelete.
- This automatically makes the last (post-update) snapshot the default.
- If there are problems, you can revert to the pre-update snapshot.
- You can always revert to any of the snapshots that you create for a box!</p>
<p><strong>Installing Software to a Box and Creating a Snapshot:</strong></p>
<ul>
<li>Select a box, disable AutoDelete, install the software to this box, set it up just the way you like.</li>
<li>Then, close the box, create a snapshot and enable box AutoDelete.</li>
<li>Now, this box will revert to the snapshot you created whenever it is closed.</li>
</ul>
<p><strong>Updating Software Installed to a Box:</strong></p>
<ul>
<li>Create a pre-update snapshot (for a baseline you can revert to, if need be).</li>
<li>Disable box AutoDelete, update the software and test.</li>
<li>If all is well, create a post-update snapshot, enable box AutoDelete.</li>
<li>This automatically makes the last (post-update) snapshot the default.</li>
<li>If there are problems, you can revert to the pre-update snapshot.</li>
<li>You can always revert to any of the snapshots that you create for a box!</li>
</ul>
<p>You have the ability to create a snapshot, remove a snapshot, revert to a snapshot or (starting with <strong>Sandboxie Plus v1.0.9</strong>) revert to an empty box while retaining all snapshots.</p>
<p><strong>Caveat:</strong> It is wise to use the snapshot features only for boxes whose location is on a real disk (and not on a ramdisk).</p>
<p><strong>Additional Details:</strong>
- Each snapshot is created its own folder, labeled snapshot-n, where the number n is the snapshot id. You can change this label.
- All snapshot folders for a given box are inside the box folder.
- The snapshot layout and information on the current (default) snapshot are saved in the file <strong>snapshot.ini</strong> in the box folder.
- The <strong>File-System</strong> snapshots are incremental. Files are duplicated only when changed (just as with real files on the host).
- The <strong>Registry</strong> snapshots are NOT incremental. Each snapshot has a full copy and only the most recent reg hive file is used.</p>
<p><strong>Additional Details:</strong></p>
<ul>
<li>Each snapshot is created its own folder, labeled snapshot-n, where the number n is the snapshot id. You can change this label.</li>
<li>All snapshot folders for a given box are inside the box folder.</li>
<li>The snapshot layout and information on the current (default) snapshot are saved in the file <strong>snapshot.ini</strong> in the box folder.</li>
<li>The <strong>File-System</strong> snapshots are incremental. Files are duplicated only when changed (just as with real files on the host).</li>
<li>The <strong>Registry</strong> snapshots are NOT incremental. Each snapshot has a full copy and only the most recent reg hive file is used.</li>
</ul>

</div>
</div><footer>
Expand Down
14 changes: 8 additions & 6 deletions PlusContent/Sandboxie-Insider.html
Original file line number Diff line number Diff line change
Expand Up @@ -901,12 +901,14 @@
<p><a href="../Content/BreakoutDocument.html">Document Breakout</a> is an extension to the already well-known Breakout mechanism to allow to open selected file types saved to an open file path from within the sandbox in an unsandbox instance of the associated application.</p>
</li>
</ul>
<p>Please note that:
- The Sandboxie Plus insider builds are not like the Windows insider builds which are buggy and rushed.
- The new things in the insider builds are limited to new functionality and new features.
- Experimental things that may impact compatibility are tested in the public GitHub preview channel.
- The Sandboxie Plus insider builds are based on stable final releases, with new functionality added on top.
- The insider builds are compiled with Qt6 and provided as a unified x64/ARM64 installer.</p>
<p>Please note that:</p>
<ul>
<li>The Sandboxie Plus insider builds are not like the Windows insider builds which are buggy and rushed.</li>
<li>The new things in the insider builds are limited to new functionality and new features.</li>
<li>Experimental things that may impact compatibility are tested in the public GitHub preview channel.</li>
<li>The Sandboxie Plus insider builds are based on stable final releases, with new functionality added on top.</li>
<li>The insider builds are compiled with Qt6 and provided as a unified x64/ARM64 installer.</li>
</ul>

</div>
</div><footer>
Expand Down
14 changes: 8 additions & 6 deletions PlusContent/Sandboxie-Insider/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -901,12 +901,14 @@
<p><a href="../../Content/BreakoutDocument/">Document Breakout</a> is an extension to the already well-known Breakout mechanism to allow to open selected file types saved to an open file path from within the sandbox in an unsandbox instance of the associated application.</p>
</li>
</ul>
<p>Please note that:
- The Sandboxie Plus insider builds are not like the Windows insider builds which are buggy and rushed.
- The new things in the insider builds are limited to new functionality and new features.
- Experimental things that may impact compatibility are tested in the public GitHub preview channel.
- The Sandboxie Plus insider builds are based on stable final releases, with new functionality added on top.
- The insider builds are compiled with Qt6 and provided as a unified x64/ARM64 installer.</p>
<p>Please note that:</p>
<ul>
<li>The Sandboxie Plus insider builds are not like the Windows insider builds which are buggy and rushed.</li>
<li>The new things in the insider builds are limited to new functionality and new features.</li>
<li>Experimental things that may impact compatibility are tested in the public GitHub preview channel.</li>
<li>The Sandboxie Plus insider builds are based on stable final releases, with new functionality added on top.</li>
<li>The insider builds are compiled with Qt6 and provided as a unified x64/ARM64 installer.</li>
</ul>

</div>
</div><footer>
Expand Down
22 changes: 13 additions & 9 deletions PlusContent/Sandboxie-Live.html
Original file line number Diff line number Diff line change
Expand Up @@ -883,15 +883,19 @@
<li>Preview - GitHub Pre-Releases</li>
</ol>
<p>There the user can also select how to behave when a "New Version" (where an installer is available) or a "Version Update" (where only individual files of the existing installation will be updated) is found.</p>
<p>For a "New Version", the following options are available:
- Notify
- Download &amp; Notify
- Download &amp; Install</p>
<p>For a "Version Update", the following options are available:
- Ignore
- Notify
- Download &amp; Notify
- Download &amp; Install</p>
<p>For a "New Version", the following options are available:</p>
<ul>
<li>Notify</li>
<li>Download &amp; Notify</li>
<li>Download &amp; Install</li>
</ul>
<p>For a "Version Update", the following options are available:</p>
<ul>
<li>Ignore</li>
<li>Notify</li>
<li>Download &amp; Notify</li>
<li>Download &amp; Install</li>
</ul>
<p>There is no "Ignore" option for "New Version", as that is covered by disabling the update check.</p>
<p>In the "Stable" channel, a check for "Version Update" is only available to supporters with a valid certificate. In this channel, all updates are signed and consist of the latest compatibility templates and urgent bug-fixes and translations.</p>
<p>In the "Preview" channel, the "Version Update" consists of unsigned test builds (except the signed driver) released every few days (like 1.6.0, 1.6.1a and 1.6.1b), as here the updates contain not only half-tested fixes but also new functionality which may not yet be free of bugs.</p>
Expand Down
22 changes: 13 additions & 9 deletions PlusContent/Sandboxie-Live/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -883,15 +883,19 @@
<li>Preview - GitHub Pre-Releases</li>
</ol>
<p>There the user can also select how to behave when a "New Version" (where an installer is available) or a "Version Update" (where only individual files of the existing installation will be updated) is found.</p>
<p>For a "New Version", the following options are available:
- Notify
- Download &amp; Notify
- Download &amp; Install</p>
<p>For a "Version Update", the following options are available:
- Ignore
- Notify
- Download &amp; Notify
- Download &amp; Install</p>
<p>For a "New Version", the following options are available:</p>
<ul>
<li>Notify</li>
<li>Download &amp; Notify</li>
<li>Download &amp; Install</li>
</ul>
<p>For a "Version Update", the following options are available:</p>
<ul>
<li>Ignore</li>
<li>Notify</li>
<li>Download &amp; Notify</li>
<li>Download &amp; Install</li>
</ul>
<p>There is no "Ignore" option for "New Version", as that is covered by disabling the update check.</p>
<p>In the "Stable" channel, a check for "Version Update" is only available to supporters with a valid certificate. In this channel, all updates are signed and consist of the latest compatibility templates and urgent bug-fixes and translations.</p>
<p>In the "Preview" channel, the "Version Update" consists of unsigned test builds (except the signed driver) released every few days (like 1.6.0, 1.6.1a and 1.6.1b), as here the updates contain not only half-tested fixes but also new functionality which may not yet be free of bugs.</p>
Expand Down
6 changes: 4 additions & 2 deletions PlusContent/WFPSupport.html
Original file line number Diff line number Diff line change
Expand Up @@ -934,8 +934,10 @@ <h3 id="implementing-network-access-rules-in-sandboxie-plus">Implementing networ
<code>NetworkAccess=chrome.exe,Allow;Port=80,443;Address=111.222.333.444</code> - allow chrome.exe to access one IP address</p>
</li>
</ul>
<p><strong>BlockPorts template:</strong>
- <code>NetworkAccess=*,Block;Port=137,138,139,445</code> - enabled by default since version <a href="https://github.com/sandboxie-plus/Sandboxie/commit/4420ba4448a797b7369917058c34e8a78c2ec9fc">1.3.4 / 5.58.4</a></p>
<p><strong>BlockPorts template:</strong></p>
<ul>
<li><code>NetworkAccess=*,Block;Port=137,138,139,445</code> - enabled by default since version <a href="https://github.com/sandboxie-plus/Sandboxie/commit/4420ba4448a797b7369917058c34e8a78c2ec9fc">1.3.4 / 5.58.4</a></li>
</ul>

</div>
</div><footer>
Expand Down
Loading

0 comments on commit 487236f

Please sign in to comment.