Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sockethub/sockethub

A multi-protocol gateway for the Web using ActivityStream messages.
https://github.com/sockethub/sockethub

activity-object activity-stream irc javascript messaging nodejs polyglot proxy redis rss socket-io sockethub unhosted websockets xmpp

Last synced: 28 days ago
JSON representation

A multi-protocol gateway for the Web using ActivityStream messages.

Host: GitHub
URL: https://github.com/sockethub/sockethub
Owner: sockethub
License: lgpl-3.0
Created: 2012-12-16T00:14:22.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2024-10-01T01:33:45.000Z (about 1 month ago)
Last Synced: 2024-10-03T17:28:52.793Z (about 1 month ago)
Topics: activity-object, activity-stream, irc, javascript, messaging, nodejs, polyglot, proxy, redis, rss, socket-io, sockethub, unhosted, websockets, xmpp
Language: TypeScript
Homepage: http://sockethub.org
Size: 12.3 MB
Stars: 381
Watchers: 25
Forks: 46
Open Issues: 53
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-starred - sockethub/sockethub - A multi-protocol gateway for the Web using ActivityStream messages. (nodejs)

README

        # Sockethub

[![Sockethub](https://sockethub.org/res/img/sockethub-logo.svg)](https://sockethub.org)

A protocol gateway for the web.

[![Compliance](https://github.com/sockethub/sockethub/actions/workflows/compliance.yml/badge.svg)](https://github.com/sockethub/sockethub/actions/workflows/compliance.yml)

[![CodeQL](https://github.com/sockethub/sockethub/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/sockethub/sockethub/actions/workflows/codeql-analysis.yml)

[![Maintainability](https://api.codeclimate.com/v1/badges/95912fc801271faf44f6/maintainability)](https://codeclimate.com/github/sockethub/sockethub/maintainability)

[![Release](https://img.shields.io/npm/v/sockethub.svg?style=flat)](https://github.com/sockethub/sockethub/releases)

## About

Sockethub is a translation layer for web applications to communicate with

other protocols and services that are traditionally either inaccessible or

impractical to use from in-browser JavaScript.

Using [ActivityStream](http://activitystrea.ms/) (AS) objects to pass messages

to and from the web app, Sockethub acts as a smart proxy server/agent, which

can maintain state, and connect to sockets, endpoints, and networks that would

otherwise, be restricted from an application running in the browser.

Originally inspired as a sister project to

[RemoteStorage](https://remotestorage.io), and assisting in the development of

[unhosted](http://unhosted.org) and [noBackend](http://nobackend.org)

applications, Sockethub's functionality can also fit into a more traditional

development stack, removing the need for custom code to handle various protocol

specifics at the application layer.

Example uses of Sockethub are:

* Writing and receiving messages (SMTP, IMAP, Nostr ...)

* Chat (XMPP, IRC, SimpleX, ...)

* Discovery (WebFinger, RDF(a), Link preview generation ...)

The architecture of Sockethub is extensible and supports easy implementation

of additional 'platforms' to carry out tasks.

## Docs

See the [Sockethub wiki](https://github.com/sockethub/sockethub/wiki) for

documentation.

## Features

We use ActivityStreams to map the various actions of a platform to a set of AS

'@type's which identify the underlying action. For example, using the XMPP

platform, a friend request/accept cycle would use the activity stream types

'request-friend', 'remove-friend', 'make-friend'.

Below is a list of platform contexts we're currently working on and their types,

both the completed and not yet implemented ones. They are all implemented in

Sockethub platforms (each in their own repository) and can be enabled/disabled

in the `config.json`.

## Platforms

Making a platform is as simple as creating a platform module that defines a

schema and a series of functions that map to verbs. Take a look at some of

our existing platforms for examples.

* [Feeds](packages/platform-feeds) *(RSS, Atom)*

* [IRC](packages/platform-irc)

* [XMPP](packages/platform-xmpp)

## Run

To get up and running quickly, you only need the following commands:

```bash

pnpm install

pnpm dev

```

### Dependencies

```pnpm install```

### Build

```pnpm build```

### Tests

```pnpm test```

### Linter

```pnpm lint:js```

Or, to automatically fix linting errors:

```pnpm lint:fix```

### Integration Tests

```pnpm integration```

## Start

For development purposes, with examples enabled, run:

`DEBUG=sockethub* pnpm dev`

You should then be able to browse to `http://localhost:10550` and try out the examples.

For production, with examples disabled.

`DEBUG=sockethub* pnpm start`

*For more info on configuration options, see the

[Sockethub README](packages/server/README.md#environment-variables)*

section on environment variables.*

## Packages

* [@sockethub/activity-streams](packages/activity-streams)

* [@sockethub/client](packages/client)

* [@sockethub/crypto](packages/crypto)

* [@sockethub/data-layer](packages/data-layer)

* [@sockethub/examples](packages/examples)

* [@sockethub/irc2as](packages/irc2as)

* [@sockethub/platform-dummy](packages/platform-dummy)

* [@sockethub/platform-feeds](packages/platform-feeds)

* [@sockethub/platform-irc](packages/platform-irc)

* [@sockethub/platform-xmpp](packages/platform-xmpp)

* [@sockethub/schemas](packages/schemas)

* [@sockethub/server](packages/server)

## Credits

Project created and maintained by [Nick Jennings](http://github.com/silverbucket)

Logo design by [Jan-Christoph Borchardt](http://jancborchardt.net)

Sponsored by [NLNET](http://nlnet.nl)

[![NLNET Logo](http://sockethub.org/res/img/nlnet-logo.svg)](http://nlnet.nl)