Files
cockinator/README.md
Kira 3b1b00928a
All checks were successful
Build and Push Docker Image / build (push) Successful in 17s
stoat basic functionality, most things just dont work with this api yet
2026-04-02 21:00:19 -04:00

41 lines
1.3 KiB
Markdown

# girl cock inator
it finds twitter links and turns them into girlcock links for better embed
rebuilt for [Stoat](https://stoat.chat), missing everything but the core functionality
## easiest way
docker image published at `git.cesium.one/kira/cockinator:stoat` only needs `TOKEN` passed as a variable with your token
### examples
`docker run -e "TOKEN=TOKEN_HERE" git.cesium.one/kira/cockinator:stoat`
```yml
services:
bot:
restart: unless-stopped
image: git.cesium.one/kira/cockinator:stoat
environment:
- TOKEN=TOKEN_HERE
```
## easy way
this also works in not docker with regular node.js (v22.15+), and pass it the `TOKEN` variable however you like
`npm i && TOKEN=TOKEN_HERE node index.js`
## other ways
you can build the image yourself with `docker build . -t cockinator` to then run with `docker run cockinator`
you can also build the image with docker-compose, by replacing `image: git.cesium.one/kira/cockinator:stoat` with `build: .`
## the config file
we only need the config to customize the initial status of the bot, so if you wanna do that, you can copy `config.json.default` to `config.json` and fill it in
it'll need to be in the main directory, and for docker that means mounting it as a volume with `-v ./config.json:/app/config.json`