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

update readme

Browse source
This commit is contained in:
stefano 2025-04-23 02:09:37 +02:00 • committed by GitHub
parent 244ebe1b1c
commit 1b3c426808
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 17 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

36
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,19 +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 cookies to access the content. please refer to [this page](AUTHENTICATION.md) for more information on how to set up authentication for each extractor. 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 tests * [ ] add tests
- [ ] add support for telegram webhooks * [ ] add support for telegram webhooks
- [ ] switch to pgsql (maybe) * [ ] switch to pgsql (maybe)
- [ ] better api * [ ] better api
- [ ] better docs * [ ] better docs
---