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
Copy file name to clipboardExpand all lines: EXAMPLES.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,50 +1,50 @@
1
1
Examples
2
2
========
3
3
4
-
ldnode binary
4
+
solid binary
5
5
-------------
6
6
7
-
ldnode can be started on its own by using the ldnode binary. Below are some examples with common configurations.
7
+
solid can be started on its own by using the solid binary. Below are some examples with common configurations.
8
8
9
-
* Starting ldnode as an HTTP server.
9
+
* Starting solid as an HTTP server.
10
10
11
-
`$ ldnode --root /var/www`
11
+
`$ solid --root /var/www`
12
12
13
-
* Starting ldnode as an HTTPS server with WebID+TLS authentication. This parameter requires that the user specifies the location of the key and the certificate used to start the HTTPS server with the help of the appropriate parameters.
13
+
* Starting solid as an HTTPS server with WebID+TLS authentication. This parameter requires that the user specifies the location of the key and the certificate used to start the HTTPS server with the help of the appropriate parameters.
* Start HTTPS with custom error pages. ldnode will look for a file in the specified directory of the form <error-code>.html. If it's not found it will default to node's error page.
17
+
* Start HTTPS with custom error pages. solid will look for a file in the specified directory of the form <error-code>.html. If it's not found it will default to node's error page.
*ldnode makes use of special files used for things such as access control, metadata management, subscription to changes, etc. These files are recognized by ldnode because of their suffix, which can be customized with the command line options that start with 'suffix'.
21
+
*solid makes use of special files used for things such as access control, metadata management, subscription to changes, etc. These files are recognized by solid because of their suffix, which can be customized with the command line options that start with 'suffix'.
ldnode can be started from an existing node application. There are two options available: creating the ldnode server on its own or creating a router that can be attached to an existing Express app.
28
+
solid can be started from an existing node application. There are two options available: creating the solid server on its own or creating a router that can be attached to an existing Express app.
29
29
30
-
For the first case, the createServer is a wrapper around the ldnode method which can be used as follows:
30
+
For the first case, the createServer is a wrapper around the solid method which can be used as follows:
31
31
32
32
```
33
-
var ldnode = require('ldnode');
33
+
var solid = require('solid-server');
34
34
var options = {
35
35
root: /var/www/
36
-
} //an object specifying ldnode options (equivalent to the options provided by the command line interface).
36
+
} //an object specifying solid options (equivalent to the options provided by the command line interface).
37
37
var server;
38
-
var app = ldnode.createServer(options);
38
+
var app = solid.createServer(options);
39
39
app.listen(8080);
40
40
```
41
41
42
-
In the second case, the ldnode method is used directly and the returned express app can be combined with an existing application.
42
+
In the second case, the solid method is used directly and the returned express app can be combined with an existing application.
43
43
44
44
```
45
-
var existingApp; //Some existing Express app independent of ldnode.
45
+
var existingApp; //Some existing Express app independent of solid.
> [Solid](https://github.com/solid) server in [NodeJS](https://nodejs.org/)
8
8
9
-
Ldnode lets you run a Solid server on top of the file-system. You can use it as a [command-line tool](https://github.com/linkeddata/ldnode/blob/master/README.md#command-line-usage) (easy) or as a [library](https://github.com/linkeddata/ldnode/blob/master/README.md#library-usage) (advanced).
9
+
`solid-server` lets you run a Solid server on top of the file-system. You can use it as a [command-line tool](https://github.com/solid/node-solid-server/blob/master/README.md#command-line-usage) (easy) or as a [library](https://github.com/solid/node-solid-server/blob/master/README.md#library-usage) (advanced).
10
10
11
11
## Solid Features supported
12
12
-[x][Linked Data Platform](http://www.w3.org/TR/ldp/)
@@ -25,51 +25,51 @@ Ldnode lets you run a Solid server on top of the file-system. You can use it as
25
25
To install, first install [Node](https://nodejs.org/en/) and then run the following
26
26
27
27
```bash
28
-
$ npm install -g ldnode
28
+
$ npm install -g solid-server
29
29
```
30
30
31
31
### Run a single-user server (beginner)
32
32
33
-
To run your server, simply run `ldnode` with the following flags:
33
+
To run your server, simply run `solid` with the following flags:
Your users will have a dedicated folder under `./accounts`. Also, your root domain's website will be in `./accounts/yourdomain.tld`. New users can create accounts on `/accounts/new` and create new certificates on `/accounts/cert`. An easy-to-use sign-up tool is found on `/accounts`.
@@ -79,9 +79,9 @@ If you don't want WebID Authentication and Web Access Control, you can run a sim
0 commit comments