Welcome to my cool relay where I have cool relay things happening. I hope you enjoy your stay!
" +PROMETHEUS_ADDR=0.0.0.0 +PROMETHEUS_PORT=9000 +CLIENT_POOL_SIZE=20 ``` #### Descriptions @@ -128,6 +131,8 @@ Where to store the on-disk database of connected servers. This defaults to `./sl The log level to print. Available levels are `ERROR`, `WARN`, `INFO`, `DEBUG`, and `TRACE`. You can also specify module paths to enable some logs but not others, such as `RUST_LOG=warn,tracing_actix_web=info,relay=info`. This defaults to `warn` ##### `SOURCE_REPO` The URL to the source code for the relay. This defaults to `https://git.asonix.dog/asonix/relay`, but should be changed if you're running a fork hosted elsewhere. +##### `REPOSITORY_COMMIT_BASE` +The base path of the repository commit hash reference. For example, `/src/commit/` for Gitea, `/tree/` for GitLab. ##### `API_TOKEN` The Secret token used to access the admin APIs. This must be set for the commandline to function ##### `OPENTELEMETRY_URL` @@ -146,6 +151,15 @@ Optional - Add custom notes in the footer of the page Optional - domains of mastodon servers run by the same admin as the relay ##### `LOCAL_BLURB` Optional - description for the relay +##### `PROMETHEUS_ADDR` +Optional - Address to bind to for serving the prometheus scrape endpoint +##### `PROMETHEUS_PORT` +Optional - Port to bind to for serving the prometheus scrape endpoint +##### `CLIENT_POOL_SIZE` +Optional - How many connections the relay should maintain per thread. This value will be multiplied +by the number of cores available to the relay. This defaults to 20, so a 4-core machine will have a +maximum of 160 simultaneous outbound connections. If you run into problems related to "Too many open +files", you can either decrease this number or increase the ulimit for your system. ### Subscribing Mastodon admins can subscribe to this relay by adding the `/inbox` route to their relay settings. @@ -165,10 +179,16 @@ example, if the server is `https://relay.my.tld`, the correct URL would be - Follow Public, become a listener of the relay - Undo Follow {self-actor}, stop listening on the relay, an Undo Follow will be sent back - Undo Follow Public, stop listening on the relay -- Delete {anything}, the Delete {anything} is relayed verbatim to listening servers +- Delete {anything}, the Delete {anything} is relayed verbatim to listening servers. Note that this activity will likely be rejected by the listening servers unless it has been signed with a JSON-LD signature -- Update {anything}, the Update {anything} is relayed verbatim to listening servers +- Update {anything}, the Update {anything} is relayed verbatim to listening servers. + Note that this activity will likely be rejected by the listening servers unless it has been + signed with a JSON-LD signature +- Add {anything}, the Add {anything} is relayed verbatim to listening servers. + Note that this activity will likely be rejected by the listening servers unless it has been + signed with a JSON-LD signature +- Remove {anything}, the Remove {anything} is relayed verbatim to listening servers. Note that this activity will likely be rejected by the listening servers unless it has been signed with a JSON-LD signature @@ -176,6 +196,9 @@ example, if the server is `https://relay.my.tld`, the correct URL would be - Webfinger - NodeInfo +### Known issues +Pleroma and Akkoma do not support validating JSON-LD signatures, meaning many activities such as Delete, Update, Add, and Remove will be rejected with a message similar to `WARN: Response from https://example.com/inbox, "Invalid HTTP Signature"`. This is normal and not an issue with the relay. + ### Contributing Feel free to open issues for anything you find an issue with. Please note that any contributed code will be licensed under the AGPLv3. diff --git a/docker/prod/Dockerfile b/docker/prod/Dockerfile deleted file mode 100644 index 280aa95..0000000 --- a/docker/prod/Dockerfile +++ /dev/null @@ -1,41 +0,0 @@ -ARG REPO_ARCH=amd64 - -# cross-build environment -FROM asonix/rust-builder:$REPO_ARCH-latest AS builder - -ARG TAG=main -ARG BINARY=relay -ARG PROJECT=relay -ARG GIT_REPOSITORY=https://git.asonix.dog/asonix/$PROJECT - -ENV \ - BINARY=${BINARY} - -ADD \ - --chown=build:build \ - $GIT_REPOSITORY/archive/$TAG.tar.gz \ - /opt/build/repo.tar.gz - -RUN \ - tar zxf repo.tar.gz - -WORKDIR /opt/build/$PROJECT - -RUN \ - build - -# production environment -FROM asonix/rust-runner:$REPO_ARCH-latest - -ARG BINARY=relay - -ENV \ - BINARY=${BINARY} - -COPY \ - --from=builder \ - /opt/build/binary \ - /usr/bin/${BINARY} - -ENTRYPOINT ["/sbin/tini", "--"] -CMD /usr/bin/${BINARY} diff --git a/docker/prod/build-image.sh b/docker/prod/build-image.sh deleted file mode 100755 index 2782f1e..0000000 --- a/docker/prod/build-image.sh +++ /dev/null @@ -1,37 +0,0 @@ -#!/usr/bin/env bash - -function require() { - if [ "$1" = "" ]; then - echo "input '$2' required" - print_help - exit 1 - fi -} - -function print_help() { - echo "deploy.sh" - echo "" - echo "Usage:" - echo " deploy.sh [repo] [tag] [arch]" - echo "" - echo "Args:" - echo " repo: The docker repository to publish the image" - echo " tag: The tag applied to the docker image" - echo " arch: The architecuture of the doker image" -} - -REPO=$1 -TAG=$2 -ARCH=$3 - -require "$REPO" repo -require "$TAG" tag -require "$ARCH" arch - -sudo docker build \ - --pull \ - --build-arg TAG=$TAG \ - --build-arg REPO_ARCH=$ARCH \ - -t $REPO:$ARCH-$TAG \ - -f Dockerfile \ - . diff --git a/docker/prod/deploy.sh b/docker/prod/deploy.sh deleted file mode 100755 index fcd7539..0000000 --- a/docker/prod/deploy.sh +++ /dev/null @@ -1,87 +0,0 @@ -#!/usr/bin/env bash - -function require() { - if [ "$1" = "" ]; then - echo "input '$2' required" - print_help - exit 1 - fi -} - -function print_help() { - echo "deploy.sh" - echo "" - echo "Usage:" - echo " deploy.sh [tag] [branch] [push]" - echo "" - echo "Args:" - echo " tag: The git tag to be applied to the repository and docker build" - echo " branch: The git branch to use for tagging and publishing" - echo " push: Whether or not to push the image" - echo "" - echo "Examples:" - echo " ./deploy.sh v0.3.0-alpha.13 main true" - echo " ./deploy.sh v0.3.0-alpha.13-shell-out asonix/shell-out false" -} - -function build_image() { - tag=$1 - arch=$2 - push=$3 - - ./build-image.sh asonix/relay $tag $arch - - sudo docker tag asonix/relay:$arch-$tag asonix/relay:$arch-latest - - if [ "$push" == "true" ]; then - sudo docker push asonix/relay:$arch-$tag - sudo docker push asonix/relay:$arch-latest - fi -} - -# Creating the new tag -new_tag="$1" -branch="$2" -push=$3 - -require "$new_tag" "tag" -require "$branch" "branch" -require "$push" "push" - -if ! sudo docker run --rm -it arm64v8/alpine:3.11 /bin/sh -c 'echo "docker is configured correctly"' -then - echo "docker is not configured to run on qemu-emulated architectures, fixing will require sudo" - sudo docker run --rm --privileged multiarch/qemu-user-static --reset -p yes -fi - -set -xe - -git checkout $branch - -# Changing the docker-compose prod -sed -i "s/asonix\/relay:.*/asonix\/relay:$new_tag/" docker-compose.yml -git add ../prod/docker-compose.yml -# The commit -git commit -m"Version $new_tag" -git tag $new_tag - -# Push -git push origin $new_tag -git push - -# Build for arm64v8, arm32v7 and amd64 -build_image $new_tag arm64v8 $push -build_image $new_tag arm32v7 $push -build_image $new_tag amd64 $push - -# Build for other archs -# TODO - -if [ "$push" == "true" ]; then - ./manifest.sh relay $new_tag - ./manifest.sh relay latest - - # pushd ../../ - # cargo publish - # popd -fi diff --git a/docker/prod/docker-compose.yml b/docker/prod/docker-compose.yml index 7201789..54e2a11 100644 --- a/docker/prod/docker-compose.yml +++ b/docker/prod/docker-compose.yml @@ -2,7 +2,7 @@ version: '3.3' services: relay: - image: asonix/relay:v0.3.8 + image: asonix/relay:0.3.85 ports: - "8079:8079" restart: always @@ -14,6 +14,7 @@ services: - RESTRICTED_MODE=false - VALIDATE_SIGNATURES=true - HTTPS=true - - DATABASE_URL=postgres://pg_user:pg_pass@pg_host:pg_port/pg_database + - SLED_PATH=/mnt/sled/db-0.34 - PRETTY_LOG=false - PUBLISH_BLOCKS=true + - API_TOKEN=somepasswordishtoken diff --git a/docker/prod/manifest.sh b/docker/prod/manifest.sh deleted file mode 100755 index d426a97..0000000 --- a/docker/prod/manifest.sh +++ /dev/null @@ -1,43 +0,0 @@ -#!/usr/bin/env bash - -function require() { - if [ "$1" = "" ]; then - echo "input '$2' required" - print_help - exit 1 - fi -} -function print_help() { - echo "deploy.sh" - echo "" - echo "Usage:" - echo " manifest.sh [repo] [tag]" - echo "" - echo "Args:" - echo " repo: The docker repository to update" - echo " tag: The git tag to be applied to the image manifest" -} - -REPO=$1 -TAG=$2 - -require "$REPO" "repo" -require "$TAG" "tag" - -set -xe - -sudo docker manifest create asonix/$REPO:$TAG \ - -a asonix/$REPO:arm64v8-$TAG \ - -a asonix/$REPO:arm32v7-$TAG \ - -a asonix/$REPO:amd64-$TAG - -sudo docker manifest annotate asonix/$REPO:$TAG \ - asonix/$REPO:arm64v8-$TAG --os linux --arch arm64 --variant v8 - -sudo docker manifest annotate asonix/$REPO:$TAG \ - asonix/$REPO:arm32v7-$TAG --os linux --arch arm --variant v7 - -sudo docker manifest annotate asonix/$REPO:$TAG \ - asonix/$REPO:amd64-$TAG --os linux --arch amd64 - -sudo docker manifest push asonix/$REPO:$TAG --purge diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..0cb587b --- /dev/null +++ b/flake.lock @@ -0,0 +1,61 @@ +{ + "nodes": { + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1687171271, + "narHash": "sha256-BJlq+ozK2B1sJDQXS3tzJM5a+oVZmi1q0FlBK/Xqv7M=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "abfb11bd1aec8ced1c9bb9adfe68018230f4fb3c", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1687412861, + "narHash": "sha256-Z/g0wbL68C+mSGerYS2quv9FXQ1RRP082cAC0Bh4vcs=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "e603dc5f061ca1d8a19b3ede6a8cf9c9fcba6cdc", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "nixos-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..70d1fe7 --- /dev/null +++ b/flake.nix @@ -0,0 +1,34 @@ +{ + description = "relay"; + + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; + flake-utils.url = "github:numtide/flake-utils"; + }; + + outputs = { self, nixpkgs, flake-utils }: + flake-utils.lib.eachDefaultSystem (system: + let + pkgs = import nixpkgs { + inherit system; + }; + in + { + packages = rec { + relay = pkgs.callPackage ./relay.nix { }; + + default = relay; + }; + + apps = rec { + dev = flake-utils.lib.mkApp { drv = self.packages.${system}.pict-rs-proxy; }; + default = dev; + }; + + devShell = with pkgs; mkShell { + nativeBuildInputs = [ cargo cargo-outdated cargo-zigbuild clippy gcc protobuf rust-analyzer rustc rustfmt ]; + + RUST_SRC_PATH = "${pkgs.rust.packages.stable.rustPlatform.rustLibSrc}"; + }; + }); +} diff --git a/relay.nix b/relay.nix new file mode 100644 index 0000000..08d4a73 --- /dev/null +++ b/relay.nix @@ -0,0 +1,25 @@ +{ lib +, nixosTests +, protobuf +, rustPlatform +}: + +rustPlatform.buildRustPackage { + pname = "relay"; + version = "0.3.85"; + src = ./.; + cargoLock.lockFile = ./Cargo.lock; + + PROTOC = "${protobuf}/bin/protoc"; + PROTOC_INCLUDE = "${protobuf}/include"; + + nativeBuildInputs = [ ]; + + passthru.tests = { inherit (nixosTests) relay; }; + + meta = with lib; { + description = "A simple image hosting service"; + homepage = "https://git.asonix.dog/asonix/relay"; + license = with licenses; [ agpl3Plus ]; + }; +} diff --git a/src/admin.rs b/src/admin.rs index e7fc665..156a5d9 100644 --- a/src/admin.rs +++ b/src/admin.rs @@ -1,4 +1,6 @@ use activitystreams::iri_string::types::IriString; +use std::collections::{BTreeMap, BTreeSet}; +use time::OffsetDateTime; pub mod client; pub mod routes; @@ -22,3 +24,9 @@ pub(crate) struct BlockedDomains { pub(crate) struct ConnectedActors { pub(crate) connected_actors: VecAn ActivityPub relay for servers. Currently running somewhere. Let me know if you want to join!
' +OPENTELEMETRY_URL='http://otel.example.com:4317' +API_TOKEN='blahblahblahblahblahblahblah' +TELEGRAM_TOKEN='blahblahblahblahblahblahblah' + diff --git a/systemd/example-relay.socket b/systemd/example-relay.socket new file mode 100644 index 0000000..9c6ea0b --- /dev/null +++ b/systemd/example-relay.socket @@ -0,0 +1,11 @@ +[Unit] +Description=Activitypub Relay Socket +Before=multi-user.target +After=network.target + +[Socket] +Service=example-relay.service +ListenStream=8080 + +[Install] +WantedBy=sockets.target diff --git a/templates/admin.rs.html b/templates/admin.rs.html index 1af6bc2..e457ce7 100644 --- a/templates/admin.rs.html +++ b/templates/admin.rs.html @@ -6,7 +6,7 @@
diff --git a/templates/index.rs.html b/templates/index.rs.html
index ab9bb9e..9fa04c5 100644
--- a/templates/index.rs.html
+++ b/templates/index.rs.html
@@ -1,7 +1,7 @@
@use crate::{
config::{Config, UrlKind},
data::Node,
-templates::{info, instance, statics::index_css},
+templates::{info_html, instance_html, statics::index_css},
};
@(local: &[Node], nodes: &[Node], config: &Config)
@@ -39,13 +39,13 @@ templates::{info, instance, statics::index_css},
@for node in local {
@if let Some(inst) = node.instance.as_ref() {
- @:instance(inst, node.info.as_ref().map(|info| { info.software.as_ref() }), node.contact.as_ref(),
+ @:instance_html(inst, node.info.as_ref().map(|info| { info.software.as_ref() }), node.contact.as_ref(),
&node.base)
} else {
@if let Some(inf) = node.info.as_ref() {
- @:info(inf, &node.base)
+ @:info_html(inf, &node.base)
}
}
@@ -94,13 +94,13 @@ templates::{info, instance, statics::index_css},
@for node in nodes {
@if let Some(inst) = node.instance.as_ref() {
- @:instance(inst, node.info.as_ref().map(|info| { info.software.as_ref() }), node.contact.as_ref(),
+ @:instance_html(inst, node.info.as_ref().map(|info| { info.software.as_ref() }), node.contact.as_ref(),
&node.base)
} else {
@if let Some(inf) = node.info.as_ref() {
- @:info(inf, &node.base)
+ @:info_html(inf, &node.base)
}
}
diff --git a/templates/instance.rs.html b/templates/instance.rs.html
index e8e6ad8..47a9019 100644
--- a/templates/instance.rs.html
+++ b/templates/instance.rs.html
@@ -1,4 +1,4 @@
-@use crate::{db::{Contact, Instance}, templates::admin};
+@use crate::{db::{Contact, Instance}, templates::admin_html};
@use activitystreams::iri_string::types::IriString;
@(instance: &Instance, software: Option<&str>, contact: Option<&Contact>, base: &IriString)
@@ -33,7 +33,7 @@
@if let Some(contact) = contact {