mirror of
https://github.com/CompeyDev/fxtwitter-docker.git
synced 2025-04-05 18:40:56 +01:00
115 lines
8.5 KiB
Markdown
115 lines
8.5 KiB
Markdown
# pxTwitter (Twittpr)
|
|
|
|
[](https://github.com/dangeredwolf/pxtwitter/actions/workflows/webpack.yml)
|
|
|
|
## A TwitFix-like service that _does more_ with better privacy in mind. Written in TypeScript for Cloudflare Workers!
|
|
|
|
### Embed videos, polls, and more on Discord, Telegram, and others!
|
|
|
|
### On Discord, send a Twitter link and type `s/e/p` to make `twittpr.com`.
|
|
|
|
### Otherwise, just add `px` before `twitter` to make `pxtwitter.com`
|
|
|
|
|
|
|
|
:heavy_check_mark: **Embed Videos** (Including Twitter videos and compatible external providers, such as YouTube)
|
|
|
|
:heavy_check_mark: **Embed Poll results**
|
|
|
|
:heavy_check_mark: **Embed Quote Tweets** (Including their media, if it doesn't conflict with the linked tweet)
|
|
|
|
:heavy_check_mark: **Replace embedded t.co shortener with original links**
|
|
|
|
:heavy_check_mark: **Creates media/profile picture color-matching theme-color** (looks great on Discord!)
|
|
|
|
:heavy_check_mark: **Better privacy: We don't save tweets or their media** (Outside of temporary Cloudflare caching for speed)
|
|
|
|
---
|
|
|
|
## Advanced features
|
|
|
|
### Direct media links
|
|
|
|
Want to link directly to a Tweet's media without the embed? You can do that with pxTwitter.
|
|
|
|
|
|
|
|
There's a few supported ways to do this:
|
|
|
|
- Add `d.` or `dl.` before the domain (so, `d.twittpr.com` or `dl.pxtwitter.com`)
|
|
- Add `.mp4` to the end of videos or `.jpg` to the end of images, after the tweet ID
|
|
- Add `/dl` or `/dir` between the domain and the username
|
|
|
|
Examples from above:
|
|
|
|
- `https://d.twittpr.com/dangeredwolf/status/1548119328498728960`
|
|
- `https://pxtwitter.com/dangeredwolf/status/1548117889437208581.jpg`
|
|
- `https://pxtwitter.com/dl/dangeredwolf/status/1548117889437208581`
|
|
|
|
Tweets with multiple images are supported, so you can do something like this and it will pick the correct one:
|
|
|
|
`https://d.twittpr.com/dangeredwolf/status/1547514042146865153/photo/3`
|
|
|
|
Otherwise, it will default to the first image.
|
|
|
|
---
|
|
|
|
## Why use pxTwitter?
|
|
|
|
In many ways, pxTwitter has richer embeds and does more. Here's a table comparing some of pxTwitter's features compared to Twitter default embeds as well as other embedding services
|
|
|
|
| | pxTwitter | Twitter default | vxTwitter (BetterTwitFix) | Twxtter (sixFix) |
|
|
| --------------------------------------- | :----------------: | :------------------------------: | :-----------------------------------: | :-----------------------------------: |
|
|
| Embed Tweets / Images | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
|
| Embed profile pictures on text Tweets | :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: |
|
|
| Embed Twitter Videos | :heavy_check_mark: | :x:¹ | :heavy_check_mark: | :heavy_check_mark: |
|
|
| Embed External Videos (YouTube, etc.) | :heavy_check_mark: | :x: | :x:⁴ | :x: |
|
|
| Embed Poll results | :heavy_check_mark: | :x: | :x: | :x: |
|
|
| Embed Quote Tweets | :heavy_check_mark: | :x: | :ballot_box_with_check: Without Media | :ballot_box_with_check: Without Media |
|
|
| Embed Multiple Images | :x: | :heavy_minus_sign: Discord Only³ | With c.vxtwitter.com | :x: |
|
|
| Publicly accessible embed index | :x:² | N/A | :x:² | :heavy_check_mark: |
|
|
| Replace t.co with original links | :heavy_check_mark: | :x: | :x: | :x: |
|
|
| Media-based embed colors on Discord | :heavy_check_mark: | :x: | :x: | :x: |
|
|
| Redirect to media file (wihout embed) | :heavy_check_mark: | :x: | :x: | :heavy_check_mark: |
|
|
| Strip Twitter tracking info on redirect | :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: |
|
|
| Show retweet / like counts | :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: |
|
|
| Discord sed replace (`s/`) friendly | twittpr.com | :x: | :x: | :heavy_check_mark: |
|
|
|
|
¹ Discord will attempt to embed Twitter's video player, but it is unreliable
|
|
|
|
² Neither pxTwitter or vxTwitter have a public embed ledger, for privacy reasons. vxTwitter still stores all responses in a database / JSON file controlled by the owner. pxTwitter by contrast relies on Cloudflare caching of responses: there is no link store accessible to the owner.
|
|
|
|
³ Discord uses a custom embed container for Twitter.com to enable multi-image, which is unfortunately not available to other websites.
|
|
|
|
⁴ On GitHub, BetterTwitFix (vxTwitter) claims to support this feature, however in my testing as of mid-July 2022, this does not seem to work.
|
|
|
|
---
|
|
|
|
## Why pxTwitter is nicer to develop for and deploy
|
|
|
|
TwitFix and its derivatives have quite a few dependencies you need to rely on. You need to set up a server somewhere, install Python, all its dependencies, then either set up `youtube-dl` (more resource intensive) or [beg Twitter for API access](https://twitter.com/dangeredwolf/status/1438983606135832581), and optionally set up a database, otherwise it uses the file system to cache.
|
|
|
|
pxTwitter was written from the start as a lightweight, TypeScript-based Cloudflare Worker. Cloudflare Workers are completely free for up to 100,000 requests per day, per account. Cloudflare Workers are [fast to set up](https://developers.cloudflare.com/workers/get-started/guide/) and your script is distributed in their datacenters around the world for lower latency.
|
|
|
|
pxTwitter does not need a database nor a Twitter API key: It takes a similar approach to `youtube-dl` where it pretends to be a logged-out Twitter web user, fetching a guest token and making API requests from there. As far as I can tell, this basically means we have "unlimited" read-only access to Twitter's API, including things they don't expose in their public API, useful for polls and other features.
|
|
|
|
## Deploy pxTwitter yourself
|
|
|
|
Clone the repo, install [Node.js](https://nodejs.org/) and run `npm install` in the repo directory. Copy `wrangler.example.toml` to `wrangler.toml` and add your [Cloudflare account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/), and change the name of your worker if you need to. Also copy `.env.example` to `.env` and change HOST_URL, DIRECT_MEDIA_DOMAINS to your desired domain and whatever else you need to do. Authenticate with Cloudflare with `npx wrangler login`, then do `npx wrangler publish` (or `npm run publish`).
|
|
|
|
[If you have more questions about setting up Cloudflare Workers, check out their Getting Started guide](https://developers.cloudflare.com/workers/get-started/guide/).
|
|
|
|
Once you're set up with your worker on `*.workers.dev`, [add your worker to your custom domain](https://developers.cloudflare.com/workers/platform/routing/custom-domains/).
|
|
|
|
---
|
|
|
|
**Licensed under the permissive MIT license. Feel free to send a pull request!**
|
|
|
|
### Things to tackle in the future
|
|
|
|
- Combining multiple images together (would be outside CF Worker)
|
|
- Caching guest token (So we don't have to bother Twitter for one on every request)
|
|
|
|
### Bugs or issues?
|
|
|
|
Feel free to [open an issue](https://github.com/dangeredwolf/pxTwitter/issues), or [ping me on Twitter and I'll see what I can do](https://twitter.com/dangeredwolf).
|