{"id":22847703,"url":"https://github.com/webexsamples/boilerplate-rss-bot","last_synced_at":"2025-04-30T04:15:59.824Z","repository":{"id":266706950,"uuid":"898698253","full_name":"WebexSamples/Boilerplate-RSS-bot","owner":"WebexSamples","description":null,"archived":false,"fork":false,"pushed_at":"2024-12-12T17:19:21.000Z","size":89,"stargazers_count":0,"open_issues_count":1,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-30T04:15:55.303Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WebexSamples.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-04T21:37:45.000Z","updated_at":"2024-12-12T17:19:26.000Z","dependencies_parsed_at":"2024-12-05T17:33:06.773Z","dependency_job_id":"e10c26a7-70ff-4cef-9a6f-82624f1cd0b5","html_url":"https://github.com/WebexSamples/Boilerplate-RSS-bot","commit_stats":null,"previous_names":["webexsamples/boilerplate-rss-bot"],"tags_count":0,"template":false,"template_full_name":"WebexSamples/Webex-Samples-Template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebexSamples%2FBoilerplate-RSS-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebexSamples%2FBoilerplate-RSS-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebexSamples%2FBoilerplate-RSS-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebexSamples%2FBoilerplate-RSS-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WebexSamples","download_url":"https://codeload.github.com/WebexSamples/Boilerplate-RSS-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251638822,"owners_count":21619668,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-13T04:09:11.349Z","updated_at":"2025-04-30T04:15:59.804Z","avatar_url":"https://github.com/WebexSamples.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Boilerplate-RSS-bot\n\n## RSS Bot for Webex\n\nThe RSS bot for Webex is a boilerplate parser bot designed to digest the data provided from any compatible RSS Feeds, and update a Webex space of your choosing whenever there is a new feed.\n\n**Note:** No initial messages will be published to the spaces when app is loaded. Only when a message is received on the RSS Feed it will be published into the respective space.\n\n## Prerequisites\n\n1. Register a Bot at [Webex Developers](https://developer.webex.com/my-apps) for your Organization, noting the Token ID\n2. Create Spaces for Output Messages in Webex App (or skip to step 3 if you have a space/room already)\n3. Obtain RoomId for the space/room\n4. Add Bot created in Step 1 to your space.\n5. Create a .env file and add the required variables below.\n\n## Deployment (Local)\n\n1. Clone / Download repository\n2. Run `npm install` to add the require dependencies (ensure Node and NPM are installed)\n3. Create an `.env` file and include the required variables outlined below.\n\n- Recommend adding `CONSOLE_LEVEL=debug` during initial testing\n\n4. Start the integration using `npm run start`\n5. Review the console logs to confirm no errors encountered\n6. As a suggestion for your Tests, you can use this sample feed https://lorem-rss.herokuapp.com/feed?unit=second\u0026interval=30. It creates a new feed every 30 seconds.\n\n## Deployment (Docker)\n\nThe simplest deployment method is using [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/)\n\n1. Clone / Download repository\n   - Only docker-compose.yml is needed if using prebuilt docker image\n2. Update the included docker-compose.yml file with the correct Environmental parameters\n3. - Use the prebuilt image available on Docker Hub (default in docker-compose.yml)\n   - Build local image - Uncomment build and comment image line in docker-compose.yml\n4. Provision and start the service using `docker-compose up -d`\n5. Review the console logs using `docker logs rss-service -f` (assuming you are using the default container name)\n\n### Environment Variables\n\nThese variables can be individually defined in Docker, or loaded as an `.env` file in the `/app` directory.\n\n| Name | Type | Default | Description\n| ---- | ---- | ------- | -----------\n| TOKEN | **Required** | ` ` | Bot Token for Webex Messaging Posts\n| FEED_ROOM_ID | **Required** | ` ` | RoomId for Webex Announcement Space\n| RSS_FEED_URL | **Required** | ` ` | Rss Feed URL to get the feeds \n| RSS_INTERVAL | Optional | `5` | Interval for RSS Checks (Seconds)\n| **Logging Settings**\n| CONSOLE_LEVEL | no | bool | `info` | Logging level exposed to console\n| APP_NAME | no | string | `rss-service` | App Name used for logging service\n| SYSLOG_ENABLED | no | bool | `false` | Enable external syslog server\n| SYSLOG_HOST | no | string | `syslog` | Destination host for syslog server\n| SYSLOG_PORT | no | num | `514` | Destination port for syslog server\n| SYSLOG_PROTOCOL | no | str | `udp4` | Destination protocol for syslog server\n| SYSLOG_SOURCE | no | str | `localhost` | Host to indicate that log messages are coming from\n| LOKI_ENABLED | no | bool | `false` | Enable external Loki logging server\n| LOKI_HOST| no | string | `http://loki:3100` | Destination host for Loki logging server\n| **HTTP Proxy**\n| GLOBAL_AGENT_HTTP_PROXY | no | string | ` ` | Container HTTP Proxy Server (format `http://\u003cip or fqdn\u003e:\u003cport\u003e`)\n| GLOBAL_AGENT_NO_PROXY | no | string | ` ` | Comma Separated List of excluded proxy domains (Supports wildcards)\n| NODE_EXTRA_CA_CERTS | no | string | ` ` | Include extra CA Cert bundle if required, (PEM format) ensure location is attached as a volume to the container\n\n\n## Support\n\nIn case you've found a bug, please open a ticket with the [Webex Developer Support Team](https://developer.webex.com/support).\n\n## Disclaimer\n\nThis application is provided as a sample only and is NOT guaranteed to be bug free and of Production quality.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebexsamples%2Fboilerplate-rss-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebexsamples%2Fboilerplate-rss-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebexsamples%2Fboilerplate-rss-bot/lists"}