4.0 KiB
Twxtter/sixFix
(A fork of TwitFix) Basic flask server that serves fixed twitter video embeds to desktop discord by using either the Twitter API or Youtube-DL to grab tweet video information.
This repository adds support for Nix and restricts lots of features to make running it alongside Nitter a lot simpler. You'll still have to use a custom NGINX config, however
Regarding what happened to TwitFix: http://blog.hirob.in/2022-05-16-Goodbye-TwitFix/
How to use (discord side)
https://nitter.oat.zone/[twitter video url] or [last half of twitter url])
How to run (server side)
If you want to run this on a non-Nix installation, follow the same instruction as upsteam
Otherwise, import the flake.nix file (or run nix flake run)
Config
Twxtter generates a config.json in its root directory the first time you run it, the options are:
API - This will be where you put the credentials for your twitter API if you use this method
database - This is where you put the URL to your mongoDB database if you are using one
link_cache - (Options: db, json)
- db: Caches all links to a mongoDB database. This should be used it you are using uWSGI and are not just running the script on its own as one worker
- json: This saves cached links to a local links.json file
method - ( Options: youtube-dl, api, hybrid )
-
youtube-dl: the original method for grabbing twitter video links, this uses a guest token provided via youtube-dl and should work well for individual instances, but may not scale up to a very large amount of usage
-
api: this directly uses the twitter API to grab tweet info, limited to 900 calls per 15m
-
hybrid: This will start off by using the twitter API to grab tweet info, but if the rate limit is reached or the api fails for any other reason it will switch over to youtube-dl to avoid downtime
color - Accepts a hex formatted color code, can change the embed color
appname - Can change the app name easily wherever it's shown
repo - used to change the repo url that some links redirect to
url - used to tell the user where to look for the oembed endpoint, make sure to set this to your public facing url
This project is licensed under the Do What The Fuck You Want Public License
Other stuff
Going to https://twxtter.com/latest/ will present a page that shows the all the latest tweets that were added to the database, use with caution as results may be nsfw! Current page created by @DorukSaga
Using the /dir/<video-url> endpoint will return a redirect to the direct MP4 link, this can be useful for downloading a video
Using the /dl/<video-url> or appending a .mp4 will make the server download the video and return a static, locally hosted copy
Using the subdomain d.twxtter.com/<video-url> will redirect to a direct MP4 url hosted on Twitter
Using the /info/<video-url> endpoint will return a json that contains all video info that youtube-dl can grab about any given video
Using /other/<video-url> will attempt to run the twitter embed stuff on other websites videos - This is mostly experimental and doesn't really work for now
Using /api/latest/ will return a json with the latest tweet added to the database. Takes params ?tweets=INT&=pageINT to return multiple
Using /api/top/ will return a json with the most hit tweet in the database. Takes params ?tweets=INT&=pageINT to return multiple
Using /api/stats/ will return a json with some stats about TwitFix's activity (embeds, new cached links, API hits, downloads). Takes param ?=date"YYYY-MM-DD" to return a specific day, otherwise will return today's stats to far
Advanced embeds are provided via a /oembed.json? endpoint - This is manually pointing at my server in /templates/index.html and should be changed from https://twxtter.com/ to whatever your domain is