Commit d55abd9fb6c43535849cc72fbc56314441d5ad38
Fix indention in examples
Anders Rune Jensen authored on 9/14/2018, 6:28:51 PMGitHub committed on 9/14/2018, 6:28:51 PM
Parent: ffffc199fa6ede0d59ae4a4eaaa729281ba72885
Files changed
| README.md | changed |
| README.md | |||
|---|---|---|---|
| @@ -37,38 +37,35 @@ | |||
| 37 | 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 | - | ||
| 42 | -"incoming": { | ||
| 43 | - "net": [{ "port": 8008, "scope": "private", "transform": "shs" }] | ||
| 41 … | + "incoming": { | ||
| 42 … | + "net": [{ "port": 8008, "scope": "private", "transform": "shs" }] | ||
| 43 … | + }, | ||
| 44 … | + "outgoing": { | ||
| 45 … | + "net": [{ "transform": "shs" }] | ||
| 46 … | + } | ||
| 44 | 47 … | }, | |
| 45 | - | ||
| 46 | -"outgoing": { | ||
| 47 | - "net": [{ "transform": "shs" }] | ||
| 48 | -} | ||
| 49 | - | ||
| 50 | -}, | ||
| 51 | 48 … | ``` | |
| 52 | 49 … | ||
| 53 | 50 … | 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 | 51 … | ||
| 55 | 52 … | ```json | |
| 56 | 53 … | "connections": { | |
| 57 | - "outgoing": { | ||
| 58 | - "onion": [{ "transform": "shs" }] | ||
| 59 | - } | ||
| 60 | - }, | ||
| 54 … | + "outgoing": { | ||
| 55 … | + "onion": [{ "transform": "shs" }] | ||
| 56 … | + } | ||
| 57 … | +}, | ||
| 61 | 58 … | ``` | |
| 62 | 59 … | ||
| 63 | 60 … | 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: | |
| 64 | 61 … | ||
| 65 | 62 … | ```json | |
| 66 | 63 … | "incoming": { | |
| 67 | -"net": [ | ||
| 68 | - { "scope": "public", "external": ["cryptop.home"], "transform": "shs", "port": 8008 }, | ||
| 69 | - { "scope": "private", "transform": "shs", "port": 8008, "host": "internal1.con.taine.rs" }, | ||
| 70 | -] | ||
| 64 … | + "net": [ | ||
| 65 … | + { "scope": "public", "external": ["cryptop.home"], "transform": "shs", "port": 8008 }, | ||
| 66 … | + { "scope": "private", "transform": "shs", "port": 8008, "host": "internal1.con.taine.rs" }, | ||
| 67 … | + ] | ||
| 71 | 68 … | }, | |
| 72 | 69 … | ``` | |
| 73 | 70 … | ||
| 74 | 71 … | 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. | |
Built with git-ssb-web