Merge branch 'main' into versions/4.0.0

This commit is contained in:
Joachim Van Herwegen 2022-03-09 11:16:35 +01:00
commit 44dd56d4f6
5 changed files with 34 additions and 22 deletions

View File

@ -15,8 +15,8 @@ jobs:
lint: lint:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: actions/setup-node@v2 - uses: actions/setup-node@v3
with: with:
node-version: '16.x' node-version: '16.x'
- run: npm ci --ignore-scripts - run: npm ci --ignore-scripts
@ -25,8 +25,8 @@ jobs:
validate-components: validate-components:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: actions/setup-node@v2 - uses: actions/setup-node@v3
with: with:
node-version: '16.x' node-version: '16.x'
- run: npm ci - run: npm ci
@ -50,13 +50,13 @@ jobs:
timeout-minutes: 10 timeout-minutes: 10
steps: steps:
- name: Use Node.js ${{ matrix.node-version }} - name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2 uses: actions/setup-node@v3
with: with:
node-version: ${{ matrix.node-version }} node-version: ${{ matrix.node-version }}
- name: Ensure line endings are consistent - name: Ensure line endings are consistent
run: git config --global core.autocrlf input run: git config --global core.autocrlf input
- name: Check out repository - name: Check out repository
uses: actions/checkout@v2 uses: actions/checkout@v3
- name: Install dependencies and run build scripts - name: Install dependencies and run build scripts
run: npm ci run: npm ci
- name: Type-check tests - name: Type-check tests
@ -96,11 +96,11 @@ jobs:
timeout-minutes: 10 timeout-minutes: 10
steps: steps:
- name: Use Node.js ${{ matrix.node-version }} - name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2 uses: actions/setup-node@v3
with: with:
node-version: ${{ matrix.node-version }} node-version: ${{ matrix.node-version }}
- name: Check out repository - name: Check out repository
uses: actions/checkout@v2 uses: actions/checkout@v3
- name: Install dependencies and run build scripts - name: Install dependencies and run build scripts
run: npm ci run: npm ci
- name: Run integration tests - name: Run integration tests
@ -117,13 +117,13 @@ jobs:
timeout-minutes: 10 timeout-minutes: 10
steps: steps:
- name: Use Node.js ${{ matrix.node-version }} - name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2 uses: actions/setup-node@v3
with: with:
node-version: ${{ matrix.node-version }} node-version: ${{ matrix.node-version }}
- name: Ensure line endings are consistent - name: Ensure line endings are consistent
run: git config --global core.autocrlf input run: git config --global core.autocrlf input
- name: Check out repository - name: Check out repository
uses: actions/checkout@v2 uses: actions/checkout@v3
- name: Install dependencies and run build scripts - name: Install dependencies and run build scripts
run: npm ci run: npm ci
- name: Run integration tests - name: Run integration tests
@ -151,7 +151,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v2 uses: actions/checkout@v3
- name: Docker meta - name: Docker meta
id: meta id: meta
uses: docker/metadata-action@v3 uses: docker/metadata-action@v3
@ -193,7 +193,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v2 uses: actions/checkout@v3
with: with:
ref: ${{ github.ref }} ref: ${{ github.ref }}
- name: Docker meta - name: Docker meta
@ -225,14 +225,14 @@ jobs:
docs: docs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: actions/setup-node@v2 - uses: actions/setup-node@v3
with: with:
node-version: '16.x' node-version: '16.x'
- run: npm ci --ignore-scripts - run: npm ci --ignore-scripts
- run: npm run docs - run: npm run docs
- name: Save docs - name: Save docs
uses: actions/upload-artifact@v2 uses: actions/upload-artifact@v3
with: with:
name: docs name: docs
path: docs path: docs
@ -248,7 +248,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
if: startsWith(github.ref, 'refs/tags/v') if: startsWith(github.ref, 'refs/tags/v')
steps: steps:
- uses: actions/download-artifact@v2 - uses: actions/download-artifact@v3
with: with:
name: docs name: docs
path: docs path: docs

View File

@ -14,15 +14,15 @@ jobs:
matrix: matrix:
branch: branch:
- 'main' - 'main'
- 'versions/3.0.0' - 'versions/4.0.0'
timeout-minutes: 10 timeout-minutes: 10
steps: steps:
- name: Use Node.js 16.x - name: Use Node.js 16.x
uses: actions/setup-node@v2 uses: actions/setup-node@v3
with: with:
node-version: 16.x node-version: 16.x
- name: Check out the project - name: Check out the project
uses: actions/checkout@v2 uses: actions/checkout@v3
with: with:
ref: ${{ matrix.branch }} ref: ${{ matrix.branch }}
- name: Install dependencies and run build scripts - name: Install dependencies and run build scripts
@ -56,13 +56,13 @@ jobs:
branch-name: ${{ matrix.branch }} branch-name: ${{ matrix.branch }}
- name: Save the reports - name: Save the reports
if: always() if: always()
uses: actions/upload-artifact@v2 uses: actions/upload-artifact@v3
with: with:
name: ${{ steps.sanitize.outputs.sanitized-branch-name }} reports name: ${{ steps.sanitize.outputs.sanitized-branch-name }} reports
path: reports path: reports
- name: Save the server output - name: Save the server output
if: always() if: always()
uses: actions/upload-artifact@v2 uses: actions/upload-artifact@v3
with: with:
name: ${{ steps.sanitize.outputs.sanitized-branch-name }} server output name: ${{ steps.sanitize.outputs.sanitized-branch-name }} server output
path: server-output.log path: server-output.log

View File

@ -83,6 +83,9 @@ docker run --rm -p 3000:3000 -it solidproject/community-server -c config/default
docker run --rm -v ~/solid-config:/config -p 3000:3000 -it solidproject/community-server -c /config/my-config.json docker run --rm -v ~/solid-config:/config -p 3000:3000 -it solidproject/community-server -c /config/my-config.json
``` ```
### 🗃️ Helm Chart
The official [Helm](https://helm.sh/) Chart for Kubernetes deployment is maintained and published on [ArtifactHUB](https://artifacthub.io/packages/helm/idlab-gent/css).
## 🔧 Configuring the server ## 🔧 Configuring the server
The Community Solid Server is designed to be flexible The Community Solid Server is designed to be flexible
such that people can easily run different configurations. such that people can easily run different configurations.

View File

@ -34,6 +34,13 @@ These changes are relevant if you wrote custom modules for the server that depen
This is important for anyone who starts the server from code. This is important for anyone who starts the server from code.
- When logging in, a consent screen will now provide information about the client. - When logging in, a consent screen will now provide information about the client.
### Data migration
The following actions are required if you are upgrading from a v2 server and want to retain your data.
Due to changes in the keys used by the IDP, you will need to delete the stored keys and sessions.
If you are using a file backend, delete the `.internal/idp/` folder in your data folder and restart the server.
This will not delete the user accounts, but users will have to log in again.
### Configuration changes ### Configuration changes
You might need to make changes to your v2 configuration if you use a custom config. You might need to make changes to your v2 configuration if you use a custom config.
@ -42,7 +49,7 @@ The `@context` needs to be updated to
The following changes pertain to the imports in the default configs: The following changes pertain to the imports in the default configs:
- A new configuration option needs to be imported: - A new configuration option needs to be imported:
- `/app/variables/default/json` contains everything related to parsing CLI arguments - `/app/variables/default.json` contains everything related to parsing CLI arguments
and assigning values to variables. and assigning values to variables.
The following changes are relevant for v2 custom configs that replaced certain features. The following changes are relevant for v2 custom configs that replaced certain features.

View File

@ -10,4 +10,6 @@ RESOURCE_SERVER_ROOT=http://localhost:3000
TEST_CONTAINER=/alice/ TEST_CONTAINER=/alice/
quarkus.log.category."ResultLogger".level=INFO quarkus.log.category."ResultLogger".level=INFO
quarkus.log.category."com.intuit.karate".level=DEBUG quarkus.log.category."com.intuit.karate".level=DEBUG
quarkus.log.category."org.solid.testharness.http.Client".level=DEBUG
quarkus.log.category."org.solid.testharness.http.AuthManager".level=DEBUG
MAXTHREADS=1 MAXTHREADS=1