https://github.com/reiver/relayverse
relayverse is an actor caching server for decentralized social-media (DeSo), including the Fediverse.
https://github.com/reiver/relayverse
activitypub activitystreams caching decentralized-social fediverse json-ld social-media social-web
Last synced: about 2 months ago
JSON representation
relayverse is an actor caching server for decentralized social-media (DeSo), including the Fediverse.
- Host: GitHub
- URL: https://github.com/reiver/relayverse
- Owner: reiver
- License: agpl-3.0
- Created: 2025-02-04T07:30:23.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-07-21T23:24:06.000Z (12 months ago)
- Last Synced: 2025-07-22T06:20:48.143Z (12 months ago)
- Topics: activitypub, activitystreams, caching, decentralized-social, fediverse, json-ld, social-media, social-web
- Language: Go
- Homepage:
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# relayverse
**relayverse** is an actor caching server for decentralized social-media (DeSo), including the Fediverse.
## URLs
There are 3 important URLs for **relayverse**:
* `/.well-known/acct-cache?resource=???`
* `/.well-known/acct-icon?resource=???`
* `/.well-known/acct-image?resource=???`
Where `???` is replace by a acct-URI.
For example:
* `https://example.com/.well-known/acct-cache?resource=acct:reiver@mastodon.social`
* `https://example.com/.well-known/acct-icon?resource=acct:reiver@mastodon.social`
* `https://example.com/.well-known/acct-image?resource=acct:reiver@mastodon.social`
### acct-cache
The `acct-cache` style URL returns the (cached) activity-JSON (`application/activity+json`) file for the account.
### acct-icon
The `acct-icon` style URL redirects to the icon-url for the account, as provided in (cached) activity-JSON (`application/activity+json`) file.
You can put this type of URL into an HTML `![]()
` element.
For example:
```html
```
### acct-image
The `acct-image` style URL redirects to the image-url for the account, as provided in (cached) activity-JSON (`application/activity+json`) file.
You can put this type of URL into an HTML `![]()
` element.
For example:
```html
```
## Fediverse ID
A **Fediverse ID** (i.e., **Fediverse Address**), such as:
`@reiver@mastodon.social`
Can be turned into an acct-URI — by replacing the first `@` with `acct:`, as in:
`acct:reiver@mastodon.social`
## Configuration
There are 3 environment variables that can be used to configure **relayverse**:
* `CACHE_GC_SLEEP`
* `CACHE_MIN`
* `PORT`
### `CACHE_GC_SLEEP`
`CACHE_GC_SLEEP` sets the minimum duration that the cache garbage-collector sleeps for before it cleans-up again.
For example:
`CACHE_GC_SLEEP=1h20m30s relayverse`
### `CACHE_MIN`
`CACHE_MIN` sets the minimum duration that things are cached for.
For example:
`CACHE_MIN=10m20s relayverse`
### `PORT`
`PORT` sets the TCP-port used by the HTTP server.
For example:
`PORT=9090 relayverse`
## Author
Software **relayverse** was written by [Charles Iliya Krempeaux](http://reiver.link)