diff --git a/README.md b/README.md index 7991636..d95c285 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ walnut ====== -An opinionated, constrained, secure application framework with a hard shell - like iOS, but for a home server. +An opinionated, constrained, secure application framework with a hard shell - kinda like iOS, but for a server. + +Applications are written in express, but instead of using `require` for generic packages, +they use `req.getSiteCapability(pkg)` and are restricted to packages that have been +allowed by app, device, site, or user permission. Any configuration for the capability +(external passwords, api keys, etc) will be set up beforehand so that they are not exposed +to the application. Security Features ----------------- @@ -66,8 +72,13 @@ Initial Configuration Once installed and started you can visit . -``` -curl http://localhost.daplie.me:3000 -H 'X-Forwarded-Proto: https' +```bash +curl -X POST http://api.localhost.daplie.me:3000/api/walnut@daplie.com/init \ + -H 'X-Forwarded-Proto: https' \ + -H 'Content-Type: application/json' \ + -d '{ + "domain": "example.com" + }' ``` API @@ -133,15 +144,19 @@ POST https://api./api/walnut@daplie.com/init The following domains are required to point to WALNUT server +``` +cloud. +api.cloud. +``` + +and + ``` www. api. assets. - -cloud. -api.cloud. ``` Example `/etc/goldilocks/goldilocks.yml`: