Skip to content

Commit

Permalink
Update doc and configs
Browse files Browse the repository at this point in the history
  • Loading branch information
Guillermo Gonzalez committed Aug 19, 2024
1 parent e8bcc5f commit 39dc69f
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 10 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,22 @@

### Environment variables

* `CHANNEL`: your channel user **@channel**
* `TOKEN`: your bot token, you can see [this post](https://binary-coffee.dev/post/como-hacer-un-bot-de-telegram-desde-cero-con-python)
* `RSS_FEED`: URL of the JSON feed of your blog. example `https://api.binary-coffee.dev/posts/feed/json1`
* `REFRESH_TIME`: interval of time to check for new items. default `60`
* `DATA_ADAPTER`: type of adapter used to save the data. example `MemoryAdapter`|`JsonAdapter`|`MongodbAdapter`
* `DATA_PATH`: (**JsonAdapter**) in case of use JsonAdapter, you can decide where to save the file. default `./data`.
* `DATABASE_HOST`: (**MongodbAdapter**) host for your mongodb database. default `localhost`
* `DATABASE_PORT`: (**MongodbAdapter**) port for your mongodb database. default `27017`
* `DATABASE_NAME`: (**MongodbAdapter**) database name. default `bc_db`
* Telegram variables
* `TELEGRAM_CHANNEL`: your telegram channel **@channel**
* `TELEGRAM_TOKEN`: your telegram bot token, you can see [this post](https://binary-coffee.dev/post/como-hacer-un-bot-de-telegram-desde-cero-con-python)
* Twitter variables
* `TWITTER_CONSUMER_KEY`: your twitter consumer key
* `TWITTER_CONSUMER_SECRET`: your twitter consumer secret
* `TWITTER_ACCESS_TOKEN`: your twitter access token
* `TWITTER_ACCESS_TOKEN_SECRET`: your twitter access token secret
* Application variables
* `RSS_FEED`: URL of the JSON feed of your blog. Example `https://api.binary-coffee.dev/posts/feed/json1`
* `REFRESH_TIME`: interval of time to check for new items. Default `60`
* `DATA_ADAPTER`: type of adapter used to save the data. Example `MemoryAdapter`|`JsonAdapter`|`MongodbAdapter`
* `DATA_PATH`: (**JsonAdapter**) in case of use JsonAdapter, you can decide where to save the file. Default `./data`.
* `DATABASE_HOST`: (**MongodbAdapter**) host for your mongodb database. Default `localhost`
* `DATABASE_PORT`: (**MongodbAdapter**) port for your mongodb database. Default `27017`
* `DATABASE_NAME`: (**MongodbAdapter**) database name. default `bc_db`

### Steps to start the bot

Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: "3.4"

services:
binary_coffee:
container_name: bot_telegram
container_name: bc_rss_bot
build:
context: .
volumes:
Expand Down

0 comments on commit 39dc69f

Please sign in to comment.