pusk/README.md
Mylloon 5e6c764ae4
All checks were successful
ci/woodpecker/push/publish Pipeline was successful
remove useless deps
2023-05-16 03:32:27 +02:00

43 lines
1,017 B
Markdown

# Pusk [![status-badge](https://ci.mylloon.fr/api/badges/Anri/pusk/status.svg)](https://ci.mylloon.fr/Anri/pusk)
Send a tweet to prevent Twitter from closing your account, using a webdriver.
## How to use?
## With Docker
You can use this dockercompose template:
```yaml
version: "3.9"
services:
pusk:
image: git.mylloon.fr/anri/pusk:latest
container_name: Pusk
environment:
- TWITTER_USERNAME=yourusername # not your mail
- TWITTER_PASSWORD=yourpassword # take care, you need to double $ signs in your password
- TWITTER_TOTP=yourseed # optional if you don't have 2fa
- PUSK_DEBUG=FALSE # optional
restart: unless-stopped
```
## Local
- You will need these dependencies:
```sh
$ opam install cohttp-lwt-unix dotenv twostep lwt_ssl yojson core
```
- Populate your credentials in [config/.env](./config/.env)
- Then you can run the bot with:
```sh
$ dune exec pusk
```
## Name history
Derived from Elon's name :D. Thanks, Elon, for destroying Twitter.