Skip to content

Commit 3c2fb92

Browse files
Integrate Nicola's feedback/comments
1 parent fe2da76 commit 3c2fb92

1 file changed

Lines changed: 33 additions & 31 deletions

File tree

‎README.md‎

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,28 @@ Options:
5252

5353
### Running the server
5454

55+
#### Solid server mode (HTTPS / WebID enabled)
56+
57+
To start `ldnode` in Solid server mode, you will need to enable the `--webid`
58+
flag, and also pass in a valid SSL key and certificate files:
59+
60+
```bash
61+
ldnode --webid --port 8443 --cert /path/to/cert --key /path/to/key
62+
```
63+
64+
#### LDP-only server mode (HTTP, no WebID)
65+
66+
You can also use `ldnode` as a Linked Data Platform server in HTTP mode (note
67+
that this will not support WebID authentication, and so will not be able to use
68+
any Solid apps such as the default [Warp](https://github.com/linkeddata/warp)
69+
app).
70+
71+
```bash
72+
ldnode --port 8080
73+
```
74+
75+
### Testing `ldnode` Locally
76+
5577
#### Pre-Requisites
5678

5779
In order to really get a feel for the Solid platform, and to test out `ldnode`,
@@ -67,16 +89,7 @@ While these steps are technically optional (since you could launch it in
6789
HTTP/LDP-only mode), you will not be able to use any actual Solid features
6890
without them.
6991

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:
74-
75-
```bash
76-
ldnode --webid --port 8443 --cert /path/to/cert --key /path/to/key
77-
```
78-
79-
#### Creating a self-signed certificate
92+
#### Creating a certificate for local testing
8093

8194
When deploying `ldnode` in production, we recommend that you go the
8295
usual Certificate Authority route to generate your SSL certificate (as you
@@ -111,15 +124,18 @@ Accessing most Solid apps (such as Warp) will prompt you to select your browser
111124
side certificate which contains a WebID from a Solid storage provider (see
112125
the [pre-requisites](#pre-requisites) discussion above).
113126

114-
#### LDP-only server mode (HTTP, no WebID)
115-
116-
You can also use `ldnode` as a Linked Data Platform server in HTTP mode (note
117-
that this will not support WebID authentication, and so will not be able to use
118-
any Solid apps such as the default [Warp](https://github.com/linkeddata/warp)
119-
app).
127+
#### Running the Unit Tests
120128

121129
```bash
122-
ldnode --port 8080
130+
$ npm test
131+
# running the tests with logs
132+
$ DEBUG="ldnode:*" npm test
133+
```
134+
135+
In order to test a single component, you can run
136+
137+
```javascript
138+
npm run test-(acl|formats|params|patch)
123139
```
124140

125141
## Library
@@ -203,20 +219,6 @@ Run your app with the `DEBUG` variable set:
203219
$ DEBUG="ldnode:*" node app.js
204220
```
205221

206-
## Testing
207-
208-
```bash
209-
$ npm test
210-
# running the tests with logs
211-
$ DEBUG="ldnode:*" npm test
212-
```
213-
214-
In order to test a single component, you can run
215-
216-
```javascript
217-
npm run test-(acl|formats|params|patch)
218-
```
219-
220222
## Contributing
221223

222224
`ldnode` is only possible due to the excellent work of the following contributors:

0 commit comments

Comments
 (0)