Skip to content

Commit

Permalink
Adjust screenshots sizes (#174)
Browse files Browse the repository at this point in the history
  • Loading branch information
juliaroesschen authored Mar 26, 2024
1 parent a56a607 commit 1a0f99f
Show file tree
Hide file tree
Showing 31 changed files with 92 additions and 83 deletions.
Binary file modified public/docs-static/img/overview/personal-access-token-creation.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.
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.
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 public/docs-static/img/overview/service-user-creation.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 public/docs-static/img/overview/service-user-overview.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.
12 changes: 6 additions & 6 deletions src/components/NavigationDocs.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export const docsNavigation = [
{
title: 'Activity',
links: [
{ title: 'Activity Events', href: '/how-to/monitor-system-and-network-activity' },
{ title: 'Activity events', href: '/how-to/monitor-system-and-network-activity' },

],
},
Expand All @@ -93,7 +93,7 @@ export const docsNavigation = [
isOpen: false,
links: [
{title: 'Authentication', href: '/how-to/enforce-periodic-user-authentication' },
{title: 'Delete Account/Danger Zone', href: '/how-to/delete-account' }
{title: 'Delete account/danger zone', href: '/how-to/delete-account' }
/*{title: 'Groups', href: '/about-netbird/netbird-vs-traditional-vpn' },
{title: 'Plans & Billing', href: '/about-netbird/netbird-vs-traditional-vpn' },*/

Expand All @@ -103,9 +103,9 @@ export const docsNavigation = [
title: 'Integrations',
isOpen: false,
links: [
{title: 'Activity Event Streaming', href: '/how-to/activity-event-streaming' },
{title: 'Identity Provider', href: '/how-to/idp-sync' },
{title: 'Enable Post Quantum Cryptography', href: '/how-to/enable-post-quantum-cryptography' },
{title: 'Activity event streaming', href: '/how-to/activity-event-streaming' },
{title: 'Identity provider sync', href: '/how-to/idp-sync' },
{title: 'Enable post quantum cryptography', href: '/how-to/enable-post-quantum-cryptography' },

]
},
Expand All @@ -125,7 +125,7 @@ export const docsNavigation = [
{
title: 'USE CASES',
links: [
{ title: 'NetBird on FaaS', href: '/how-to/netbird-on-faas' },
{ title: 'Serverless and NetBird', href: '/how-to/netbird-on-faas' },
{ title: 'Routing peers and Kubernetes', href: '/how-to/routing-peers-and-kubernetes'},
{ title: 'NetBird Client on AWS ECS', href: '/how-to/examples'},
],
Expand Down
8 changes: 4 additions & 4 deletions src/pages/about-netbird/how-netbird-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ A **Peer** is a machine or any device that is connected to the network.
It can be a Linux server running in the cloud or on-premises, a personal laptop, mobile phone, or even a Raspberry PI.

<p>
<img src="/docs-static/img/architecture/high-level-dia.png" alt="high-level-dia" width="781" style={{boxShadow: '0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.19)'}}/>
<img src="/docs-static/img/architecture/high-level-dia.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>

With NetBird clients installed and authorized on the Management service, machines form a mesh network connecting
Expand Down Expand Up @@ -58,7 +58,7 @@ After that, they are able to establish a connection to the new peer.
The Management service runs in the cloud NetBird-managed. It can also be self-hosted.

<p>
<img src="/docs-static/img/architecture/management.png" alt="management-dia" className="imagewrapper"/>
<img src="/docs-static/img/architecture/management.png" alt="management-dia" className="imagewrapper-big"/>
</p>

### Client Application
Expand Down Expand Up @@ -99,7 +99,7 @@ peers need to find each other and exchange the most suitable connection candidat
This is done through Signal. After a connection has been established, Signal steps out.

<p>
<img src="/docs-static/img/architecture/signal.png" alt="signal-dia" className="imagewrapper"/>
<img src="/docs-static/img/architecture/signal.png" alt="signal-dia" className="imagewrapper-big"/>
</p>

<Note>
Expand All @@ -116,7 +116,7 @@ In fact, we use an open-source implementation called [Coturn](https://github.com
The purpose of this service is to be a "plan B" and relay traffic between peers in case a point-to-point connection isn't possible.

<p>
<img src="/docs-static/img/architecture/relay.png" alt="relay-dia" className="imagewrapper"/>
<img src="/docs-static/img/architecture/relay.png" alt="relay-dia" className="imagewrapper-big"/>
</p>

<Note>
Expand Down
12 changes: 6 additions & 6 deletions src/pages/how-to/access-netbird-public-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,28 @@ The most common usage scenarios:

### Creating a service user

To create a service user, you'll need to log in to your organization's account at https://app.netbird.io and navigate to the "Users" -> "Service Users" section of your account.
To create a service user, you'll need to log in to your organization's account at https://app.netbird.io and navigate to the "Team" -> "Service Users" section of your account.
<p>
<img src="/docs-static/img/overview/service-user-overview.png" alt="service-user-overview" width="780" className="imagewrapper"/>
<img src="/docs-static/img/overview/service-user-overview.png" alt="service-user-overview" className="imagewrapper-big"/>
</p>

From there, you can create a new service user and specify a role that the user should have.
User role allows read-only access, use the admin for write access.

<p>
<img src="/docs-static/img/overview/service-user-creation.png" alt="service-user-creation-popup" width="400" className="imagewrapper"/>
<img src="/docs-static/img/overview/service-user-creation.png" alt="service-user-creation-popup" className="imagewrapper"/>
</p>

<Note>
It's important to keep your service users secure, as they can provide access to sensitive data and actions within your organization. You should treat your service users like you would treat your own personal account and limit the scope of access granted to the service user.
</Note>

### Creating an access token

To create an access token, you'll need to log in to your account and navigate to the "Users" section and look for your user or create a [service user](#service-users) to use for your API requests.
To create an access token, you'll need to log in to your account and navigate to the "Team" section and look for your user or create a [service user](#service-users) to use for your API requests.

<p>
<img src="/docs-static/img/overview/personal-access-token-overview.png" alt="personal-access-token-overview" width="780" className="imagewrapper"/>
<img src="/docs-static/img/overview/personal-access-token-overview.png" alt="personal-access-token-overview" width="780" className="imagewrapper-big"/>
</p>

From there, you can create a new token and specify expiration for the token. You won't be able to modify your token.
Expand Down
2 changes: 1 addition & 1 deletion src/pages/how-to/activity-event-streaming.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Before you start creating and configuring a Datadog event-streaming integration,
### Step 2: Create an event-streaming integration in NetBird
- Navigate to the [Integrations &raquo; Event Streaming](https://preview.netbird.io/integrations) tab in the NetBird dashboard
<p>
<img src="/docs-static/img/how-to-guides/event-streaming-integration.png" alt="event-streaming-integration" className="imagewrapper"/>
<img src="/docs-static/img/how-to-guides/event-streaming-integration.png" alt="event-streaming-integration" className="imagewrapper-big"/>
</p>

- Enable and configure the Datadog integration
Expand Down
5 changes: 2 additions & 3 deletions src/pages/how-to/add-machines-to-your-network.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To add a new peer to your network follow these steps:
2. Hit `Add Peer` button

<p>
<img src="/docs-static/img/how-to-guides/add-new-peer-empty.png" alt="high-level-dia" className="imagewrapper"/>
<img src="/docs-static/img/how-to-guides/add-new-peer-empty.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>

3. Follow the instructions
Expand All @@ -27,10 +27,9 @@ To add a new peer to your network follow these steps:
4. Refresh the Peers tab, and it will display new machines

<p>
<img src="/docs-static/img/how-to-guides/peer-list.png" alt="high-level-dia" className="imagewrapper"/>
<img src="/docs-static/img/how-to-guides/peer-list.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>


## What's next?

Here are a few links that might be handy as you venture further into NetBird:
Expand Down
4 changes: 2 additions & 2 deletions src/pages/how-to/add-users-to-your-network.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ NetBird has three user roles - `Owner`, `Admin`, and `User`. The roles allow you

To manage user roles, proceed to the `Users` tab and click on the user you want to update:
<p>
<img src="/docs-static/img/how-to-guides/user-tab-list.png" alt="high-level-dia" className="imagewrapper"/>
<img src="/docs-static/img/how-to-guides/user-tab-list.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>
After that, select the desired role from the dropdown:
<p>
<img src="/docs-static/img/how-to-guides/user-update-role.png" alt="high-level-dia" className="imagewrapper"/>
<img src="/docs-static/img/how-to-guides/user-update-role.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>
Click the `Save` button to save the changes.
<Note>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/how-to/approve-peers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Administrators then can assess whether the peer is eligible to join the network.
To enable peer approval, navigate to [Settings &raquo; Authentication](https://app.netbird.io/settings) and enable 'Peer approval'.

<p>
<img src="/docs-static/img/how-to-guides/peer-approval-settings.png" alt="peer-approval-settings" className="imagewrapper"/>
<img src="/docs-static/img/how-to-guides/peer-approval-settings.png" alt="peer-approval-settings" className="imagewrapper-big"/>
</p>

<Note>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/how-to/delete-account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To delete your NetBird organization account, you must be a user with the [owner

Go to the `Settings` tab, then click on `Danger Zone`. Review the message and click on the `Delete Account` button.
<p>
<img src="/docs-static/img/how-to-guides/account-settings-danger-zone.png" alt="high-level-dia" className="imagewrapper"/>
<img src="/docs-static/img/how-to-guides/account-settings-danger-zone.png" alt="high-level-dia" className="imagewrapper-big"/>
</p>
To confirm, click on the `Delete` button.
<p>
Expand Down
6 changes: 3 additions & 3 deletions src/pages/how-to/enforce-periodic-user-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Every new network has this feature enabled, and the expiration period is set to
Expired peers will appear in the peers' view with the status `Login required`.

<p>
<img src="/docs-static/img/how-to-guides/peer-needs-login.png" alt="peer-needs-login.png" className="imagewrapper"/>
<img src="/docs-static/img/how-to-guides/peer-needs-login.png" alt="peer-needs-login.png" className="imagewrapper-big"/>
</p>

## Configure and disable expiration
Expand All @@ -20,7 +20,7 @@ Go to the Web UI `Settings` tab and set the desired period in the Authentication
You can also disable the expiration for the whole network in the same section.

<p>
<img src="/docs-static/img/how-to-guides/peer-login-expiration.png" alt="peer-login-expiration" className="imagewrapper"/>
<img src="/docs-static/img/how-to-guides/peer-login-expiration.png" alt="peer-login-expiration" className="imagewrapper-big"/>
</p>


Expand All @@ -36,7 +36,7 @@ In the Peers tab of the web UI click on the peer you want to disable expiration
Peers with `Expiration disabled` will be marked with a corresponding label in the Peers table.

<p>
<img src="/docs-static/img/how-to-guides/individual-peer-login-expiration.png" alt="peer-login-expiration" className="imagewrapper"/>
<img src="/docs-static/img/how-to-guides/individual-peer-login-expiration.png" alt="peer-login-expiration" className="imagewrapper-big"/>
</p>

## Get started
Expand Down
15 changes: 8 additions & 7 deletions src/pages/how-to/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ Both machines are running Linux but NetBird also works on Windows, MacOS nad pop
You can use your Google, GitHub or Microsoft account.

<p>
<img src="/docs-static/img/getting-started/auth.png" alt="login-to-netbird" className="imagewrapper" />
<img src="/docs-static/img/getting-started/auth.png" alt="login-to-netbird" className="imagewrapper-big"/>
</p>

2. After a successful login you will be redirected to the ```Peers``` screen which is empty because you don't have any peers yet.

The `Add peer` window should automatically pop up, but if it doesn't, click ```Add new peer``` to add a new machine.

<p>
<img src="/docs-static/img/getting-started/empty-peers.png" alt="login-to-netbird" className="imagewrapper"/>
<img src="/docs-static/img/getting-started/empty-peers.png" alt="login-to-netbird" className="imagewrapper-big"/>
</p>

3. Choose your machine operating system (in our case it is ```Linux```) and proceed with the installation steps.
Expand All @@ -37,16 +37,17 @@ The `Add peer` window should automatically pop up, but if it doesn't, click ```A
<img src="/docs-static/img/getting-started/add-peer.png" alt="login-to-netbird" className="imagewrapper"/>
</p>

4. If you installed NetBird Desktop UI you can use it to connect to the network instead of running `netbird up` command. Look for `NetBird` in your application list, run it, and click `Connect`.
4. If you installed NetBird Desktop UI you can use it to connect to the network instead of running `netbird up` command.
Look for `NetBird` in your application list, run it, and click `Connect`.
>
<p>
<img src="/docs-static/img/getting-started/systray.png" alt="login-to-netbird" className="imagewrapper"/>
<img src="/docs-static/img/getting-started/systray.png" alt="login-to-netbird" className="imagewrapper-big"/>
</p>
5. At this point a browser window pops up starting a device registration process. Click confirm and follow the steps if required.

<p>
<img src="/docs-static/img/getting-started/device-confirmation.png" alt="login-to-netbird" className="imagewrapper"/>
<img src="/docs-static/img/getting-started/device-confirmation.png" alt="login-to-netbird" className="imagewrapper-big"/>
</p>

6. On the EC2 node repeat the installation steps and run `netbird up` command.
Expand All @@ -57,13 +58,13 @@ sudo netbird up
7. Copy the verification URL from the terminal output and paste it in your browser. Repeat step #5

<p>
<img src="/docs-static/img/getting-started/netbird-up.png" alt="login-to-netbird" className="imagewrapper"/>
<img src="/docs-static/img/getting-started/netbird-up.png" alt="login-to-netbird" className="imagewrapper-big"/>
</p>

8. Return to ```Peers``` and you should notice 2 new machines with status ```online```

<p>
<img src="/docs-static/img/getting-started/peers.png" alt="login-to-netbird" className="imagewrapper"/>
<img src="/docs-static/img/getting-started/peers.png" alt="login-to-netbird" className="imagewrapper-big"/>
</p>

9. To test the connection you could try pinging devices:
Expand Down
Loading

0 comments on commit 1a0f99f

Please sign in to comment.