Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/go-fed/apcore

Golang ActivityPub Server Framework
https://github.com/go-fed/apcore

activitypub activitystreams activitystreams-vocabulary federated framework golang social

Last synced: 24 days ago
JSON representation

Golang ActivityPub Server Framework

Awesome Lists containing this project

README 

        
# apcore



> Server framework for quickly building ActivityPub applications



*Under Construction*



[![Build Status][Build-Status-Image]][Build-Status-Url] [![Go Reference][Go-Reference-Image]][Go-Reference-Url]

[![Go Report Card][Go-Report-Card-Image]][Go-Report-Card-Url] [![License][License-Image]][License-Url]

[![Chat][Chat-Image]][Chat-Url] [![OpenCollective][OpenCollective-Image]][OpenCollective-Url]



`go get github.com/go-fed/apcore`



apcore is a powerful single server

[ActivityPub](https://www.w3.org/TR/activitypub)

framework for performant Fediverse applications.



It is built on top of the

[go-fed/activity](https://github.com/go-fed/activity)

suite of libraries, which means it can readily allow application developers to

iterate and leverage new

[ActivityStreams](https://www.w3.org/TR/activitystreams-core)

or RDF vocabularies.



## Features



*This list is a work in progress.*



* Uses `go-fed/activity`

  * ActivityPub S2S (Server-to-Server) Protocol supported

  * ActivityPub C2S (Client-to-Server) Protocol supported

  * Both S2S and C2S can be used at the same time

  * Comes with the Core & Extended ActivityStreams types

  * Readily expands to support new ActivityStreams types and/or RDF vocabularies

* Federation & Moderation Policy System

  * Administrators and/or users can create policies to customize their federation experience

  * Auditable results of applying policies on incoming federated data

* Supports common out-of-the-box command-line commands for:

  * Initializing a database with the appropriate `apcore` tables as well as your application-specific tables

  * Initializing a new administrator account

  * Creating a server configuration file in a guided flow

  * Comprehensive help command

  * Guided command line flow for administrators for all the above tasks, featuring Clarke the Cow

* Configuration file support

  * Add your configuration options to the existing `apcore` configuration options

  * Administrators can customize their ActivityPub and your app's experience

* Database support

  * Currently, only PostgreSQL supported

  * Others can be added with a some SQL work, in the future

  * No ORM overhead

  * Your custom application has access to `apcore` tables, and more

* OAuth2 support

  * Easy API to build authorization grant and validation flows

  * Handles server side state for you

* Webfinger & Host-Meta support



## How To Use This Framework



*This guide is a work in progress.*



Building an application is not an easy thing to do, but following these steps

reduces the cost of building a *federated* application:



0. Implement the `apcore.Application` interface.

0. Call `apcore.Run` with your implementation in `main`.



The most work is in the first step, as your application logic is able to live as

functional closures as the `Application` is used within the `apcore` framework.

See the documentation on the `Application` interface for specific details.



[Build-Status-Image]: https://travis-ci.org/go-fed/apcore.svg?branch=master

[Build-Status-Url]: https://travis-ci.org/go-fed/apcore

[Go-Reference-Image]: https://pkg.go.dev/badge/github.com/go-fed/apcore.svg

[Go-Reference-Url]: https://pkg.go.dev/github.com/go-fed/apcore

[Go-Report-Card-Image]: https://goreportcard.com/badge/github.com/go-fed/apcore

[Go-Report-Card-Url]: https://goreportcard.com/report/github.com/go-fed/apcore

[License-Image]: https://img.shields.io/github/license/go-fed/apcore?color=blue

[License-Url]: https://www.gnu.org/licenses/agpl-3.0.en.html

[Chat-Image]: https://img.shields.io/matrix/go-fed:feneas.org?server_fqdn=matrix.org

[Chat-Url]: https://matrix.to/#/!BLOSvIyKTDLIVjRKSc:feneas.org?via=feneas.org&via=matrix.org

[OpenCollective-Image]: https://img.shields.io/opencollective/backers/go-fed-activitypub-labs

[OpenCollective-Url]: https://opencollective.com/go-fed-activitypub-labs