diff --git a/README.md b/README.md index 1a455ee..58b2499 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Often, this is related to political attacks, but it will run the gamut of the weirdness on Earth. Groups of moderators are created, some working together, to allow them -to shape they server as they like. +to shape their server as they like. Rapidblock is software that allows Mastodon nodes to block unwanted servers more easily. It helps put the community back in charge of their own server. @@ -31,12 +31,28 @@ Or that's at least the goal, as far as I can tell. I am not the author of it. It is also in very early development, but is mature enough to try out, if you're familiar with server administration. -Here's notes so far. I haven't run it. Maybe soon. +* https://rapidblock.org/ -Quick & dirty build for Debian Bullseye (11/stable). +* https://github.com/rapidblock-org/rapidblock -Note, the `.deb` packages upstream use `zstd` compression, -which Bullseye `dpkg-deb` can't uncompress. +If you are running a `.deb` APT based distro, it may work for you to install +it thusly (if you don't mind running shell scripts unseen--insecure...). + +``` +curl -s https://apt.rapidblock.org/install.sh | sudo bash +``` + +If you want to go right into the repo and grab a `.deb`, they are here: + +* https://apt.rapidblock.org/pool/main/r/rapidblock/ + +Note, there are packages for both amd64 (x86) and arm64. +Those builds don't install on Debian Bullseye (11/stable) though, +because they use zstd compression, which Bullseye APT `dpkg-deb` +doesn't support. + +If you want to build it by hand, here's a +q uick & dirty build for Debian Bullseye (11/stable). To build, a newer `go` compiler is needed than ships in the main Bullseye repo. It is in the Bullseye backports repo. @@ -59,7 +75,39 @@ That should build a binary `rapidblock`. To confirm it works, run: ``` -./rapidblock --help +$ ./rapidblock --help +unknown option: --help +Usage: rapidblock [-tV] [-A value] [-c value] [-d value] [-D value] [-k value] [-m value] [-p value] [-s value] [-S value] [-x value] + -A, --account-data-file=value + [prepare-data] path to the groups.io cookies and database + column mappings + -c, --csv-file=value + [export-csv] path to the CSV file to create + -d, --data-file=value + [prepare-data, export-csv,sign, verify, apply] path to the + JSON file to create, export from, sign, verify, or apply + -D, --database-url=value + [apply] PostgreSQL database URL to connect to + -k, --private-key-file=value + [generate-key, sign] path to the base-64 Ed25519 private key + file to sign with + -m, --mode=value select mode of operation: prepare-data, + export-csv,generate-key, sign, verify, apply + -p, --public-key-file=value + [generate-key, sign, verify] path to the base-64 Ed25519 + public key file to verify with + -s, --signature-file=value + [sign, verify] path to the base-64 Ed25519 signature file to + create or verify + -S, --source-id=value + [prepare-data] ID of the Google Sheet spreadsheet to pull + data from + -t, --text [sign, verify] perform newline canonicalization, under the + assumption that --data-file is text + -V, --version show version information and exit + -x, --software=value + [apply] select which server software is in use: + mastodon-4.x, mastodon-3.x ```