Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inrupt/pod-server
Solid server package that bind together solid-idp, wac-ldp, and websockets-pubsub.
https://github.com/inrupt/pod-server
Last synced: 5 days ago
JSON representation
Solid server package that bind together solid-idp, wac-ldp, and websockets-pubsub.
- Host: GitHub
- URL: https://github.com/inrupt/pod-server
- Owner: inrupt
- License: mit
- Archived: true
- Created: 2019-05-04T07:15:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-14T08:32:22.000Z (over 3 years ago)
- Last Synced: 2024-07-29T04:42:19.277Z (3 months ago)
- Language: HTML
- Size: 4.03 MB
- Stars: 40
- Watchers: 15
- Forks: 12
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - inrupt/pod-server - Solid server package that bind together solid-idp, wac-ldp, and websockets-pubsub. (others)
README
# ⛔ Deprecated
This repository is no longer maintained by Inrupt. Of course you can clone the repository if you wish to work in the code yourself.
There are maintained open source Solid servers such as [CSS](https://github.com/solid/community-server) which are still supported.
# pod-server
[](https://travis-ci.org/inrupt/pod-server)
[](https://coveralls.io/github/inrupt/pod-server?branch=master)
[](https://greenkeeper.io/)
Solid server package that bind together
[solid-idp](https://github.com/inrupt/solid-idp),
[wac-ldp](https://github.com/inrupt/wac-ldp),
[websockets-pubsub](https://github.com/inrupt/websockets-pubsub), and the
[data-browser](https://github.com/linkeddata/mashlib).
# Running on localhost, NSS compat mode
```sh
git clone https://github.com/inrupt/pod-server
cd pod-server
git checkout dev
npm install
cp config.json-local-nss-compat config.json
cp -r ../../solid/node-solid-server/.db .
cp -r ../../solid/node-solid-server/data .
npm run build
DEBUG=* npm start
```
# Architecture
## The Solid Spec Protocols
This server implements version 0.7 of the [Solid spec](https://github.com/solid/solid-spec). This is a diagram of the layering of protocols:
## Functions of the server
Regardless of the layering of protocols, we have a layering of functional components in the software, which looks as follows:
It shows how the different functional units of the server (persistence, auth, data interface, etc.) depend on each other.
## Code modules
This server delegates some of its functions to npm modules it depends on.
### solid-idp
The [solid-idp](https://github.com/inrupt/solid-idp) module implements the webid-oidc functionality. Note that a pod-server makes no explicit distinction between local and remote users. In terms of organization, each user gets an identity and a storage space, and that identity is the first to be granted full access to the empty storage space upon its creation. But in technical terms the IDP and the storage are almost entirely separate. The only two connections between them is that the IDP proves control of a profile URL (web id) that points to a document on the storage space, and that the IDP's authorize dialog will edit the list of trusted apps in that profile whenever the user authorizes a new third-party web app.
The IDP exposes a koa handler to the pod-server. Apart from that, it sends out emails for verifications and password reminders. It also exposes an event when an account is created or deleted, and its dialogs will do xhr edits to trustedApps.
### wac-ldp
The [wac-ldp](https://github.com/inrupt/wac-ldp) module is the central part of the pod-server. It exposes a koa handler, which pod-server consumes.
It also emits change events, which the pod-server used to know when to call the `Hub#publish` method from the websocket-pubsub module (see below).
Apart from that, it exposes a number of interfaces which the websockets-pubsub module consumes:
* a function to check [updates-via tickets](https://github.com/inrupt/websockets-pubsub/issues/2#issuecomment-489319630)
* a function for checking whether a given webId has read access to a given resource
### websockets-pubsub
The [websockets-pubsub](https://github.com/inrupt/websockets-pubsub) module exposes a 'Hub' object, with a websocket-onconnection handler and a publish method
### html statics
Although some pod providers may choose to replace `static/index.html` with the [data-browser](https://github.com/linkeddata/mashlib). This is the content which the pod-server serves when a user visits the pod-server with their browser.
Published under an MIT license by inrupt, Inc.
Contributors:
* Michiel de Jong
* Jackson Morgan
* Ruben Verborgh
* Kjetil Kjernsmo
* Pat McBennett
* Justin Bingham
* Sebastien Dubois