You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit fe2da76
Browse filesBrowse the repository at this point in the historyBrowse files
Ldnode implements the [Linked Data Platform](http://www.w3.org/TR/ldp/) and [Solid](https://github.com/solid) in [NodeJS](https://nodejs.org/). This is all you need to run distributed Linked Data apps on top of the file system.
7
+
Ldnode implements the [Linked Data Platform](http://www.w3.org/TR/ldp/) and
8
+
[Solid](https://github.com/solid) in [NodeJS](https://nodejs.org/). This is all
9
+
you need to run distributed Linked Data apps on top of the file system.
8
10
9
-
You can run ldnode as a [command-line tool](https://github.com/linkeddata/ldnode/blob/master/README.md#command-line-tool) or as a [library](https://github.com/linkeddata/ldnode/blob/master/README.md#library) for your [Express](https://expressjs.com) app.
11
+
You can run `ldnode` as a [command-line tool](https://github.com/linkeddata/ldnode/blob/master/README.md#command-line-tool) or as a [library](https://github.com/linkeddata/ldnode/blob/master/README.md#library) for your [Express](https://expressjs.com) app.
10
12
11
13
## Features
12
14
@@ -17,8 +19,7 @@ You can run ldnode as a [command-line tool](https://github.com/linkeddata/ldnode
17
19
-[x] Real-time live updates (using WebSockets)
18
20
-[ ] Identity provider for WebID+TLS
19
21
20
-
21
-
## Command line tool
22
+
## Command Line Usage
22
23
23
24
npm install -g ldnode
24
25
@@ -49,36 +50,97 @@ Options:
49
50
50
51
```
51
52
52
-
### Run your server
53
-
To start your Linked Data Platform server:
53
+
### Running the server
54
+
55
+
#### Pre-Requisites
56
+
57
+
In order to really get a feel for the Solid platform, and to test out `ldnode`,
58
+
you will need the following:
59
+
60
+
1. A WebID profile and browser certificate from one of the Solid-compliant
61
+
identity providers, such as [databox.me](https://databox.me).
62
+
63
+
2. A server-side SSL certificate for `ldnode` to use (see the section below
64
+
on creating a self-signed certificate for testing).
65
+
66
+
While these steps are technically optional (since you could launch it in
67
+
HTTP/LDP-only mode), you will not be able to use any actual Solid features
68
+
without them.
69
+
70
+
#### Solid server mode (HTTPS / WebID enabled)
71
+
72
+
To start `ldnode` in Solid server mode, you will need to enable the `--webid`
73
+
flag, and also pass in a valid SSL key and certificate files:
**Note**: In order to support WebID+TLS authentication you will need `--webid` but also the flags `--cert` and `--key` to specify the keypair of your SSL certificate, since WebID+TLS will only work over `HTTPS`.
65
124
66
125
## Library
67
126
68
-
### Install
127
+
### Install Dependencies
69
128
70
129
```
71
130
npm install
72
131
```
73
132
74
-
### Usage
133
+
### Library Usage
75
134
76
135
The library provides two APIs:
77
136
78
-
-`ldnode.createServer(settings)`: starts a ready to use [Express](http://expressjs.com) app.
79
-
-`lnode(settings)`: creates an [Express](http://expressjs.com) that you can mount in your existing express app.
137
+
-`ldnode.createServer(settings)`: starts a ready to use
138
+
[Express](http://expressjs.com) app.
139
+
-`lnode(settings)`: creates an [Express](http://expressjs.com) that you can
140
+
mount in your existing express app.
80
141
81
-
In case the `settings` is not passed, then it will start with the following default settings.
142
+
In case the `settings` is not passed, then it will start with the following
143
+
default settings.
82
144
83
145
```javascript
84
146
{
@@ -98,11 +160,13 @@ In case the `settings` is not passed, then it will start with the following defa
98
160
}
99
161
```
100
162
101
-
Have a look at the following examples or in the [`examples/`](https://github.com/linkeddata/ldnode/tree/master/examples) folder for more complex ones
0 commit comments