2024-05-06 21:01:21 +02:00
|
|
|
|
|
|
|
|
<p align="center">
|
2024-08-28 15:24:22 +02:00
|
|
|
<a href="https://versia.pub"><img src="https://cdn.versia.pub/branding/logo-dark.svg" alt="Versia Logo" height="110"></a>
|
2024-05-06 21:01:21 +02:00
|
|
|
</p>
|
|
|
|
|
|
2024-08-28 15:24:22 +02:00
|
|
|
## Versia ActivityPub Bridge
|
2024-05-06 21:01:21 +02:00
|
|
|
|
2024-08-28 15:24:22 +02:00
|
|
|
[](https://github.com/versia-pub/activitypub/actions/workflows/nix-flake.yml)
|
2024-05-06 21:01:21 +02:00
|
|
|
|
2024-08-28 15:24:22 +02:00
|
|
|
**ActivityPub/ActivityStreams** compatibility layer for [**Versia Server**](https://github.com/versia-pub/versia).
|
2024-05-06 21:01:21 +02:00
|
|
|
|
|
|
|
|
Designed as a microservice, runs as its own process and communicates with the main server via HTTP.
|
2024-01-26 21:01:43 +01:00
|
|
|
|
2024-03-21 13:10:31 +01:00
|
|
|
## Development (Flakes)
|
|
|
|
|
|
|
|
|
|
This repo uses [Flakes](https://nixos.wiki/wiki/Flakes) from the get-go.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# Dev shell
|
|
|
|
|
nix develop
|
|
|
|
|
|
|
|
|
|
# or run via cargo
|
|
|
|
|
nix develop -c cargo run
|
|
|
|
|
|
|
|
|
|
# build
|
|
|
|
|
nix build
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
We also provide a [`justfile`](https://just.systems/) for Makefile'esque commands.
|
2024-01-26 21:01:43 +01:00
|
|
|
|
2024-05-06 21:01:21 +02:00
|
|
|
## Building
|
|
|
|
|
|
|
|
|
|
### Docker/Podman
|
2024-01-26 21:01:43 +01:00
|
|
|
|
2024-05-06 21:01:21 +02:00
|
|
|
To build the Docker image, run the following command:
|
2024-01-26 21:01:43 +01:00
|
|
|
|
|
|
|
|
```bash
|
2024-05-06 21:01:21 +02:00
|
|
|
docker build -t activitypub:latest .
|
2024-01-26 21:01:43 +01:00
|
|
|
```
|
|
|
|
|
|
2024-05-06 21:01:21 +02:00
|
|
|
To run the docker image, use the [`docker-compose.yml`](./docker-compose.yml) file:
|
2024-01-26 21:01:43 +01:00
|
|
|
|
|
|
|
|
```bash
|
2024-08-28 15:24:22 +02:00
|
|
|
wget https://raw.githubusercontent.com/versia-pub/activitypub/main/docker-compose.yml
|
2024-05-06 21:01:21 +02:00
|
|
|
|
|
|
|
|
docker-compose up -d
|
2024-01-26 21:01:43 +01:00
|
|
|
```
|
2024-05-06 21:01:21 +02:00
|
|
|
|
|
|
|
|
If you are building from source, make sure to replace the image name in the `docker-compose.yml` file.
|