Blocklist manager for Firefish
Go to file
emerald 3e257dd2e8
ci/woodpecker/push/publish Pipeline was successful Details
ci/woodpecker/tag/publish Pipeline was successful Details
fix: update docker build
2024-02-13 22:29:43 -05:00
.vscode improve editing 2023-09-30 05:15:39 +00:00
.woodpecker update woodpecker pipeline 2023-10-03 21:47:32 -04:00
src refactor: rename `PUBLIC_HOST_URL` to `PUBLIC_INSTANCE_URL` 2024-02-13 22:04:49 -05:00
static add copyright info 2023-10-07 11:58:12 -04:00
.dockerignore fix container build, bump deps 2023-12-08 22:02:57 -05:00
.env.example encrypt access token cookie 2023-10-03 23:44:43 -04:00
.eslintignore inital commit 2023-09-11 14:12:11 -04:00
.eslintrc.cjs inital commit 2023-09-11 14:12:11 -04:00
.gitignore Use modal for editing 2023-09-30 05:15:39 +00:00
.npmrc inital commit 2023-09-11 14:12:11 -04:00
.prettierignore inital commit 2023-09-11 14:12:11 -04:00
.prettierrc inital commit 2023-09-11 14:12:11 -04:00
.tool-versions more login work 2023-09-13 13:52:39 -04:00
COPYING Add GPLv3 license 2023-09-29 16:24:34 +00:00
Containerfile fix: update docker build 2024-02-13 22:29:43 -05:00
README.md chore: update readme 2024-02-13 22:04:49 -05:00
package.json v0.3.0 2024-02-13 22:05:47 -05:00
postcss.config.cjs inital commit 2023-09-11 14:12:11 -04:00
svelte.config.js refactor: rename `PUBLIC_HOST_URL` to `PUBLIC_INSTANCE_URL` 2024-02-13 22:04:49 -05:00
tailwind.config.ts polish, add metadata 2023-09-30 05:15:39 +00:00
tsconfig.json inital commit 2023-09-11 14:12:11 -04:00
vite.config.ts fix: only use moderators in local database 2024-01-22 18:51:37 -05:00
yarn.lock refactor: rename `PUBLIC_HOST_URL` to `PUBLIC_INSTANCE_URL` 2024-02-13 22:04:49 -05:00

README.md

outrigger

Public instance block list and manager for misskey forks

usage

Outrigger should be pretty easy to setup. A docker image is available at codeberg.org/anactualemerald/outrigger:latest, or you can build and run the node server yourself (find guides for both below). Outrigger currently isn't set up to handle TLS, so it should be run behind a reverse proxy like nginx or caddy (feel free to contribute this though, I haven't looked into it because it's not relevant to my setup).

configuration

There currently aren't a lot of server-side config options, but there are a few required environment variables:

  • OUTRIGGER_API_KEY: This is the token your Outrigger server will use to authenticate with your instance. One can be generated with settings -> api -> generate access token. The only permission ths key needs is View Instance Metadata, which requires admin perms to grant.
  • OUTRIGGER_ORIGIN: This should be the full URL that users will use to access your Outrigger frontend (eg. https://outrigger.example.social)
  • PUBLIC_INSTANCE_URL: This should be the full URL of the instance this Outrigger server is for (eg. https://example.social)

installation

Your docker-compose.yml should look something like this

services:
  outrigger:
    image: codeberg.org/anactualemerald/outrigger:latest
    restart: unless-stopped
    container_name: outrigger #optional, nice to have for docker networking
    environment:
      - PUBLIC_INSTANCE_URL=https://example.social
      - OUTRIGGER_API_KEY=skdjfw98y23jwfoudyfsg243yf
      - OUTRIGGER_ORIGIN=https://outrigger.example.social
    # - OUTRIGGER_DATA=/app/data # can be set to change where the sqlite database is created
    # - PORT=8080 # can be set to change the port the server will listen on
    volumes:
      - ./outrigger:/app/data
    ports:
      - 3000:3000 # not needed if using a docker network

node/manual

Clone the repo:

git clone https://codeberg.org/anactualemerald/outrigger.git && cd outrigger

Install dependencies and build:

yarn --frozen-lockfile && yarn build

Starting the server manually

Copy the .env file

cp .env.example .env

You should edit the values in .env to suit your setup. You'll probably want to add NODE_ENV=production.

Run through vite (I couldn't get the built server to pick up .env, but vite does):

yarn preview --host

Starting through systemd

If someone asks for an example unit file I will write one but for now I'll leave this as an excersize for the reader.

demo

The outrigger ui for the garden is available at https://blocking.mecha.garden