Commit c5d2f2a9a733cae7847e58749113d298c9f613a0
README: fix some typos
just some spelling and less-weird grammar.Henry authored on 9/11/2018, 11:46:07 AM
GitHub committed on 9/11/2018, 11:46:07 AM
Parent: 7515be5971a479fa562f7e4f5a81aae7b73c093c
Files changed
| README.md | changed |
| README.md | ||
|---|---|---|
| @@ -33,9 +33,9 @@ | ||
| 33 | 33 … | ### `connections` |
| 34 | 34 … | |
| 35 | 35 … | Two objects to specify `incoming` and `outgoing` transports and transformations for connections. |
| 36 | 36 … | |
| 37 | -The default is this. It specifies the default tcp `net`work transport for incoming and outging connections, using secret-handshake/boxstream ([shs](https://github.com/auditdrivencrypto/secret-handshake)) for authentication and encryption. | |
| 37 … | +The default is the following. It specifies the default TCP `net`work transport for incoming and outging connections, using secret-handshake/boxstream ([shs](https://github.com/auditdrivencrypto/secret-handshake)) for authentication and encryption. | |
| 38 | 38 … | |
| 39 | 39 … | ```json |
| 40 | 40 … | "connections": { |
| 41 | 41 … | |
| @@ -49,23 +49,23 @@ | ||
| 49 | 49 … | |
| 50 | 50 … | }, |
| 51 | 51 … | ``` |
| 52 | 52 … | |
| 53 | -If you want to use [TOR](https://torproject.org) to create outgoing connections you can specify this as your. It will use `localhost:9050` as the socks server for creating this. | |
| 53 … | +If you want to use [TOR](https://torproject.org) to create outgoing connections you can specify your `outgoing` like this. It will use `localhost:9050` as the socks server for creating this. | |
| 54 | 54 … | |
| 55 | -TODO: make the onion socks server configurable. | |
| 55 … | +TODO: | |
| 56 … | +* make the onion socks server configurable. | |
| 57 … | +* support creating hidden services via `incoming` blocks | |
| 56 | 58 … | |
| 57 | -TODO: support creating hidden services via `incoming` blocks | |
| 58 | - | |
| 59 | 59 … | ```json |
| 60 | 60 … | "connections": { |
| 61 | 61 … | "outgoing": { |
| 62 | 62 … | "onion": [{ "transform": "shs" }] |
| 63 | 63 … | } |
| 64 | 64 … | }, |
| 65 | 65 … | ``` |
| 66 | 66 … | |
| 67 | -If you want to run a peer behind NAT or other kind proxy but still want it to be able to create invites, you can specify a `public` scope in your `incoming.net` by defining the `external` paramter like this: | |
| 67 … | +If you want to run a peer behind NAT or other kind of proxy but still want sbot to be able to create invites for the outside addres, you can specify a `public` scope as your `incoming.net` by defining the `external` paramter like this: | |
| 68 | 68 … | |
| 69 | 69 … | ```json |
| 70 | 70 … | "incoming": { |
| 71 | 71 … | "net": [ |
| @@ -80,9 +80,9 @@ | ||
| 80 | 80 … | ] |
| 81 | 81 … | }, |
| 82 | 82 … | ``` |
| 83 | 83 … | |
| 84 | -One thing to nice is that you _need_ `incoming` connections for Apps (like patchwork or git-ssb) to function. By default they use the same authentication mechanism (shs) to grant access to the database, choosing access levels depending on the keypair that opens the connection. If you connect to yourself, you get full access (query and publish). If a remote peer connects, it can only replicate. So be sure to have **at least one** `incoming` connection. | |
| 84 … | +One thing to notice is that you _need_ `incoming` connections for Apps (like patchwork or git-ssb) to function. By default they use the same authentication mechanism (shs) to grant access to the database, choosing access levels depending on the keypair that opens the connection. If you connect to yourself, you get full access (query and publish). If a remote peer connects, it can only replicate. So be sure to have **at least one** `incoming` connection. | |
| 85 | 85 … | |
| 86 | 86 … | That beeing said, the overhead of encryption for local applications can be very high, especially on low-powered devices. For this use-case there is a `noauth` transform which by-passes the authentication and grants full access to anybody that can connect to it. **hint:** *This is risky! it might expose private messages or enables people to publish as you!* Therefore be sure to bind the listener to `localhost` or use the `unix` socket. The `unix` file socket is creted as `$HOME/.ssb/socket` by default and has permissions such that only the user running `sbot server` can open it, just like the `.ssb/secret` file. |
| 87 | 87 … | |
| 88 | 88 … | ```json |
Built with git-ssb-web