packages/govd
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Merge branch 'main' of https://github.com/govdbot/govd
Some checks failed
Build and deploy / build-and-push-image (push) Has been cancelled
Details

Browse source
This commit is contained in:
root 2025-04-23 00:41:03 +00:00
commit 762632c6c6
2 changed files with 27 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

9
AUTHENTICATION.md Normal file
View file

@ -0,0 +1,9 @@
# authentication
some extractors require cookies to access the content. you can export them from your browser in netscape format and place the file 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.

41
README.md
View file

@ -18,16 +18,17 @@ this project was born after the discontinuation of a highly popular bot known as
* [todo](#todo) * [todo](#todo)
# dependencies # dependencies
- ffmpeg >= 7.x **(*)** * ffmpeg >= 7.x
- libheif >= 1.19.7 * with shared libraries
- pkg-config * libheif >= 1.19.7
- mysql or mariadb * pkg-config
* sql database
**note:** libav shared libraries must be installed on the system in order to build the bot. * mysql or mariadb
# installation # installation
## build ## build
_this method only works on linux and macos, if you want to build the bot on windows, check [docker installation](#docker-recommended) instead._ > [!NOTE]
> there's no official support for windows yet. if you want to run the bot on it, please follow [docker installation](#docker-recommended)
1. clone the repository 1. clone the repository
```bash ```bash
@ -46,7 +47,6 @@ _this method only works on linux and macos, if you want to build the bot on wind
``` ```
## docker (recommended) ## docker (recommended)
1. build the image using the dockerfile: 1. build the image using the dockerfile:
```bash ```bash
@ -94,22 +94,17 @@ you can configure specific extractors options with `ext-cfg.yaml` file. document
# proxying # proxying
there are two types of proxying available: http and edge. there are two types of proxying available: http and edge.
- **http proxy**: this is a standard http proxy that can be used to route requests through a proxy server. you can set the `HTTP_PROXY` and `HTTPS_PROXY` environment variables to use this feature. (SOCKS5 is supported too) * **http proxy**: this is a standard http proxy that can be used to route requests through a proxy server. you can set the `HTTP_PROXY` and `HTTPS_PROXY` environment variables to use this feature. (SOCKS5 is supported too)
- **edge proxy**: this is a custom proxy that is used to route requests through a specific url. currenrly, you can only set this proxy with `ext-cfg.yaml` file. this is useful for routing requests through a specific server or service. however, this feature is not totally implemented yet. * **edge proxy**: this is a custom proxy that is used to route requests through a specific url. currenrly, you can only set this proxy with `ext-cfg.yaml` file. this is useful for routing requests through a specific server or service. however, this feature is not totally implemented yet.
> [!TIP]
**note:** by settings `NO_PROXY` environment variable, you can specify domains that should not be proxied. > by settings `NO_PROXY` environment variable, you can specify domains that should not be proxied.
# authentication # 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 # todo
- [ ] add more extractors * [ ] add tests
- [ ] switch to native libav * [ ] add support for telegram webhooks
- [ ] add tests * [ ] switch to pgsql (maybe)
- [ ] improve error handling * [ ] better api
- [ ] add support for telegram webhooks * [ ] better docs
- [ ] switch to pgsql (?)
- [ ] better api (?)
- [ ] better docs with multiple readme
---