Skip to content

Commit

Permalink
Merge pull request #52 from omahs/patch-1
Browse files Browse the repository at this point in the history
Fix: typos
  • Loading branch information
mudler authored Feb 12, 2023
2 parents 1c4b64f + f746fdb commit 14e36cd
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Note, tokens are config merely encoded in base64, so this is equivalent:
$ EDGEVPNTOKEN=$(edgevpn -g | tee config.yaml | base64 -w0)
```

All edgevpn commands emplies that you either specify a `EDGEVPNTOKEN` (or `--token` as parameter) or a `EDGEVPNCONFIG` as this is the way for `edgevpn` to establish a network between the nodes.
All edgevpn commands implies that you either specify a `EDGEVPNTOKEN` (or `--token` as parameter) or a `EDGEVPNCONFIG` as this is the way for `edgevpn` to establish a network between the nodes.

The configuration file is the network definition and allows you to connect over to your peers securely.

Expand Down Expand Up @@ -130,11 +130,11 @@ $ EDGEVPNTOKEN=.. edgevpn --address 10.1.0.13/24

EdgeVPN makes VPN decentralization a first strong requirement.

Its mainly use is for edge and low-end devices and especially for development.
Its main use is for edge and low-end devices and especially for development.

The decentralized approach has few cons:

- The underlaying network is chatty. It uses a Gossip protocol for syncronizing the routing table and p2p. Every blockchain message is broadcasted to all peers, while the traffic is to the host only.
- The underlying network is chatty. It uses a Gossip protocol for synchronizing the routing table and p2p. Every blockchain message is broadcasted to all peers, while the traffic is to the host only.
- Might be not suited for low latency workload.

Keep that in mind before using it for your prod networks!
Expand All @@ -147,7 +147,7 @@ First of all it's my first experiment with libp2p. Second, I always wanted a mor

# :warning: Warning!

I'm not a security expert, and this software didn't went through a full security audit, so don't use and rely it for sensible traffic and not even for production environment! I did this mostly for fun while I was experimenting with libp2p.
I'm not a security expert, and this software didn't went through a full security audit, so don't use and rely on it for sensible traffic and not even for production environment! I did this mostly for fun while I was experimenting with libp2p.

## Example use case: network-decentralized [k3s](https://github.com/k3s-io/k3s) test cluster

Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/Getting started/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ The endpoint accept a JSON payload of the following form:
}
```

Takes a regex and a set of records and registers then to the blockchain.
Takes a regex and a set of records and registers them to the blockchain.

The DNS table in the ledger will be used by the embedded DNS server to handle requests locally.

Expand Down Expand Up @@ -140,4 +140,4 @@ or as well while running the vpn:

```bash
$ edgevpn api --api-listen "unix://<path/to/socket>"
```
```
2 changes: 1 addition & 1 deletion docs/content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ It can:
- **Be used as a library**
- Plug a distributed p2p ledger easily in your golang code!

Check out the docs below for further example and reference, have a look at our [getting started guide]({{< relref "/docs">}}/getting-started), the [cli interface]({{< relref "/docs">}}/getting-started/cli), [gui desktop app]({{< relref "/docs">}}/getting-started/gui), and the embedde [WebUI/API]({{< relref "/docs">}}/getting-started/api/).
Check out the docs below for further example and reference, have a look at our [getting started guide]({{< relref "/docs">}}/getting-started), the [cli interface]({{< relref "/docs">}}/getting-started/cli), [gui desktop app]({{< relref "/docs">}}/getting-started/gui), and the embedded [WebUI/API]({{< relref "/docs">}}/getting-started/api/).


| [WebUI]({{< relref "/docs">}}/getting-started/api) | [Desktop](https://github.com/mudler/edgevpn-gui) |
Expand Down

0 comments on commit 14e36cd

Please sign in to comment.