A webservice to monitor a relay's list of open instances, and provide details to people interested in joining the federation.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Arlo (Hyena) 102331668f Use stable sled-extensions, actix-sled-cache 1 day ago
compiled_templates Update dependencies 1 week ago
src Use stable sled-extensions, actix-sled-cache 1 day ago
static Extract relay info to yml file 1 month ago
templates Extract relay info to yml file 1 month ago
.gitignore Initial logic for yiff.social instance monitoring 9 months ago
Cargo.lock Use stable sled-extensions, actix-sled-cache 1 day ago
Cargo.toml Use stable sled-extensions, actix-sled-cache 1 day ago
Dockerfile.cross Extract relay info to yml file 1 month ago
LICENSE Bring in the CSL text 1 month ago
README.md remove path 1 month ago
build.rs Ship bulma 3 months ago
build.sh Don't cache binary 8 months ago
input.yml Extract relay info to yml file 1 month ago

README.md

furryd

A Fediverse Relay user-facing frontend

Usage

Help

$ furryd -h
furryd 0.2.0
asonix <asonix@asonix.dog>
Keep track of open instances on a relay

USAGE:
    furryd [FLAGS] [OPTIONS] <input>

FLAGS:
    -D, --debug
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -b, --bind-address <bind_address>                The address to bind this application [default: 0.0.0.0:8000]
    -e, --media-cache-expiry <cache_expiry>          How long, in minutes, to keep cached images around [default: 3600]
    -f, --media-cache-frequency <cache_frequency>    How often, in seconds, to check for expired images [default: 600]
    -d, --database-path <database_path>              The path to the sled database [default: furryd-db]
    -p, --ping-frequency <ping_frequency>
            How often, in seconds, to check for connected instances [default: 600]

    -r, --relay-href <relay_href>                    The relay to query [default: relay.mastodon.host]
    -t, --request-timeout <timeout>
            Time, in seconds, to wait for requesting instance info before giving up [default: 15]


ARGS:
    <input>

Make sure you have your site.yml file set up

# site.yml
index:
  title: My Relay
  subtitle: "My Relay Description with a <a href=\"/about\">Link to the about page</a>"
about:
  title: My About Page
  subtitle: A description of things
  faq:
  - question: My First Question
    answer:
    - My First Answer
    - My First Answer Part 2

Via Docker

$ docker run --rm -p 8000:8000 -it -v "$(pwd):/extra" asonix/furryd:amd64-latest -r my.relay.host /extra/site.yml

Via Binary

$ furryd -r my.relay.host site.yml