Encounters at an endpoint.
- HTTP server and command-line RDF tool to get/send, serialise data.
- Server can receive HTTP
HEAD,OPTIONS,GET,POST,PUTrequests. Content negotiation withtext/turtle,application/ld+json,text/html,application/xhtml+xml. It can serialize from HTML+RDFa, but does not serialize to HTML+RDFa. - Spec coverage:
- Tested: Conforming Linked Data Notifications sender, receiver, sender.
- Untested: Linked Data Platform - probably does most things, and only BasicContainer.
- Totally untested and probably only small parts: Web Annotation Protocol
- Basic implementation of the the ActiviyPub Outbox mechanism.
- No authenication/authorisation mechanism
- Basic configuration to set constraints on a directory (size/max)
- Basic configuration to handle stuff like https://linkedresearch.org/cloud
This server was initially built for LDN tests but then decided to support/test dokieli's needs (source: https://github.com/linkeddata/dokieli) and do LDP etc.
Dive into issues because it is fun.
If you use Docker, try the image csarven/mayktso:
docker run -p 3000:3000 -d csarven/mayktsodocker volume create mayktso-data
docker run --name mayktso --restart=always \
--mount source=mayktso-data,target=/mayktso \
-p 3000:3000 \
-d csarven/mayktsoTo update:
docker pull csarven/mayktso
docker stop mayktso
docker rm mayktso
.. then recreate using the docker run from above.
$ git clone https://github.com/csarven/mayktso
$ cd mayktso
$ npm installServer runs on http://localhost:3000/ by default:
$ node index.jsOptional config use: cp config.json.default config.json
{
"port": "3000",
"sslKey": "/path/to/privkey.pem",
"sslCert": "/path/to/cert.pem",
"proxyURL": "http://example.org/proxy?uri=",
"rootPath": ".",
"basePath": "",
"inboxPath": "inbox/",
"queuePath": "queue/",
"maxPayloadSize": 100000,
"maxResourceCount": 10,
}- Defaults will be used for omitted key/values (except
sslKey/sslCertare unused) basePathis useful when running as a reverse proxy in a dedicated directory (e.g., Apache)
ProxyPass /foo/ https://localhost:3000/
ProxyPassReverse /foo/ https://localhost:3000/so that http://example.org/foo/bar resolves, otherwise, server only sees /bar
e.g., basePath: "/foo/bar/"
-
inboxPathandqueuePathare relative to root e.g., http://localhost:3000/{inbox,queue}/ -
queue is used for HTTP 202 responses (default for payload above maxPayloadSize in bytes). Status: Testing
-
rootPathdefaults to the current directory (.) or a full path can be specified. Requests are relative to this location. -
maxPayloadSizeis for POSTs (as the name suggests) -
maxResourceCountis for number of notifications to keep in inbox/ or queue -
Simple data shape check that's based off https://linkedresearch.org/cloud 's needs. It is triggered by having a line like this
"checkDataShape": [ { "uri": "inbox/linkedresearch.org/cloud/" } ]. This needs to be better documented and built further.
$ node index.js --help
mayktso: https://github.com/csarven/mayktso
* Running without parameter/option starts server, otherwise:
* Usage: node index.js [parameter] [options]
[parameter]
--help
--discoverInbox <URI> Discover a target's Inbox
--getNotifications <URI> Get the notifications contained in an Inbox
--head <URI> Headers of a URI
--options <URI> Check the options of a URI
--get <URI> [options] Dereference a resource to RDF
--post <URI> [options] Send notification to Inbox
--put <URI> [options] Store data under a URI
[options]
--accept (m, default: application/ld+json)
--contentType (m, default: application/ld+json)
--slug string
-d, --data <data>
-o, --outputType (m, default: application/ld+json)
m: mimetype or format; jsonld, turtle$ node index.js --discoverInbox http://localhost:3000/ --accept \
application/ld+json
$ node index.js --getNotifications http://localhost:3000/inbox/abc --accept \
application/ld+json
$ node index.js --head http://localhost:3000/
$ node index.js --get http://localhost:3000/ --accept application/ld+json
$ node index.js --post http://localhost:3000/inbox/ --slug foo \
--contentType application/ld+json -d \
'[{"@id":"http://example.org/foo","http://schema.org/name":"Foo"}]'
$ node index.js --put http://localhost:3000/inbox/ --contentType \
application/ld+json -d \
'[{"@id":"http://example.org/foo","http://schema.org/name":"Foo"}]'Or just curl:
# Get target URL
$ curl -i -H'Accept: application/ld+json' http://localhost:3000/
$ curl -I -H'Accept: application/ld+json' http://localhost:3000/
$ curl -i -X OPTIONS -H'Accept: application/ld+json' http://localhost:3000/
# Send to Inbox
$ curl -i -X POST -H'Content-Type: application/ld+json' \
-d '[{"@id":"","http://schema.org/name":"Foo"}]' http://localhost:3000/inbox/
$ curl -i -X POST -H'Content-Type: text/turtle' \
-d '<> <http://schema.org/name> "Bar" .' http://localhost:3000/inbox/
# Get Inbox URL
$ curl -i -H'Accept: application/ld+json' http://localhost:3000/inbox/
$ curl -i -H'Accept: application/ld+json, text/turtle' \
http://localhost:3000/inbox/
$ curl -i -H'Accept: text/turtle, application/ld+json' \
http://localhost:3000/inbox/
$ curl -I -H'Accept: application/ld+json' http://localhost:3000/inbox/
$ curl -I -H'Accept: text/turtle' http://localhost:3000/inbox/
# Location header in POST response
$ curl -i http://localhost:3000/inbox/abc
$ curl -i -H'Accept: application/ld+json' http://localhost:3000/inbox/abc
$ curl -i -H'Accept: text/turtle' http://localhost:3000/inbox/abc
$ curl -i -H'Accept: application/ld+json, text/turtle' \
http://localhost:3000/inbox/abc
$ curl -i -H'Accept: text/turtle, application/ld+json' \
http://localhost:3000/inbox/abc
$ curl -I http://localhost:3000/inbox/abc
$ curl -I -H'Accept: application/ld+json' http://localhost:3000/inbox/abc
$ curl -i -X OPTIONS -H'Accept: application/ld+json' \
http://localhost:3000/inbox/abcSee the files LICENSE and NOTICE for required notices.
- mayktso is based on Linked Data Platform mechanisms
- Linked Data Notifications conformant (use mayktso as a receiver for your Inbox)
- Motived by node-solid-server
- Compliments dokieli
- Amy Guy
- Benjamin Young
- Dmitri Zagidulin
- Ruben Taelman
- Sarven Capadisli (maintainer)
- Stian Soiland-Reyes
- Your name here. :)
- Use it! Break things.
- Report issues and document.
- Fix issues.
- Request new features.
- .. and however else you want to contribute.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent