https://github.com/fangmarks/killswitch
Proxy API for yiff
https://github.com/fangmarks/killswitch
Last synced: 11 months ago
JSON representation
Proxy API for yiff
- Host: GitHub
- URL: https://github.com/fangmarks/killswitch
- Owner: fangmarks
- Created: 2021-03-22T22:21:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-29T19:22:25.000Z (over 2 years ago)
- Last Synced: 2024-05-02T05:14:11.711Z (about 2 years ago)
- Language: TypeScript
- Homepage: https://yiff.click
- Size: 93.8 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Killswitch
killswitch is a proxy api for [fangmarks/yiff](https://lio.to/yiff)
Supported Sites:
- [x] e621.net
- [x] e926.net
- [x] yiff.rest
- [x] shibe.online
- [x] randomfox.ca
- [x] 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
```zsh
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)
```zsh
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
```zsh
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]
[the wiki]: https://github.com/farngmarks/killswitch/wiki