Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/go-ap/fedbox

Reference implementation of an ActivityPub service using go-ap packages (mirror repository)
https://github.com/go-ap/fedbox

activitypub

Last synced: 24 days ago
JSON representation

Reference implementation of an ActivityPub service using go-ap packages (mirror repository)

Host: GitHub
URL: https://github.com/go-ap/fedbox
Owner: go-ap
License: mit
Created: 2019-05-03T20:07:29.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-04-08T15:56:29.000Z (7 months ago)
Last Synced: 2024-04-13T21:17:29.492Z (7 months ago)
Topics: activitypub
Language: Go
Homepage: https://federated.id
Size: 2.11 MB
Stars: 129
Watchers: 8
Forks: 10
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # FedBOX

[![MIT Licensed](https://img.shields.io/github/license/go-ap/fedbox.svg)](https://raw.githubusercontent.com/go-ap/fedbox/master/LICENSE)

[![Build Status](https://builds.sr.ht/~mariusor/fedbox.svg)](https://builds.sr.ht/~mariusor/fedbox)

[![Go Report Card](https://goreportcard.com/badge/github.com/go-ap/fedbox)](https://goreportcard.com/report/github.com/go-ap/fedbox)

FedBOX is a simple ActivityPub enabled server. Its goal is to serve as a reference implementation for the rest of the [GoActivityPub](https://github.com/go-ap) packages.

It provides the base for some of the common functionality that such a service would require, such as: HTTP handlers and middlewares, storage and filtering etc.

The current iteration can persist data to [BoltDB](https://go.etcd.io/bbolt), [Badger](https://github.com/dgraph-io/badger), [SQLite](https://gitlab.com/cznic/sqlite) and directly on the file system, but I want to also add support for PostgreSQL.

## Features

### Support for C2S ActivityPub:

 * Support for content management actitivies: `Create`, `Update`, `Delete`.

 * `Follow`, `Accept`, `Reject` with actors as objects.

 * Appreciation activities: `Like`, `Dislike`.

 * Reaction activities: `Block` on actors, `Flag` on objects.

 * Negating content management and appreciation activities using `Undo`.

 * OAuth2 authentication

### Support for S2S ActivityPub

 * Support the same operations as the client to server activities.

 * Capabilities of generating and loading HTTP Signatures from requests.

## Installation

See the [INSTALL](./doc/INSTALL.md) file.

## Further reading

If you are interested in using FedBOX from an application developer point of view, make sure to read the [Client to Server](./doc/c2s.md) document, which details how the local flavour of ActivityPub C2S API can be used.

More information about FedBOX and the other packages in the GoActivityPub library can be found on the [wiki](https://man.sr.ht/~mariusor/go-activitypub/index.md).

## Contact and feedback

If you have problems, questions, ideas or suggestions, please contact us by posting to the [mailing list](https://lists.sr.ht/~mariusor/activitypub-go), or on [GitHub](https://github.com/go-ap/fedbox/issues). If you desire quick feedback, the mailing list is preferred, as the GitHub issues are not checked very often.