| … | … | @@ -5,14 +5,21 @@ |
| 5 | 5 | It is a renderer and only a renderer. Everything it knows it asked the daemon over a unix socket, |
| 6 | 6 | and everything it shows, `favela-markdown` rendered. Close it and you lose nothing but the window. |
| 7 | 7 | |
| 8 | | ## Running |
| 8 | ## Install |
| 9 | 9 | |
| 10 | ```sh |
| 11 | pgh publish . |
| 12 | pgh app install pgh://<registry-key>/favela-surface --name favela-surface |
| 10 | 13 | ``` |
| 14 | |
| 15 | ## Running |
| 16 | |
| 17 | ```sh |
| 11 | 18 | favela-peer & # the daemon owns the data |
| 12 | 19 | favela-surface # http://127.0.0.1:4042 |
| 13 | 20 | ``` |
| 14 | 21 | |
| 15 | | ⚠ **If every page says the daemon is down, it is almost always the socket.** `FAVELA_SOCK` has to |
| 22 | **If every page says the daemon is down, it is almost always the socket.** `FAVELA_SOCK` has to |
| 16 | 23 | point at the *daemon's* storage, not the surface's. The two apps have separate defaults, so a |
| 17 | 24 | surface left on its own looks for a socket nobody created. This package's pgh defaults set it to |
| 18 | 25 | `${HOME}/.config/favela-peer/favela.sock`; set it yourself if you run the daemon elsewhere. |
| … | … | @@ -63,7 +70,7 @@ still works; with it present it cannot produce a mention the server would not ha |
| 63 | 70 | is server-rendered on purpose — an explanation of what the dots mean is no use if it arrives after |
| 64 | 71 | the WebGL. |
| 65 | 72 | |
| 66 | | ⛔ **Everything under `/static/` is vendored, never a CDN.** A page that loaded its signer from |
| 73 | **Everything under `/static/` is vendored, never a CDN.** A page that loaded its signer from |
| 67 | 74 | someone else's server would let that server mint signatures with your key. See `static/README.md`. |
| 68 | 75 | |
| 69 | 76 | ## The boundary |
| … | … | @@ -76,3 +83,7 @@ grows a Corestore has quietly become a second peer implementation — the fork r |
| 76 | 83 | `hypercore`, `autobee`, `autobase`, `hyperswarm`, `hyper-overlay`, `atproto-*` or `ap-bridge`. |
| 77 | 84 | |
| 78 | 85 | `npm test` — 175 tests, 565 asserts, all passing. |
| 86 | |
| 87 | ## License |
| 88 | |
| 89 | Not yet declared — `package.json` carries no `license` field and there is no LICENSE file. |