dark-firepit
/
Twxtter-main
Archived
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

modify readme

This commit is contained in:
Jill 2022-08-02 04:50:54 +02:00
parent 9495bcee59
commit b1e7e19ffa
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
readme.md
View File

@ -2,23 +2,21 @@
(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://twxtter.com/[twitter video url] or [last half of twitter url])
https://nitter.oat.zone/[twitter video url] or [last half of twitter url])
```
You can also simply type out `s/i/x` on PC and iOS after sending a twitter link to discord, and it will edit the last message (The link) to replace the first i with x.
**Note**: If you enjoy this service, please considering donating via [Ko-Fi](https://ko-fi.com/twxtter) to help cover server costs
## How to run (server side)
this script uses the youtube-dl python module, along with flask, twitter and pymongo, so install those with pip (you can use `pip install -r requirements.txt`) and start the server with `python twitfix.py`
If you want to run this on a non-Nix installation, [follow the same instruction as upsteam](https://github.com/Twxtter/Twxtter-main#how-to-run-server-side)
I have included some files to give you a head start on setting this server up with uWSGI, though if you decide to use uWSGI I suggest you set up mongoDB link caching
Otherwise, import the `flake.nix` file (or run `nix flake run`)
### Config