From b5d6c48a1680179e6d4c5711d97ccf36fc44266f Mon Sep 17 00:00:00 2001 From: stefanodvx <69367859+stefanodvx@users.noreply.github.com> Date: Wed, 23 Apr 2025 01:57:20 +0200 Subject: [PATCH] readme updated --- AUTHENTICATION.md | 9 +++++++++ README.md | 11 ++++------- 2 files changed, 13 insertions(+), 7 deletions(-) create mode 100644 AUTHENTICATION.md diff --git a/AUTHENTICATION.md b/AUTHENTICATION.md new file mode 100644 index 0000000..21323c7 --- /dev/null +++ b/AUTHENTICATION.md @@ -0,0 +1,9 @@ +# authentication +some extractors require authentication to access the content. simply export cookies from your browser in netscape format and place them in cookies folder (e.g. `cookies/reddit.txt`). you can easily export cookies using _Get cookies.txt LOCALLY_ extension for your browser ([chrome](https://chrome.google.com/webstore/detail/get-cookies-txt-locally/nhdogjmejiglipccpnnnanhbledajbpd) - [firefox](https://addons.mozilla.org/en-US/firefox/addon/get-cookies-txt-locally/)). + +extractors that **need** authentication: +- reddit +- twitter + +> [!CAUTION] +> using cookies _may_ be leading to account bans. we are not responsible for any bans or issues that may arise from using cookies. if you are using cookies, please make sure to use them responsibly and at your own risk. \ No newline at end of file diff --git a/README.md b/README.md index 9b37664..9807bd4 100644 --- a/README.md +++ b/README.md @@ -100,16 +100,13 @@ there are two types of proxying available: http and edge. **note:** by settings `NO_PROXY` environment variable, you can specify domains that should not be proxied. # authentication -some extractors require authentication to access the content. you can easily use cookies for that; simply export cookies from your browser in netscape format and place them in cookies folder (e.g. `cookies/reddit.txt`). you can easily export cookies using _Get cookies.txt LOCALLY_ extension for your browser. +some extractors require cookies to access the content. please refer to [this page](AUTHENTICATION.md) for more information on how to set up authentication for each extractor. # todo -- [ ] add more extractors -- [ ] switch to native libav - [ ] add tests -- [ ] improve error handling - [ ] add support for telegram webhooks -- [ ] switch to pgsql (?) -- [ ] better api (?) -- [ ] better docs with multiple readme +- [ ] switch to pgsql (maybe) +- [ ] better api +- [ ] better docs --- \ No newline at end of file