From 4cf758ce2fdbca050bf48f0f791f64bc989988ba Mon Sep 17 00:00:00 2001 From: dangered wolf Date: Fri, 15 Jul 2022 14:00:18 -0400 Subject: [PATCH] Updated README with deployment info! --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3e53893..0a8008b 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,8 @@ ✅ Private: We don't save tweets or their media (Outside of Cloudflare caching for speed) +-------------------- + Here's a little chart comparing features to Twitter default embeds and other embedding services | | pxTwitter | Twitter default | vxTwitter (BetterTwitFix) | Twxtter (sixFix) | @@ -39,11 +41,31 @@ Here's a little chart comparing features to Twitter default embeds and other emb ² pxTwitter and vxTwitter both ensure link privacy from the public. 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 +-------------------- + +## Why pxTwitter is better to develop for and deploy + +TwitFix and 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` (resource intensive, relatively) 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 pxTwitter 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. Authenticate with Cloudflare with `npx wrangler login`, then do `npx wrangler publish` (or `npm run publish`). + +[Check Cloudflare's guide for additional info](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 -- A subdomain to directly embed images and videos, without embeds (thanks @TheAppleFreak!) +- A subdomain to directly link to a tweet's image/video, without embeds (thanks @TheAppleFreak!) - 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)