Skip to content

Commit

Permalink
update doc on using old_rtc_authentication
Browse files Browse the repository at this point in the history
  • Loading branch information
dixudx committed Mar 29, 2023
1 parent 8acff28 commit babe37e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
5 changes: 2 additions & 3 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,10 @@ This library can help you:
Python & Rational Team Concert Versions
---------------------------------------

This project has been tested against multiple Python versions, such as 2.7, 3.5, 3.6, 3.7, 3.8 and 3.9.
This project has been tested against multiple Python versions, such as "3.7", "3.8", "3.9", "3.10" and "3.11".

Currently the newest release of **rtcclient** is **0.7.0**, which works well with ``Rational Team Concert`` 6.0.6.1 and ``ELM`` 7.0.
Please install **rtcclient** with version >= 0.9.0, which works well with ``Rational Team Concert`` 6.0.6.1, **5.0.1**, **5.0.2** and ``ELM`` 7.0.

For ``Rational Team Concert`` with version **5.0.1**, **5.0.2**, it is suggested to install **rtcclient** with version **0.6.0**.

Important Links
---------------
Expand Down
6 changes: 5 additions & 1 deletion doc/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,15 @@ RTC Server. For this example,
>>> url = "https://your_domain:9443/jazz"
>>> username = "your_username"
>>> password = "your_password"
>>> myclient = RTCClient(url, username, password)
>>> myclient = RTCClient(url, username, password, ends_with_jazz=True, old_rtc_authentication=False)

If your url ends with **ccm**, set `ends_with_jazz` to `False`,
refer to **issue #68** for detailed explanation.

If your rtc server is behind a proxy, remember to set "proxies" explicitly.

If your rtc server is too old (such as Rational Team Concert 5.0.1, 5.0.2), please set `old_rtc_authentication` to `True`.

About Proxies
-------------

Expand Down

0 comments on commit babe37e

Please sign in to comment.