pusk/README.md

44 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2024-08-11 16:34:15 +02:00
# Pusk ![status-badge](https://git.mylloon.fr/Anri/pusk/badges/workflows/publish.yml/badge.svg)
2023-05-12 09:43:21 +02:00
2023-05-16 02:19:56 +02:00
Send a tweet to prevent Twitter from closing your account, using a webdriver.
2023-05-15 17:25:15 +02:00
2023-05-16 01:41:19 +02:00
## How to use?
2023-05-12 09:43:21 +02:00
2023-05-16 01:41:19 +02:00
## With Docker
You can use this dockercompose template:
```yaml
services:
pusk:
2023-05-16 02:28:49 +02:00
image: git.mylloon.fr/anri/pusk:latest
2023-05-16 01:41:19 +02:00
container_name: Pusk
environment:
- TWITTER_USERNAME=yourusername # not your mail
2024-03-09 15:52:16 +01:00
- TWITTER_PASSWORD=yourpassword # in dockercompose, you need to double $ signs in your password
2023-05-16 01:41:19 +02:00
- TWITTER_TOTP=yourseed # optional if you don't have 2fa
2023-05-16 01:55:55 +02:00
- PUSK_DEBUG=FALSE # optional
2024-01-26 15:44:28 +01:00
- PUSK_HASHTAG=TRUE # optional, will add an hashtag to tweets
2023-05-16 01:41:19 +02:00
restart: unless-stopped
2023-05-12 09:43:21 +02:00
```
2023-05-16 01:41:19 +02:00
## Local
2023-05-12 09:43:21 +02:00
2024-01-26 16:02:27 +01:00
- Firefox installed
2023-05-16 01:41:19 +02:00
- You will need these dependencies:
2023-05-16 01:41:19 +02:00
```sh
2023-05-16 03:32:27 +02:00
$ opam install cohttp-lwt-unix dotenv twostep lwt_ssl yojson core
2023-05-16 01:41:19 +02:00
```
2023-05-16 01:41:19 +02:00
- 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.