Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
omahs authored Mar 8, 2024
1 parent 400a8bf commit 4dced60
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/developer_manual/03-createing-a-new-rap.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Creating a new remote access provider (RAP)

A remote access provider contains the logic to enable remote access to a network. The way a remote access provider work is that the emulator will provide the remote access provider with:
A remote access provider contains the logic to enable remote access to a network. The way a remote access provider works is that the emulator will provide the remote access provider with:

- The network to enable remote access on.
- A for-service bridging network: this network is not a part of the emulation. Instead, it was used by special services like this to communicate with the emulator host.
- A bridging node: this node is not a part of emulation. It is a special node that will have access to both the for-service bridging network and the network to enable remote access on.

Then, what a remote access provider usually do is:
Then, what a remote access provider usually does is:

- Start a VPN server, listen for incoming connections on the for-service bridge network, so the emulator host can port-forward to the VPN server and allow hosts in the real world to connect.
- Add the VPN server interface and the network to enable remote access on to the same bridge so that clients can access the network.
Expand All @@ -27,6 +27,6 @@ The first is a reference to the current emulator instance, in case the access pr

The second is a reference to the network instance of the network to be bridged to - in other words, the goal is to provide remote access to this network.

The third is a reference to a service node. A service node is not part of the emulation. This node can be used to run software (like VPN server) for remote access. This node will be under the same scope as the network passed as the second parameter. The node will be an empty node - no networks connected, no software installed. The regular APIs like `joinNetwork` and `addSoftware` works.
The third is a reference to a service node. A service node is not part of the emulation. This node can be used to run software (like VPN server) for remote access. This node will be under the same scope as the network passed as the second parameter. The node will be an empty node - no networks connected, no software installed. The regular APIs like `joinNetwork` and `addSoftware` work.

The last is a reference to the for-service network. The for service network has a name that begins with `000`; therefore it ensures that whatever nodes joined this network will have this network as their default gateway if compiled by the `Docker` compiler. This will ensure the default gateway works even if the user uses the `selfManagedNetwork` option. If compiled by the `Docker` compiler, this network will have NAT access to the internet.
The last is a reference to the for-service network. The for service network has a name that begins with `000`; therefore it ensures that whatever nodes joined this network will have this network as their default gateway if compiled by the `Docker` compiler. This will ensure the default gateway works even if the user uses the `selfManagedNetwork` option. If compiled by the `Docker` compiler, this network will have NAT access to the internet.

0 comments on commit 4dced60

Please sign in to comment.