https://github.com/remotestorage/remotestorage-server

Core HTTP behavior of a remoteStorage server, compliant with the latest three versions of the IETF draft
https://github.com/remotestorage/remotestorage-server

Last synced: 5 days ago
JSON representation

Core HTTP behavior of a remoteStorage server, compliant with the latest three versions of the IETF draft

• Host: GitHub
• URL: https://github.com/remotestorage/remotestorage-server
• Owner: remotestorage
• Created: 2014-01-27T03:27:14.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2015-06-20T02:01:15.000Z (over 9 years ago)
• Last Synced: 2024-10-05T13:34:22.059Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 416 KB
• Stars: 56
• Watchers: 12
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

• awesome-starred - remotestorage/remotestorage-server - Core HTTP behavior of a remoteStorage server, compliant with the latest three versions of the IETF draft (others)

README

        
# remotestorage-server

The remoteStorage core from https://github.com/remotestorage/starter-kit

[![Build Status](https://secure.travis-ci.org/remotestorage/remotestorage-server.png)](http://travis-ci.org/remotestorage/remotestorage-server)

[![devDependency Status](https://david-dm.org/remotestorage/remotestorage-server/dev-status.png)](https://david-dm.org/remotestorage/remotestorage-server#info=devDependencies)

[![Code Climate](https://codeclimate.com/github/remotestorage/remotestorage-server.png)](https://codeclimate.com/github/remotestorage/remotestorage-server)

# Interface

````js

var remotestorageServer = require('remotestorage-server'), fs = require('fs'), https = require('https');

var specVersion = 'draft-dejong-remotestorage-02';

// Set up the token store, this is responsible for storing OAuth tokens

var tokenStore = {

    _data: {},

    get: function(username, token, cb) {

        cb(null, this._data[username+':'+token]);

    },

    set: function(username, token, scopes, cb) {

        this._data[username+':'+token] = scopes; 

        cb(null); 

    }

};

// Set up the data store, this is responsible for storing the files saved on the RemoteStorage server

var dataStore =  {

    _data: {},

    get: function(username, key, cb) {

        cb(null, this._data[username + ':' + key]);

    },

    set: function(username, key, buf, cb) {

        this._data[username + ':' + key] = buf;

        cb(null);

    }

};

var serverInstance = new RemotestorageServer(specVersion, tokenStore, dataStore);

var httpsConfig = {

    key: fs.readFileSync('./tls.key'),

    cert: fs.readFileSync('./tls.cert'),

    ca: fs.readFileSync('./ca.pem')

  };

//add access tokens (you would typically do this from an ajax call in your OAuth dialog):

tokenStore._data['me:SECRET'] = serverInstance.makeScopePaths(['tasks:rw', 'contacts:r']);

tokenStore._data['me:GOD'] = serverInstance.makeScopePaths(['*:rw']);

//serve storage:

https.createServer(httpsConfig, serverInstance.storage).listen(8000);

    

//get the link for including in your webfinger record:

var link = remotestorageServer.getWebfingerLink('https', 'example.com', 8000, 'me', 'https://example.com/auth/me');

````

You will also need:

* a webfinger server, serving your webfinger record on path `/.well-known/webfinger` on port 443 (or on port 80 when testing on localhost).

* an html page which serves as an OAuth dialog

See https://github.com/remotestorage/starter-kit for an examples of both.