Skip to content

Commit 9d07b72

Browse files
committed
Add recommendation for the minimum python version
1 parent 98bd13c commit 9d07b72

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

docs/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ macOS (OS X) development environment.
4545

4646
## Web-based report storage
4747
* **You can store & visualize thousands of analysis reports** of many analyzers like
48-
Clang Static Analyzer (C/C++), Clang Tidy (C/C++), Facebook Infer (C/C++, Java), Clang Sanitizers (C/C++), Spotbugs (Java), Pylint (Python), Eslint (Javascript) ...
48+
Clang Static Analyzer (C/C++), Clang Tidy (C/C++), Facebook Infer (C/C++, Java), Clang Sanitizers (C/C++), Spotbugs (Java), Pylint (Python), Eslint (Javascript) ...
4949
For a complete list see [Supported Analyzers](supported_code_analyzers.md)
5050
* **Web application** for viewing discovered code defects with a streamlined,
5151
easy experience (with PostgreSQL, or SQLite backend).
@@ -145,7 +145,7 @@ For more information how to use CodeChecker see our [user guide](usage.md).
145145
* [Webserver User Guide](web/user_guide.md)
146146
* [WEB GUI User Guide](/web/server/vue-cli/src/assets/userguide/userguide.md)
147147
* [Command line and WEB UI Feature overview](feature_comparison.md)
148-
* Security configuration
148+
* Security configuration
149149
* [Configuring Authentication](web/authentication.md)
150150
* [Configuring Authorization](web/permissions.md)
151151
* Deployment
@@ -189,8 +189,8 @@ The following tools are supported:
189189
| | [Sphinx](/docs/tools/report-converter.md#sphinx) |
190190

191191

192-
For details see
193-
[supported code analyzers](supported_code_analyzers.md) documentation and the
192+
For details see
193+
[supported code analyzers](supported_code_analyzers.md) documentation and the
194194
[Report Converter Tool](/docs/tools/report-converter.md).
195195

196196
## Common Tools
@@ -292,6 +292,10 @@ set the `BUILD_UI_DIST` environment variable to `NO` before the package build:
292292
- Use `make standalone_package` instead of `make package` to avoid
293293
having to manually activate the environment before running CodeChecker.
294294

295+
### Minimum Recommended package versions
296+
297+
* In production it is recommended to execute CodeChecker with the minimum Python versions: 3.7.14, 3.8.14, 3.9.14, 3.10.6, 3.11.0, otherwise it may be vulnerable to open-redirect attacks. For more info see https://python-security.readthedocs.io/vuln/http-server-redirection.html (CVE-2021-28861).
298+
295299
### Upgrading environment after system or Python upgrade
296300

297301
If you have upgraded your system's Python to a newer version (e.g., from
@@ -371,16 +375,16 @@ Analyze your project with the `check` command:
371375
CodeChecker check -b "cd ~/your-project && make clean && make" -o ./results
372376

373377
`check` will print an overview of the issues found in your project by the
374-
analyzers. The reports will be stored in the `./results` directory in `plist`
378+
analyzers. The reports will be stored in the `./results` directory in `plist`
375379
XML format.
376380

377381
## Export the reports as static HTML files
378382
You can visualize the results as static HTML by executing
379383

380384
`CodeChecker parse -e html ./results -o ./reports_html`
381385

382-
An index page will be generated with a list of all repors in
383-
`./reports_html/index.html`
386+
An index page will be generated with a list of all repors in
387+
`./reports_html/index.html`
384388

385389

386390
## Optionally store the results in Web server & view the results

0 commit comments

Comments
 (0)