diff --git a/README.md b/README.md index b8328b4f6..a3653bc1e 100644 --- a/README.md +++ b/README.md @@ -229,18 +229,27 @@ docker run -p 8443:8443 --name solid nodesolidserver/node-solid-server This will enable you to login to solid on https://localhost:8443 and then create a new account but not yet use that account. After a new account is made you will need to create an entry for -it in your local (/etc/)hosts file in line with the account and subdomain i.e. - +it in your local (/etc/)hosts file in line with the account and subdomain, i.e. -- +```pre 127.0.0.1 newsoliduser.localhost - +``` Then you'll be able to use solid as intended. You can modify the config within the docker container as follows: - - Copy the config to the current directory with: `docker cp solid:/usr/src/app/config.json .` + - Copy the config to the current directory with: + ``` + docker cp solid:/usr/src/app/config.json . + ``` - Edit the `config.json` file - - Copy the file back with `docker cp config.json solid:/usr/src/app/` - - Restart the server with `docker restart solid` + - Copy the file back with + ``` + docker cp config.json solid:/usr/src/app/ + ``` + - Restart the server with + ``` + docker restart solid + ``` If you want to help improve the Docker image, then you can build it locally with: ```bash @@ -248,7 +257,7 @@ git clone https://github.com/solid/node-solid-server cd node-solid-server docker build . ``` -We have automatic builds set up so commits to master will trigger a build of https://hub.docker.com/r/nodesolidserver/node-solid-server. +We have automatic builds set up, so commits to master will trigger a build of https://hub.docker.com/r/nodesolidserver/node-solid-server. ## Library Usage @@ -272,18 +281,18 @@ default settings. ```javascript { - cache: 0, // Set cache time (in seconds), 0 for no cache - live: true, // Enable live support through WebSockets - root: './', // Root location on the filesystem to serve resources - secret: 'node-ldp', // Express Session secret key - cert: false, // Path to the ssl cert - key: false, // Path to the ssl key - mount: '/', // Where to mount Linked Data Platform - webid: false, // Enable WebID+TLS authentication - suffixAcl: '.acl', // Suffix for acl files - corsProxy: false, // Where to mount the CORS proxy - errorHandler: false, // function(err, req, res, next) to have a custom error handler - errorPages: false // specify a path where the error pages are + cache: 0, // Set cache time (in seconds), 0 for no cache + live: true, // Enable live support through WebSockets + root: './', // Root location on the filesystem to serve resources + secret: 'node-ldp', // Express Session secret key + cert: false, // Path to the ssl cert + key: false, // Path to the ssl key + mount: '/', // Where to mount Linked Data Platform + webid: false, // Enable WebID+TLS authentication + suffixAcl: '.acl', // Suffix for acl files + corsProxy: false, // Where to mount the CORS proxy + errorHandler: false, // function(err, req, res, next) to have a custom error handler + errorPages: false // specify a path where the error pages are } ```