├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── config.yml └── workflows │ └── new-issue.yml └── README.md /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve. Note that reports that are not bugs will generally not be accepted. 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | --- 8 | 9 | ## Prerequisites 10 | 11 | These are MANDATORY, otherwise the issue will be automatically closed. 12 | 13 | 14 | * [] I agree to fill this issue template. 15 | * [] I have read the [Troubleshooting Guide] and [Support Instructions]. 16 | 17 | [Troubleshooting Guide]: https://doc-kurento.readthedocs.io/en/latest/user/troubleshooting.html 18 | [Support Instructions]: https://github.com/Kurento/.github/blob/master/SUPPORT.md 19 | 20 | 21 | ## Issue description 22 | 23 | 28 | 29 | 30 | ## Context 31 | 32 | 36 | 37 | 38 | ## How to reproduce? 39 | 40 | 50 | 51 | 52 | ## Expected & current behavior 53 | 54 | 55 | 56 | 57 | ## (Optional) Possible solution 58 | 59 | 63 | 64 | 65 | ## Info about your environment 66 | 67 | 79 | 80 | 81 | ### About Kurento Media Server 82 | 83 | * Kurento version: 84 | * Server OS: 85 | * Installation method: 86 | 87 | - [] [apt-get] 88 | - [] [Docker] 89 | - [] [AWS CloudFormation] 90 | - [] [Built from sources] 91 | 92 | [apt-get]: https://doc-kurento.readthedocs.io/en/latest/user/installation.html#installation-local 93 | [Docker]: https://doc-kurento.readthedocs.io/en/latest/user/installation.html#installation-docker 94 | [AWS CloudFormation]: https://doc-kurento.readthedocs.io/en/latest/user/installation.html#installation-aws 95 | [Built from sources]: https://doc-kurento.readthedocs.io/en/latest/dev/dev_guide.html#dev-sources 96 | 97 | 98 | ### About your Application Server 99 | 100 | * Programming Language: 101 | * Kurento Client version: 102 | 103 | 104 | ### About end-user clients 105 | 106 | * Device(s): 107 | * OS(es): 108 | * Browser(s): 109 | 110 | 111 | ### Run these commands 112 | 113 | 117 | 118 | ``` 119 | cat /etc/lsb-release 120 | ``` 121 | 122 | ``` 123 | kurento-media-server --version 124 | ``` 125 | 126 | ``` 127 | dpkg -l | grep -Pi 'kurento|kms-|gst.*1.5|nice' 128 | ``` 129 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: Community Support (Kurento Public Mailing List) 4 | url: https://groups.google.com/forum/#!forum/kurento 5 | about: Discussion forum where to ask and answer questions about how to use Kurento. 6 | - name: Commercial Support (Kurento Team) 7 | url: https://doc-kurento.readthedocs.io/en/latest/user/support.html#support-commercial 8 | about: We provide priority support and consulting services. This funds our team and keeps the Kurento project alive. 9 | -------------------------------------------------------------------------------- /.github/workflows/new-issue.yml: -------------------------------------------------------------------------------- 1 | # Workflow syntax for GitHub Actions: 2 | # https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions 3 | 4 | # Run some verification and organizative work on each newly opened issue. 5 | name: New-Issue 6 | 7 | # Run only when a new issue is opened. 8 | # (roots/issue-closer action doesn't support other event types) 9 | on: 10 | issues: 11 | types: [opened] 12 | 13 | jobs: 14 | # Verify that the issue is valid in form. 15 | validate-issue: 16 | name: Validate issue 17 | runs-on: ubuntu-latest 18 | 19 | steps: 20 | # Close the issue if its body doesn't match a regular expression. 21 | # Action: https://github.com/marketplace/actions/issue-auto-closer 22 | - id: auto-closer 23 | name: Issue auto-closer 24 | uses: roots/issue-closer-action@v1.1 25 | with: 26 | repo-token: ${{ secrets.GITHUB_TOKEN }} 27 | issue-pattern: "I agree to fill this issue template" 28 | issue-close-message: > 29 | Hello @${{ github.event.issue.user.login }}! :wave: we're sorry you 30 | found a bug... so first of all, thank you very much for reporting 31 | it. 32 | 33 | 34 | However, **your report doesn't follow the [issue template](https://raw.githubusercontent.com/Kurento/bugtracker/master/.github/ISSUE_TEMPLATE/bug_report.md)**, 35 | so it is being automatically closed. We are really sorry for that, 36 | but we need all reports to follow the template, or else it won't be 37 | possible to understand and help with all issues. 38 | 39 | 40 | Please, create a new issue following the template, or reopen this 41 | same issue to edit and provide all required information. 42 | 43 | # Get the current Issue data, to see if "auto-closer" closed it. 44 | # Action: https://github.com/marketplace/actions/github-api-request 45 | # GitHub API: https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#get-an-issue 46 | - id: get-issue 47 | name: Get Issue Data 48 | uses: octokit/request-action@v2.x 49 | with: 50 | route: GET /repos/:owner/:repo/issues/:issue_number 51 | owner: ${{ github.event.repository.owner.login }} 52 | repo: ${{ github.event.repository.name }} 53 | issue_number: ${{ github.event.issue.number }} 54 | env: 55 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 56 | 57 | # Cancel the whole workflow if "auto-closer" closed the issue. 58 | # Action: https://github.com/marketplace/actions/cancel-this-build 59 | - name: Cancel this build 60 | uses: andymckay/cancel-action@0.2 61 | if: ${{ fromJson(steps.get-issue.outputs.data).state != 'open' }} 62 | 63 | # Accept the issue by sending a thank you message and sorting it. 64 | accept-issue: 65 | name: Accept issue 66 | runs-on: ubuntu-latest 67 | 68 | # Wait for previous job to finish (disable parallel run). 69 | needs: validate-issue 70 | 71 | steps: 72 | # Add a welcome message. 73 | # Action: https://github.com/marketplace/actions/create-or-update-comment 74 | - name: Create or Update Comment 75 | uses: peter-evans/create-or-update-comment@v1.4.3 76 | with: 77 | issue-number: ${{ github.event.issue.number }} 78 | body: > 79 | Hello @${{ github.event.issue.user.login }}! :wave: we're sorry you 80 | found a bug... so first of all, thank you very much for reporting 81 | it. 82 | 83 | 84 | To know about progress, check in 85 | **[Triage](https://github.com/orgs/Kurento/projects/1)**. All issues 86 | are considered 87 | [Backlog Candidates](https://github.com/orgs/Kurento/projects/1#column-4137933) 88 | until work priorities align and the issue is selected for 89 | development. It will then become part of our official 90 | [Backlog](https://github.com/orgs/Kurento/projects/1#column-4140448). 91 | 92 | # Add new issues to the Triage project. 93 | # Action: https://github.com/marketplace/actions/github-project-automation 94 | - name: GitHub Project Automation+ 95 | uses: alex-page/github-project-automation-plus@v0.3.0 96 | with: 97 | repo-token: ${{ secrets.NEW_ISSUE_TOKEN }} 98 | project: Triage 99 | column: Backlog Candidates 100 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # [ARCHIVED] Contents migrated to monorepo 2 | 3 | ## This issue tracker is no longer active 4 | 5 | The new place for Kurento issues is in the [Kurento monorepo Issues](https://github.com/Kurento/kurento/issues) section, here: 6 | https://github.com/Kurento/kurento/issues 7 | 8 | Following the migration of all Kurento source code to the [Kurento monorepo](https://github.com/Kurento/kurento), this repository / bug tracker that you are currently seeing is also being discontinued. 9 | 10 | The old issues that are open in this repository are still considered valid, and if/when work is done on them, they will be moved on a case-by-case basis to the new issue tracker. 11 | 12 | [![License badge](https://img.shields.io/badge/license-Apache2-orange.svg)](http://www.apache.org/licenses/LICENSE-2.0) 13 | [![Documentation badge](https://readthedocs.org/projects/fiware-orion/badge/?version=latest)](https://doc-kurento.readthedocs.io) 14 | [![Docker badge](https://img.shields.io/docker/pulls/fiware/orion.svg)](https://hub.docker.com/r/fiware/stream-oriented-kurento/) 15 | [![Support badge]( https://img.shields.io/badge/support-sof-yellowgreen.svg)](https://stackoverflow.com/questions/tagged/kurento) 16 | 17 | [![][KurentoImage]][Kurento] 18 | 19 | Copyright 2018 [Kurento]. Licensed under [Apache 2.0 License]. 20 | 21 | [Kurento]: https://kurento.openvidu.io/ 22 | [KurentoImage]: https://secure.gravatar.com/avatar/21a2a12c56b2a91c8918d5779f1778bf?s=120 23 | [Apache 2.0 License]: http://www.apache.org/licenses/LICENSE-2.0 24 | 25 | 26 | 27 | Kurento Bug Tracker 28 | =================== 29 | 30 | Reporting Issues 31 | ---------------- 32 | 33 | When reporting a bug, please include as much information as possible, this will help us solve the problem. Also, try to follow these guidelines as closely as possible, because they make it easier for people to work on the issue, and that means more chances that the issue gets fixed: 34 | 35 | - **Be proactive**. If you are working with an old version of Kurento, please check with newer versions, specially with the [latest pre-release version](https://doc-kurento.readthedocs.io/en/latest/user/installation_dev.html). We can't emphasize this enough: *it's the first thing that we are going to ask*. 36 | 37 | - **Be curious**. Has it been asked before? Is it really a bug? Everybody hates duplicated reports. The Search tool is your friend! 38 | 39 | - **Be precise**. Don't wander around your situation and go straight to the point, unless the context around it is technically required to understand what is going on. Describe as precisely as possible what you are doing and what is happening but you think that shouldn't happen. 40 | 41 | - **Be specific**. Explain how to reproduce the problem, being very systematic about it: step by step, so others can reproduce the bug. Also, report *only one problem per opened issue*. 42 | 43 | 44 | 45 | How to report a bug 46 | ------------------- 47 | 48 | ### Is it really a bug? 49 | 50 | The first thing before reporting a bug, is to really make sure it is a bug. Many of the messages from the list are not bugs: coding issues, configuration problems... In order to make sure there is indeed a bug, you can follow this checklist: 51 | 52 | * Read the documentation: If the answer is in the documentation, the answer will be "Read the documentation!"... one mail round wasted. 53 | 54 | * Check the documentation to test with the [latest pre-release version](https://doc-kurento.readthedocs.io/en/latest/user/installation_dev.html). Note: You might have to run `sudo apt-get install dist-upgrade` in some cases, if you see the message `The following packages have been kept back ...` 55 | 56 | * Is WebRTC working in your target browser? use the [WebRTC test page] to check it out. 57 | 58 | * Is it working on a different browser? 59 | 60 | * If you are using TURN/STUN, make sure it is working using this [STUN/TURN testing] page. 61 | 62 | * Is there a tutorial that does exactly what you are trying to do? Check out the code from GitHub, run it in your machine and see what happens. Those tutorials are tested in our CI environment, so you can be quite certain they are in good shape. 63 | 64 | * Check your pipeline. Make a drawing if you need to, but make sure everything is connected the way it should. 65 | 66 | * Check the configuration loaded in your KMS is what it should be. This can be seen in the first 100 lines of your KMS logs. If it's not, change it and see if the problem is solved. 67 | 68 | * Read the logs, they are normally quite interesting. Sometimes building tools are just not configured correctly or others have reported the same error. Client logs, server logs, build tool logs... For all of those, use Google! 69 | 70 | * Check that you are running the same version of client libraries and KMS. While minor versions are compatible, different major versions aren't. 71 | 72 | [WebRTC test page]: https://test.webrtc.org/ 73 | [STUN/TURN testing]: https://webrtc.github.io/samples/src/content/peerconnection/trickle-ice/ 74 | 75 | 76 | 77 | ### Ok, it's a bug. What now? 78 | 79 | First of all, don't panic! There is still a small work to be done before reporting the bug: 80 | 81 | * If it's an installation issue, don't touch anything! Normally when this happens, we tend to do random things that could only make things worse. 82 | 83 | * Choose a bug header that fits the problem: 84 | 85 | * Bad: "I can't see video. Help!" 86 | 87 | * Bettter: "KMS 6.12.0-dev not showing loopback video, FF40" 88 | 89 | * Best: "KMS 6.12.0-dev, magic-mirror 6.12.0-SNAPSHOT, Mac OSX, FF40: Can't see loopback video" 90 | 91 | * Provide a good description of the problem, with the minimum relevant amount of information to reproduce and diagnose the bug 92 | 93 | * What steps will reproduce the problem? 94 | 95 | * What is the expected output? 96 | 97 | * What happens instead? 98 | 99 | * What are the specific versions of... 100 | 101 | * KMS 102 | 103 | * `kurento-media-server -v` 104 | 105 | * `printf '```\n%s\n```' "$(dpkg -l | egrep -i "kurento|gstreamer|nice")"` 🠘 **Including the backticks!** 106 | 107 | * Service configuration in `/etc/default/kurento-media-server` 108 | 109 | * Config file in `/etc/kurento/kurento.conf.ini` 110 | 111 | * Client libraries. Stating the flavour (NodeJS, JavaScript, Java or homebrewed) is a plus, so we don't have to ask that later. Make sure they match the Major and Minor versions of your KMS modules. 112 | 113 | * Operating System where the client is running. 114 | 115 | * Browser (type and version). If Chrome: 116 | 117 | * `chrome://webrtc-internals` of both sender and receiver, as PDF. 118 | 119 | * `setLocalDescription` line. 120 | 121 | * `setRemoteDescription` line. 122 | 123 | * Stats graphs for `bweforvideo`. 124 | 125 | * Stats graphs for `ssrc_*`. 126 | 127 | * How is the system deployed? Are KMS and client in the same network? Are you using TURN/STUN? 128 | 129 | * What does your pipeline look like? 130 | 131 | * Have you checked the development version? 132 | 133 | * If you can provide a test application, please do so. A pointer to a GitHub repo is very welcome, as it will put us both in the same path. This doesn't mean that we are going to debug your code, as there are many thing in there that are business-logic specific to your application. 134 | 135 | * Provide the logs if they are relevant (i.e. 99% of the time). 136 | 137 | For some specific type of bugs, there is some more information that you can provide: 138 | 139 | * If the bug was recently introduced, finding a regression window can help identify the cause of the bug. 140 | 141 | * If the bug involves a media server crash, providing core dumps will be of great help 142 | 143 | * If you are reporting slowness or high resource consumption, please provide a profile of the system, along with the specs of the machine KMS and clients are running. It's not the same having 20 clients in one Chrome instance, than having them in different instances on different machines. 144 | 145 | * If you are reporting a WebRTC bug, please provide WebRTC internal stats. 146 | 147 | * Chrome: `chrome://webrtc-internals`. 148 | 149 | * Firefox: `about:webrtc`. 150 | 151 | 152 | 153 | ### So, how should a bug report look like? 154 | 155 | * Summary: How would you describe the bug in less than 60 characters? 156 | 157 | * Version: Select the earliest Version with what the problem can be reproduced. 158 | 159 | * OS: On which operating system (OS) did you find it? 160 | 161 | * Description: The details of your problem report, including: 162 | 163 | * Overview. 164 | 165 | * Build Id. 166 | 167 | * Steps to reproduce. 168 | 169 | * Actual results. 170 | 171 | * Expected results. 172 | 173 | 174 | 175 | About Kurento 176 | ============= 177 | 178 | Kurento is an open source software project providing a platform suitable for creating modular applications with advanced real-time communication capabilities. For knowing more about Kurento, please visit the Kurento project website: https://kurento.openvidu.io/. 179 | 180 | Kurento is part of [FIWARE]. For further information on the relationship of FIWARE and Kurento check the [Kurento FIWARE Catalog Entry]. Kurento is also part of the [NUBOMEDIA] research initiative. 181 | 182 | [FIWARE]: http://www.fiware.org 183 | [Kurento FIWARE Catalog Entry]: http://catalogue.fiware.org/enablers/stream-oriented-kurento 184 | [NUBOMEDIA]: http://www.nubomedia.eu 185 | 186 | 187 | 188 | Documentation 189 | ------------- 190 | 191 | The Kurento project provides detailed [documentation] including tutorials, installation and development guides. The [Open API specification], also known as *Kurento Protocol*, is available on [apiary.io]. 192 | 193 | [documentation]: https://kurento.openvidu.io/documentation 194 | [Open API specification]: http://kurento.github.io/doc-kurento/ 195 | [apiary.io]: http://docs.streamoriented.apiary.io/ 196 | 197 | 198 | 199 | Useful Links 200 | ------------ 201 | 202 | Usage: 203 | 204 | * [Installation Guide](https://doc-kurento.readthedocs.io/en/latest/user/installation.html) 205 | * [Compilation Guide](https://doc-kurento.readthedocs.io/en/latest/dev/dev_guide.html#developing-kms) 206 | * [Contribution Guide](https://doc-kurento.readthedocs.io/en/latest/project/contribute.html) 207 | 208 | Issues: 209 | 210 | * [Bug Tracker](https://github.com/Kurento/bugtracker/issues) 211 | * [Support](https://doc-kurento.readthedocs.io/en/latest/user/support.html) 212 | 213 | News: 214 | 215 | * [Kurento Blog](https://kurento.openvidu.io/blog) 216 | * [Google Groups](https://groups.google.com/forum/#!forum/kurento) 217 | 218 | 219 | 220 | Source 221 | ------ 222 | 223 | All source code belonging to the Kurento project can be found in the [Kurento GitHub organization page]. 224 | 225 | [Kurento GitHub organization page]: https://github.com/Kurento 226 | 227 | 228 | 229 | Licensing and distribution 230 | -------------------------- 231 | 232 | Copyright 2018 Kurento 233 | 234 | Licensed under the Apache License, Version 2.0 (the "License"); 235 | you may not use this file except in compliance with the License. 236 | You may obtain a copy of the License at 237 | 238 | http://www.apache.org/licenses/LICENSE-2.0 239 | 240 | Unless required by applicable law or agreed to in writing, software 241 | distributed under the License is distributed on an "AS IS" BASIS, 242 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 243 | See the License for the specific language governing permissions and 244 | limitations under the License. 245 | --------------------------------------------------------------------------------