Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davecheney/pub
pub, a tiny ActivityPub to Mastodon bridge
https://github.com/davecheney/pub
activitypub fediverse mastodon
Last synced: 2 months ago
JSON representation
pub, a tiny ActivityPub to Mastodon bridge
- Host: GitHub
- URL: https://github.com/davecheney/pub
- Owner: davecheney
- License: bsd-3-clause
- Created: 2022-11-21T05:05:18.000Z (about 2 years ago)
- Default Branch: activitypub
- Last Pushed: 2024-03-31T08:37:16.000Z (9 months ago)
- Last Synced: 2024-04-17T15:19:30.113Z (8 months ago)
- Topics: activitypub, fediverse, mastodon
- Language: Go
- Homepage:
- Size: 807 KB
- Stars: 226
- Watchers: 6
- Forks: 14
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-fediverse - pub - an ActivityPub host indented for a single actor. To interact with ActivityPub, pub implements the Mastodon api for use with various apps. (Applications)
README
# pub, a tiny ActivityPub to Mastodon bridge
[](https://pkg.go.dev/github.com/davecheney/pub) [](https://goreportcard.com/report/github.com/davecheney/pub)
## What is pub?
`pub` is an ActivityPub host intended for a single actor.
To interact with ActivityPub, `pub` implements the Mastodon[^tm] api for use with various apps.
`pub` is not intended to host an ActivityPub community, rather it is aimed at enabling someone who owns their own domain, and thus controls their identity, to participate in the fediverse.
[^tm]: Mastodon is a trademark of [Mastodon gGmbh](https://joinmastodon.org/trademark). `pub` is not affiliated with Mastodon gGmbH. `pub` is not a Mastodon server.
## What _doesn't_ it do?
`pub` doesn't have much of a web interface beyond what ActivityPub requires, you're expected to interact with it via a Mastodon compatible app.
## Getting started
_Warning: `pub` is still in development, if it breaks, you can keep the pieces._
### Pre-requisites
- [Go][go]
- [MariaDB][mariadb] (if you want to use MariaDB)
### Installation (MySQL/MariaDB)
Create a database and user for `pub`:
```sql
CREATE DATABASE pub;
CREATE USER 'pub'@'localhost' IDENTIFIED BY 'pub';
GRANT ALL PRIVILEGES ON pub.* TO 'pub'@'localhost';
```
Install `pub`:
#### For Mysql/MariaDB
```bash
go install -tags mysql github.com/davecheney/pub@latest
```
#### For Sqlite
```bash
go install -tags sqlite github.com/davecheney/pub@latest
```
Create/migrate the database:
```bash
pub --dsn 'pub:pub@/pub' auto-migrate
```
### Setup
Create an instance for `pub`:
```bash
pub --dsn 'pub:pub@/pub' create-instance --domain domain.com --title "Something cool" --description "Something witty" --admin-email [email protected]
```
This will create an instance, and an admin account for that instance.
Create your first user
```bash
pub --dsn 'pub:pub@/pub' create-account --email [email protected] --name you --domain domain.com --password sssh
```
This will create an account for you to act as `acct:[email protected]`
### Running
Start `pub`:
```bash
pub --log-http --dsn 'pub:pub@/pub' serve
```
### Getting online
`pub` doesn't have a web interface, so you'll need to use a Mastodon app to interact with it.
You'll need to put `pub` behind a reverse proxy, and configure the reverse proxy to forward requests to `pub`.
TLS is also required, so you'll need to configure TLS for your reverse proxy, probably using [Let's Encrypt](https://letsencrypt.org/).
See the [examples](examples) directory for sample configurations for [nginx](examples/nginx).
## Acknowledgements
`pub` would not be possible without these amazing projects:
- [Chi][chi]
- [GORM][gorm]
- [Kong][kong]
- [Requests][requests]
## Contribution policy
`pub` is currently open to code contributions for bug fixes _only_.
This may change in the future, but at the moment please do not send pull requests with new features.
If you have a feature request, or a bug report, please open an [issue](https://github.com/davecheney/pub/issues/new).
If you're _really_ adventurous, you can contact me via [`@[email protected]`](acct:[email protected]).
Thank you in advance for your understanding.
[chi]: https://github.com/go-chi/chi
[kong]: https://github.com/alecthomas/kong
[gorm]: https://gorm.io/
[requests]: https://github.com/carlmjohnson/requests/
[go]: https://golang.org/doc/install
[mariadb]: https://mariadb.org/download/