bourgeoa · bourgeoa · Apr 3, 2023 · Apr 3, 2023 · Apr 3, 2023 · Apr 3, 2023
diff --git a/.acl b/.acl
@@ -0,0 +1,10 @@
+# Root ACL resource for the root
+@prefix acl: <http://www.w3.org/ns/auth/acl#>.
+@prefix foaf: <http://xmlns.com/foaf/0.1/>.
+
+<#public>
+    a acl:Authorization;
+    acl:agentClass foaf:Agent;  # everyone
+    acl:accessTo </>;
+    acl:default </common/>;
+    acl:mode acl:Read.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -5,9 +5,10 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
+    tags: ['*']
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   build:
@@ -16,11 +17,34 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [ '>=20.18.2' ]
         os: [ubuntu-latest]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
+
+    # extract repository name
+    - if: github.event_name == 'pull_request'
+      run: echo "REPO_NAME=${{ github.event.pull_request.head.repo.full_name }}" >> $GITHUB_ENV
+
+    - if: github.event_name != 'pull_request'
+      run: echo "REPO_NAME=${GITHUB_REPOSITORY}" >> $GITHUB_ENV
+
+    # extract branch name
+    - if: github.event_name == 'pull_request'
+      run: echo "BRANCH_NAME=${GITHUB_HEAD_REF}" >> $GITHUB_ENV
+
+    - if: github.event_name != 'pull_request'
+      run: echo "BRANCH_NAME=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV
+
+    # print repository name
+    - name: Get repository name
+      run: echo 'The repository name is' $REPO_NAME
+
+    # print branch name
+    - name: Get branch name
+      run: echo 'The branch name is' $BRANCH_NAME
+
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v1
       with:
@@ -29,9 +53,61 @@ jobs:
     # test code
     - run: npm run standard
     - run: npm run validate
-    - run: npm run nyc
+    - run: npm run c8
     # Test global install of the package
     - run: npm pack .
     - run: npm install -g solid-server-*.tgz
     # Run the Solid test-suite
-    - run: bash test/surface/run-solid-test-suite.sh
+    - run: bash test/surface/run-solid-test-suite.sh $BRANCH_NAME $REPO_NAME
+
+  # TODO: The pipeline should automate publication to npm, so that the docker build gets the correct version
+  #       This job will only dockerize solid-server@latest / solid-server@<tag-name> from npmjs.com!
+  docker-hub:
+    needs: build
+    name: Publish to docker hub
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v4
+
+      - uses: olegtarasov/get-tag@v2.1
+        id: tagName
+        with:
+          tagRegex: "v?(?<version>.*)"
+
+      - name: Lint dockerfile
+        working-directory: docker-image
+        run: pwd && ls -lah && make lint
+
+      - name: Run tests
+        working-directory: docker-image
+        run: SOLID_SERVER_VERSION=${{ steps.tagName.outputs.version }} make test
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: nodesolidserver/node-solid-server
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push
+        id: docker_build
+        uses: docker/build-push-action@v2
+        with:
+          context: ./docker-image/src
+          build-args: SOLID_SERVER_VERSION=${{ steps.tagName.outputs.version }}
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
diff --git a/.gitignore b/.gitignore
@@ -14,4 +14,5 @@
 /data
 /coverage
 /node_modules
-/npm-debug.log
+/npm-debug.log
+.history/
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-13.14.0
+v18.19.0
diff --git a/.well-known/.acl b/.well-known/.acl
@@ -0,0 +1,15 @@
+# ACL for the default .well-known/ resource
+# Server operators will be able to override it as they wish
+# Public-readable
+
+@prefix acl: <http://www.w3.org/ns/auth/acl#>.
+@prefix foaf: <http://xmlns.com/foaf/0.1/>.
+
+<#public>
+    a acl:Authorization;
+
+    acl:agentClass foaf:Agent;  # everyone
+
+    acl:accessTo </.well-known/>;
+
+    acl:mode acl:Read.
diff --git a/Dockerfile b/Dockerfile
@@ -4,6 +4,7 @@ FROM node:lts
 RUN mkdir -p /usr/src/app
 WORKDIR /usr/src/app
 COPY package.json /usr/src/app/
+COPY package-lock.json /usr/src/app/
 RUN npm install
 COPY . /usr/src/app
 

diff --git a/README.md b/README.md
@@ -9,6 +9,8 @@
 
 `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).
 
+The [solid test suite](https://github.com/nodeSolidServer/node-solid-server/blob/main/test/surface/run-solid-test-suite.sh) runs as part of GitHub Actions on this repository, ensuring that this server is always (to the best of our knowledge) fully spec compliant.
+
 ## Solid Features supported
 - [x] [Linked Data Platform](http://www.w3.org/TR/ldp/)
 - [x] [Web Access Control](http://www.w3.org/wiki/WebAccessControl)
@@ -28,12 +30,15 @@ You can install and run the server either using Node.js directly or using
 first approach, for the second approach see the section [use Docker](#use-docker)
 Section below.
 
+**Note**: If using Git for Windows, it is helpful to use the -verbose flag to see the progress of the install.
+
 To install, first install [Node](https://nodejs.org/en/) and then run the following
 
 ```bash
 $ npm install -g solid-server
 ```
 
+
 ### Run a single-user server (beginner)
 
 The easiest way to setup `solid-server` is by running the wizard. This will create a `config.json` in your current folder
@@ -64,6 +69,15 @@ $ solid start --root path/to/folder --port 8443 --ssl-key path/to/ssl-key.pem --
 # Solid server (solid v0.2.24) running on https://localhost:8443/
 ```
 
+By default, `solid` runs in `debug all` mode. To stop the debug logs, use `-q`, the quiet parameter.
+
+```bash
+$ DEBUG="solid:*" solid start -q
+# use quiet mode and set debug to all
+# DEBUG="solid:ACL" logs only debug.ACL's
+
+```
+
 ### Running in development environments
 
 Solid requires SSL certificates to be valid, so you cannot use self-signed certificates. To switch off this security feature in development environments, you can use the `bin/solid-test` executable, which unsets the `NODE_TLS_REJECT_UNAUTHORIZED` flag and sets the `rejectUnauthorized` option.
@@ -124,7 +138,7 @@ Your users will have a dedicated folder under `./data` at `./data/<username>.<yo
 > To use Gmail you may need to configure ["Allow Less Secure Apps"](https://www.google.com/settings/security/lesssecureapps) in your Gmail account unless you are using 2FA in which case you would have to create an [Application Specific](https://security.google.com/settings/security/apppasswords) password. You also may need to unlock your account with ["Allow access to your Google account"](https://accounts.google.com/DisplayUnlockCaptcha) to use SMTP.
 
 also add to `config.json`
-``` 
+```
   "useEmail": true,
   "emailHost": "smtp.gmail.com",
   "emailPort": "465",
@@ -192,6 +206,7 @@ $ solid start --help
     --multiuser                   Enable multi-user mode
     --idp [value]                 Obsolete; use --multiuser
     --no-live                     Disable live support through WebSockets
+    --no-prep                     Disable Per Resource Events
     --proxy [value]               Obsolete; use --corsProxy
     --cors-proxy [value]          Serve the CORS proxy on this path
     --suppress-data-browser       Suppress provision of a data browser
@@ -237,21 +252,27 @@ We have automatic builds set up, so commits to master will trigger a build of ht
 
 ### Development usage
 
-If you want to use Docker in development, then you can build it locally with:
+If you want to use Docker in development, you can build and run the image locally with either docker-compose —
 
 ```bash
 git clone https://github.com/solid/node-solid-server
 cd node-solid-server
-docker build -t node-solid-server .
+docker-compose up -d
 ```
 
-Run with:
+ — or these manual commands —
+
 ```bash
+git clone https://github.com/solid/node-solid-server
+cd node-solid-server
+docker build -t node-solid-server .
+
 docker run -p 8443:8443 --name solid 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 
+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. --
 
 ```pre
@@ -260,16 +281,16 @@ it in your local (/etc/)hosts file in line with the account and subdomain, i.e.
 
 You can modify the config within the docker container as follows:
 
- - Copy the `config.json` to the current directory with: 
+ - Copy the `config.json` to the current directory with:
    ```bash
    docker cp solid:/usr/src/app/config.json .
    ```
  - Edit the `config.json` file
- - Copy the file back with 
+ - Copy the file back with
    ```bash
    docker cp config.json solid:/usr/src/app/
    ```
- - Restart the server with 
+ - Restart the server with
    ```bash
    docker restart solid
    ```
@@ -362,7 +383,8 @@ In order to really get a feel for the Solid platform, and to test out `solid`,
 you will need the following:
 
 1. A WebID profile and browser certificate from one of the Solid-compliant
-    identity providers, such as [solid.community](https://solid.community).
+    identity providers, such as [solidcommunity.net](bourgeoa
+    community.net).
 
 2. A server-side SSL certificate for `solid` to use (see the section below
     on creating a self-signed certificate for testing).
@@ -444,7 +466,7 @@ You can receive or provide help too:
 - [NSS Gitter channel](https://gitter.im/solid/node-solid-server) for specific (installation) advice about this code base
 - [Create a new issue](https://github.com/solid/node-solid-server/issues/new) to report bugs
 - [Fix an issue](https://github.com/solid/node-solid-server/issues)
-- Reach out to Jackson at jacksonm@inrupt.com to become more involved in maintaining Node Solid Server
+- Reach out to @bourgeoa at alain.bourgeois10@gmail.com to become more involved in maintaining Node Solid Server
 
 Have a look at [CONTRIBUTING.md](https://github.com/solid/node-solid-server/blob/master/CONTRIBUTING.md).
 

diff --git a/bin/config.json b/bin/config.json
@@ -0,0 +1,18 @@
+{
+  "root": "/Users/imyshor/Projects/solid/solidos/workspaces/node-solid-server/bin/data",
+  "port": "8443",
+  "serverUri": "https://localhost:8443",
+  "webid": false,
+  "mount": "/",
+  "configPath": "./config",
+  "configFile": "./config.json",
+  "dbPath": "./.db",
+  "sslKey": "../",
+  "sslCert": "../",
+  "multiuser": false,
+  "server": {
+    "name": "localhost",
+    "description": "",
+    "logo": ""
+  }
+}
diff --git a/bin/lib/options.js b/bin/lib/options.js
@@ -50,7 +50,7 @@ module.exports = [
   },
   {
     name: 'config-path',
-    question: 'Path to the config directory (for example: /etc/solid-server)',
+    question: 'Path to the config directory (for example: ./config)',
     default: './config',
     prompt: true
   },
@@ -143,6 +143,12 @@ module.exports = [
     flag: true,
     default: false
   },
+  {
+    name: 'no-prep',
+    help: 'Disable Per Resource Events',
+    flag: true,
+    default: false
+  },
   // {
   //   full: 'default-app',
   //   help: 'URI to use as a default app for resources (default: https://linkeddata.github.io/warp/#/list/)'

diff --git a/bin/solid b/bin/solid
@@ -1,3 +1,3 @@
-#!/usr/bin/env node
+#!/usr/bin/env -S node --experimental-require-module
 const startCli = require('./lib/cli')
 startCli()
diff --git a/bin/solid.js b/bin/solid.js
@@ -1,3 +1,3 @@
-#!/usr/bin/env node
+#!/usr/bin/env -S node --experimental-require-module
 const startCli = require('./lib/cli')
 startCli()