/killswitch

Proxy API for yiff

Primary LanguageTypeScript

Killswitch

killswitch is a proxy api for fangmarks/yiff

Supported Sites:

  • e621.net
  • e926.net
  • yiff.rest
  • shibe.online
  • randomfox.ca
  • gelbooru.com

Note

If you don't see a site that's supported yet, but should be, open an Issue or if you're the owner of the API, make a PR!

Note

Please include a Link to the Documentation of the API, if possible, otherwise a Link to a Discord Server* where I can ask questions is also ok!

*(Don't Advertise random Servers that have noting to do with a API/Service or you'll be banned from this Repo)

Important

Support for Sheri has been dropped due to me being unable to test it, if you want to add support for it, feel free to make a PR

Important

Support for the Thaldrin and Floofy.dev API has been dropped to both of them being discontinued

Usage

All of these examples require you to have either Docker or Node and Git installed

Usage through Docker

Setting up a Killswitch Instance is as easy as running

sudo docker run -p 42069:3000 -d hokkqi/killswitch

NOTE: By default, Killswitch redirects to the Wiki if no REDIRECT Environment Variable is provided.

Building the Docker Image yourself (with custom options)

git clone https://github.com/fangmarks/killswitch

cd killswitch

sudo docker build --build-arg PORT=YourPort --build-arg REDIRECT=https://your.site -t hokkqi/killswitch .

Node / TS-Node

git clone https://github.com/fangmarks/killswitch

cd killswitch

#Node
npm run build && npm run start

#TS-Node
ts-node index.ts

Docs

For Docs, see the Wiki