document and update

This commit is contained in:
AJ ONeal 2017-05-19 05:20:09 +00:00
parent 9d2e89a1c7
commit 52966e5d95
2 changed files with 49 additions and 23 deletions

View File

@ -12,18 +12,18 @@ daplie-install-cloud
Features
------
* Works with Goldilocks for secure, Let's Encrypt maneged, https-only serving
* IOT Application server written in [Node.js](https://nodejs.org)
* Small memory footprint
* Small memory footprint (for a node app)
* Secure
* Uses JWT, not Cookies\*
* HTTPS-only
* HTTPS-only (checks for X-Forwarded-For)
* AES, RSA, and ECDSA encryption and signing
* Safe against CSRF, XSS, and SQL injection
* Safe against Compression attacks
* Multi-Tentated Application Management
* Built-in OAuth2 & OAuth3 support
* Facebook Connect
* Google Plus
\*Cookies are used only for GETs and only where using a token would be less secure
such as images which would otherwise require the token to be passed into the img src.
@ -32,8 +32,6 @@ They are also scoped such that CSRF attacks are not possible.
In Progress
-----------
* Static Asset Serving via [Caddy](https://caddyserver.org)
* HTTPS Certificates provisioned via [Let's Encrypt](https://letsencrypt.org)
* HTTPS Key Pinning
* Heroku (pending completion of PostgreSQL support)
* [GunDB](https://gundb.io) Support
@ -48,20 +46,15 @@ Currently being tested with Ubuntu, Raspbian, and Debian on Digital Ocean, Raspb
/srv/walnut/
├── setup.sh (in-progress)
├── core
   ├── bin
   ├── boot
   ├── holepunch
   └── lib
├── bin
├── boot
├── holepunch
└── lib
├── node_modules
├── packages
│   ├── apis
│   ├── pages
│   └── services
├── certs
| └── live
│   └── example.com
│    ├── fullchain.pem
│    └── privkey.pem
│ ├── apis
│ ├── pages
│ └── services
└── var
```
@ -71,9 +64,40 @@ Currently being tested with Ubuntu, Raspbian, and Debian on Digital Ocean, Raspb
* `var` is a directory for database files and such
* `packages` contains 3 types of packages
LICENSE
-------
Will install to
---------------
Apache-2.0
```
/srv/walnut/core/
/etc/walnut
/opt/walnut
/var/log/walnut
/etc/systemd/system/walnut.service
/etc/tmpfiles.d/walnut.conf
```
See LICENSE
Implementation details
----------------
Initialization
--------------
needs to know its primary domain
```
POST https://api.<domain.tld>/api/com.daplie.walnut.init
{ "domain": "<domain.tld>" }
```
Resetting the Initialization
----------------------------
Once you run the app the initialization files will appear in these locations
```
/srv/walnut/var/com.daplie.walnut.config.sqlite3
/srv/walnut/config/<domain.tld>.json
```
Deleting those files will rese

View File

@ -100,7 +100,9 @@ $(function () {
}).then(function (data) {
console.log('Result:');
console.log(data);
window.alert('Hoo hoo! That tickles! ' + JSON.stringify(data));
if (window.confirm('Hoo hoo! That tickles! Reload page now?')) {
window.location.reload();
}
}, function (err) {
console.error('Error POSTing form:');
console.error(err);