document and update
This commit is contained in:
parent
9d2e89a1c7
commit
52966e5d95
68
README.md
68
README.md
|
@ -12,18 +12,18 @@ daplie-install-cloud
|
||||||
Features
|
Features
|
||||||
------
|
------
|
||||||
|
|
||||||
|
* Works with Goldilocks for secure, Let's Encrypt maneged, https-only serving
|
||||||
|
|
||||||
* IOT Application server written in [Node.js](https://nodejs.org)
|
* IOT Application server written in [Node.js](https://nodejs.org)
|
||||||
* Small memory footprint
|
* Small memory footprint (for a node app)
|
||||||
* Secure
|
* Secure
|
||||||
* Uses JWT, not Cookies\*
|
* Uses JWT, not Cookies\*
|
||||||
* HTTPS-only
|
* HTTPS-only (checks for X-Forwarded-For)
|
||||||
* AES, RSA, and ECDSA encryption and signing
|
* AES, RSA, and ECDSA encryption and signing
|
||||||
* Safe against CSRF, XSS, and SQL injection
|
* Safe against CSRF, XSS, and SQL injection
|
||||||
* Safe against Compression attacks
|
* Safe against Compression attacks
|
||||||
* Multi-Tentated Application Management
|
* Multi-Tentated Application Management
|
||||||
* Built-in OAuth2 & OAuth3 support
|
* 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
|
\*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.
|
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
|
In Progress
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
* Static Asset Serving via [Caddy](https://caddyserver.org)
|
|
||||||
* HTTPS Certificates provisioned via [Let's Encrypt](https://letsencrypt.org)
|
|
||||||
* HTTPS Key Pinning
|
* HTTPS Key Pinning
|
||||||
* Heroku (pending completion of PostgreSQL support)
|
* Heroku (pending completion of PostgreSQL support)
|
||||||
* [GunDB](https://gundb.io) Support
|
* [GunDB](https://gundb.io) Support
|
||||||
|
@ -48,20 +46,15 @@ Currently being tested with Ubuntu, Raspbian, and Debian on Digital Ocean, Raspb
|
||||||
/srv/walnut/
|
/srv/walnut/
|
||||||
├── setup.sh (in-progress)
|
├── setup.sh (in-progress)
|
||||||
├── core
|
├── core
|
||||||
│ ├── bin
|
│ ├── bin
|
||||||
│ ├── boot
|
│ ├── boot
|
||||||
│ ├── holepunch
|
│ ├── holepunch
|
||||||
│ └── lib
|
│ └── lib
|
||||||
├── node_modules
|
├── node_modules
|
||||||
├── packages
|
├── packages
|
||||||
│ ├── apis
|
│ ├── apis
|
||||||
│ ├── pages
|
│ ├── pages
|
||||||
│ └── services
|
│ └── services
|
||||||
├── certs
|
|
||||||
| └── live
|
|
||||||
│ └── example.com
|
|
||||||
│ ├── fullchain.pem
|
|
||||||
│ └── privkey.pem
|
|
||||||
└── var
|
└── 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
|
* `var` is a directory for database files and such
|
||||||
* `packages` contains 3 types of packages
|
* `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
|
||||||
|
|
|
@ -100,7 +100,9 @@ $(function () {
|
||||||
}).then(function (data) {
|
}).then(function (data) {
|
||||||
console.log('Result:');
|
console.log('Result:');
|
||||||
console.log(data);
|
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) {
|
}, function (err) {
|
||||||
console.error('Error POSTing form:');
|
console.error('Error POSTing form:');
|
||||||
console.error(err);
|
console.error(err);
|
||||||
|
|
Loading…
Reference in New Issue