Skip to content

Commit

Permalink
site: update getting-started tut for v2.5.0 changes
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredh159 committed Nov 14, 2024
1 parent ec6ec3e commit fcef223
Show file tree
Hide file tree
Showing 58 changed files with 274 additions and 326 deletions.
2 changes: 1 addition & 1 deletion appviews/src/BlockedRequests/BlockedRequests.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export const BlockedRequests: React.FC<Props> = ({
>
Sorry, we’re having trouble communicating with the internet filter, so we can’t
show you any blocked requests right now. If a parent is nearby, they can likely
fix the problem from the <b>Administrate screen.</b> If not,{` `}
fix the problem from the <b>Health Check screen.</b> If not,{` `}
<b>restarting the computer</b> will fix the problem.
</ErrorScreen>
);
Expand Down
2 changes: 1 addition & 1 deletion appviews/src/RequestSuspension/RequestSuspension.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ export const RequestSuspension: React.FC<Props> = ({
>
Sorry, we’re having trouble communicating with the internet filter, so we can’t
suspend the filter right now. If a parent is nearby, they can likely fix the
problem from the <b>Administrate screen.</b> If not,{` `}
problem from the <b>Health Check screen.</b> If not,{` `}
<b>restarting the computer</b> will fix the problem.
</ErrorScreen>
);
Expand Down
13 changes: 7 additions & 6 deletions site/markdoc/articles/docs/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,9 +197,9 @@ expires.

## I just installed Gertrude, but it's not blocking anything. Why? {% id="not-blocking" %}

Double-check that you got the **System Extension** installed by going to the
_Administrate..._ screen after clicking the Gertrude menu bar icon. If the extension
wasn't installed properly, click the button to install it.
Double-check that you got the **System Extension** installed by going to the _Health
Check_ screen clicking the Gertrude menu bar icon and then the gear icon ⚙️ . If the
extension wasn't installed properly, click the button to install it.

If for some reason it seems to be installed properly and the filter is still not blocking
anything, it's very likely caused by a conflict with Apple's **Screen Time** website
Expand All @@ -211,8 +211,9 @@ at the same time as Gertrude.

## Why can't I access the internet on my admin user account? {% id="admin-internet" %}

_TLDR_&mdash;Sign in as your child, go to the "Administrate" > "Exempt Users" screen, and
click to allow unrestricted access for the admin user account.
_TLDR_&mdash;Sign in as your child, open the "Health Check" screen, click the icon that
looks like three people on the left-side of the window, then click to allow unrestricted
access for the admin user account.

{% image src="exempt-users.png" caption="Exempt an admin user from filtering" /%}

Expand All @@ -226,7 +227,7 @@ about.

Therefore, you need to explicitly instruct the filter about macOS users who should be
_exempt from filtering_. To do this, sign in as the macOS user being protected by
Gertrude. Click the Gertrude menu bar icon, then click _Administrate..._ and choose the
Gertrude. Click the Gertrude menu bar icon, then click the **gear icon** and choose the
_Exempt Users_ option from the left sidebar, then click to exempt the user.

{% callout type="warning" title="Be careful with exemptions!" %}
Expand Down
491 changes: 226 additions & 265 deletions site/markdoc/articles/docs/getting-started.md

Large diffs are not rendered by default.

28 changes: 11 additions & 17 deletions site/markdoc/articles/docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ right with Gertrude.
## 1. Run the health-check

The Gertrude app has a built-in _health-check_ feature that tries to diagnose and alert
you of common issues with the app. To access it, click the **Administrate...** option from
the Gertrude menu bar icon dropdown, as shown below:
you of common issues with the app. To access it, click the **gear icon** ⚙️ from the
Gertrude menu bar icon dropdown, as shown below:

{% image src="administrate.png" caption="Click the 'Administrate...' link to reach the health check" /%}
{% image src="administrate.png" caption="Click the gear icon ⚙️ to reach the health check" /%}

The health check screen runs a series of tests on your Gertrude installation, and reports
the results. You should have all _green check marks_, unless you're intentionally not
Expand All @@ -38,19 +38,15 @@ something you think should be unblocked is not,_ try these tips:
noise and makes it easier to find the right request.
- **Be sure to clear and filter requests**. Enter a _search phrase_ into the filter field
of Gertrude's network activity screen. Usually part of the name of a website, or the app
you're using are helpful. Click the _clear requests_ button and then refresh the page,
or retry the activity that is not working.
you're using are helpful. Click the _clear requests_ button, then refresh the page, then
_pause_ the requests&mdash;you should see only the important blocked requests at that
point.

{% image src="filter-requests.png" caption="Filter by a search phrase, and clear often" /%}
{% image src="filter-requests.png" caption="<b>Filter</b> by a search phrase, </b>clear</b> often, and <b>pause</b> after refreshing" /%}

- **Send debug data, and a support request.** If all else fails, open the _Actions_ screen
of the Administrate screen, and click _"Send debug data"_. Then, try again. Extra debug
data will be recorded for a few minutes. Then send us a
[support request](https://gertrude.app/contact) describing in detail what you're
struggling with. We'll be able to retrieve the debug data, which will give us extra
insight into what's happening on your computer.
- For more detailed information on unblocking websites and apps, see our article on
[unblocking](/docs/unblocking-guide)
- Still struggling? [Contact us](https://gertrude.app/contact) for help.

## 3. Manually remove the filter

Expand All @@ -61,11 +57,9 @@ to communicate, and sometimes that communication breaks down. Usually the health
screen can both diagnose and fix this sort of problem, but sometimes you'll need to
manually remove the filter in order to get things working correctly again.

To do this, go to _System Preferences_ &rarr; _Network_. You should see the Gertrude
filter listed along the left side. Select it and click the _minus icon_ to remove the
filter, as shown below:

{% image src="remove-filter.png" caption="Remove the filter in System Prefs > Network, then restart it" /%}
To do this, go to  -> _System Settings &rarr; Network_. Next, click _Filters_. You should
see the Gertrude filter listed under "Filters &amp; Proxies." Select it and click the
_minus icon_ to remove the filter.

Once you've removed the filter, you should be able to restart it from the Gertrude app
menu bar dropdown, and it's likely the connection and communication will be reestablished.
Expand Down
64 changes: 28 additions & 36 deletions site/markdoc/articles/docs/unblocking-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,27 +75,34 @@ this:
If you see a _giant wall of requests_, don't worry&mdash;your computer makes tons of
network requests, and Gertrude has to block them all and show them to you. Usually the
vast majority of them are not important. To help you narrow down exactly the right
requests, use the following 3-part strategy:
requests, use the following 4-part strategy:

1. **Filter** by app name to see requests from only the app you're using
2. Click **Clear requests** to clear out all the old requests
3. Refresh to retrigger the problem, and note which requests were blocked **right at that
instant.**
2. **Clear requests** to remove all the old, unimportant blocks
3. **Refresh** the broken webpage to _retrigger_ the problem
4. **Pause** the requests after refreshing.

{% image src="filter-and-clear-before-reload.png" caption="To find the important requests, 1) Filter, 2) Clear, and 3) Reload" /%}
### Steps 1 & 2: Filter and Clear

There is a bit of an art to figuring out which of these requests should be unlocked, but
you'll get the knack of it. If you look closely at the image above, two of them seem like
they have to do with some kind of Google safe browsing feature, these probably aren't
important. Let's ignore those and focus on the other three:
To make it easier to see the blocks **we actually care about**, type in a **filter** term
to isolate requests just coming from the web browser Safari (or whatever browser you're
using), and then press the **Clear** button to clear out old requests.

{% image src="ignore-and-unblock.png" caption="Ignoring some google stuff, there seem to be 3 domains to be unblocked" /%}
{% image src="filter-and-clear.png" caption="Filter by app name (like Safari), and <b>Clear</b> old requests to get a clean slate" /%}

You can create an _unlock request_ for all three blocks at once:
### Step 3: Reload & Pause

{% image src="triple-unlock-request.png" caption="You can create an unlock request for all three requests at once" /%}
Next, back in your web browser **RELOAD the broken website** so we can see just the blocks
we care about. They should come in _at the same time we press refresh_. Once they do,
click the **PAUSE** button to prevent any new requests from streaming in:

Once these three domains are unlocked, the website loads!
{% image src="paused-requests.png" caption="Much better! By REFRESHING then PAUSING, we isolated the important blocks" /%}

Now we can select the blocked requests and **send an unlock request.**

{% image src="send-unlock-request.png" caption="Select the blocked domains, and click 'Send unlock request'" /%}

Once these two domains are unlocked, the website loads!

{% image src="nat-geo-unblocked.png" caption="Success! With all the keys created, the site loads fully" /%}

Expand Down Expand Up @@ -123,28 +130,13 @@ the effort, but **there are several things that make this process easier:**
won't have to repeat the process again.
6. You can always [reach out to us](https://gertrude.app/support) if you're having trouble
getting a site unlocked.
7. We're exploring some ways to in the future try to _automatically discover and unlock_
7. While you're getting the hang of unblocking sites, and before you've got everything set
the way you want it, feel free to use lots of **filter suspensions** to smooth your
transition to using Gertrude. If you've not disabled screenshot monitoring, there's
still a great deal of transparency and accountability, so this is much safer than
getting frustrated and uninstalling Gertrude. With a little bit of time, you'll find
you have their core websites unblocked and working well, and you can use fewer filter
suspensions.
8. We're exploring some ways to in the future try to _automatically discover and unlock_
some or all of these other supporting domains, so it's very likely this process will
keep getting easier over time.

## Isolate network activity

Your computer is constantly making network requests to a myriad of websites and services.
The vast majority of these don't cause you any noticeable problem, and don't need to be
unblocked. But, all those requests can make it _hard to find out which request DOES need
to be unblocked._ For this reason, probably the number one thing you can do to make it
easier to find what to unblock is **isolate network activity:**

- **Close every other app** except the one you're working with. This will greatly reduce
the number of network requests you'll have to consider.
- **Close other tabs** if you're working with a web browser, this also substantially
eliminates noise and makes it easier to find the right request.
- **Be sure to clear and filter requests**. Enter a _search phrase_ into the filter field
of Gertrude's network activity screen. Usually part of the name of a website, or the app
you're using are helpful. Click the _clear requests_ button and then refresh the page,
or retry the activity that is not working.
- **Retrigger the blocked activity** with the Blocked Requests window open, and focus on
the blocks that come in _exactly when you retrigger the problem._ Those are almost
always the ones that are causing the problem.

{% image src="filter-requests.png" caption="Filter by a search phrase, clear often, and retrigger" /%}
Binary file removed site/public/docs/images/accept-filter-suspension.png
Binary file not shown.
Binary file modified site/public/docs/images/add-child.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/public/docs/images/add-keychain.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified site/public/docs/images/administrate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed site/public/docs/images/allowed.png
Binary file not shown.
Binary file removed site/public/docs/images/aops-keychain.png
Binary file not shown.
Binary file removed site/public/docs/images/app-menu-dropdown.png
Binary file not shown.
Binary file added site/public/docs/images/blocked-requests.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed site/public/docs/images/blocked.png
Binary file not shown.
Binary file added site/public/docs/images/child-activity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/public/docs/images/child-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/public/docs/images/create-first-key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified site/public/docs/images/create-key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed site/public/docs/images/create-keychain-2.png
Binary file not shown.
Binary file removed site/public/docs/images/create-keychain.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed site/public/docs/images/create-unlock-request.png
Binary file not shown.
Binary file modified site/public/docs/images/dashboard-unlock-request.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/public/docs/images/edit-keychain.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file added site/public/docs/images/filter-and-clear.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified site/public/docs/images/filter-requests.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/public/docs/images/filter-suspended.png
Binary file modified site/public/docs/images/get-connection-code.png
Binary file removed site/public/docs/images/isolated-requests.png
Diff not rendered.
Binary file removed site/public/docs/images/khan-blocked.png
Diff not rendered.
Binary file added site/public/docs/images/khan-public-keychain.png
Binary file added site/public/docs/images/lots-of-blocks.png
Binary file removed site/public/docs/images/monitoring-enabled.png
Diff not rendered.
Binary file removed site/public/docs/images/monitoring-options.png
Diff not rendered.
Binary file removed site/public/docs/images/name-keychain.png
Diff not rendered.
Binary file modified site/public/docs/images/nat-geo-blocks.png
Binary file added site/public/docs/images/parent-settings.png
Binary file added site/public/docs/images/paused-requests.png
Binary file modified site/public/docs/images/recording-keystrokes.png
Binary file removed site/public/docs/images/remove-filter.png
Diff not rendered.
Diff not rendered.
Binary file added site/public/docs/images/request-suspension.png
Binary file added site/public/docs/images/save-child.png
Binary file modified site/public/docs/images/select-keychain.png
Binary file added site/public/docs/images/send-unlock-request.png
Binary file added site/public/docs/images/suspension-duration.png
Binary file modified site/public/docs/images/unlock-key.png
Binary file modified site/public/docs/images/unreviewed-activity.png
Binary file removed site/public/docs/images/users-activity.png
Diff not rendered.
Binary file removed site/public/docs/images/view-network-traffic.png
Diff not rendered.

0 comments on commit fcef223

Please sign in to comment.