Update README.md
This commit is contained in:
parent
9c1e2e58d2
commit
e66e92cae3
52
README.md
52
README.md
|
@ -46,48 +46,21 @@ Application Features
|
||||||
* Multi-Tentated Application Management
|
* Multi-Tentated Application Management
|
||||||
* Built-in OAuth2 & OAuth3 support
|
* Built-in OAuth2 & OAuth3 support
|
||||||
|
|
||||||
Install
|
Installation
|
||||||
-------
|
------------
|
||||||
|
|
||||||
```bash
|
See [INSTALL.md](https://git.daplie.com/Daplie/walnut.js/blob/master/INSTALL.md)
|
||||||
curl https://daplie.me/install-scripts | bash
|
|
||||||
|
|
||||||
daplie-install-walnut
|
|
||||||
```
|
|
||||||
|
|
||||||
You could also, of course, try installing from the repository directly
|
|
||||||
(especially if you have goldilocks or some similar already installed)
|
|
||||||
|
|
||||||
```bash
|
|
||||||
mkdir -p /srv/walnut/
|
|
||||||
git clone git@git.daplie.com:Daplie/walnut.js.git /srv/walnut/core
|
|
||||||
pushd /srv/walnut/core
|
|
||||||
git checkout v1
|
|
||||||
popd
|
|
||||||
bash /srv/walnut/core/install-helper.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
Initial Configuration
|
|
||||||
-------------
|
|
||||||
|
|
||||||
Once installed and started you can visit <https://localhost.daplie.me:3000> to configure the primary domain.
|
|
||||||
|
|
||||||
You could also do this manually via curl:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
PRIMARY_DOMAIN="example.com"
|
|
||||||
|
|
||||||
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": "'$PRIMARY_DOMAIN'" }'
|
|
||||||
```
|
|
||||||
|
|
||||||
API
|
API
|
||||||
---
|
---
|
||||||
|
|
||||||
API docs are here https://git.daplie.com/Daplie/com.example.hello
|
API docs are here https://git.daplie.com/Daplie/com.example.hello
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
req.apiUrlPrefix => https://api.example.com/api/tld.domain.pkg
|
||||||
|
```
|
||||||
|
|
||||||
Structure
|
Structure
|
||||||
=====
|
=====
|
||||||
|
|
||||||
|
@ -302,11 +275,4 @@ The permissions:
|
||||||
'''
|
'''
|
||||||
seed@example.com # refers to /srv/walnut/packages/pages/seed@example.com
|
seed@example.com # refers to /srv/walnut/packages/pages/seed@example.com
|
||||||
'''
|
'''
|
||||||
```
|
```
|
||||||
|
|
||||||
API
|
|
||||||
---
|
|
||||||
|
|
||||||
```
|
|
||||||
req.apiUrlPrefix => https://api.example.com/api/tld.domain.pkg
|
|
||||||
```
|
|
Loading…
Reference in New Issue