Files
@ 6f9970a36190
Branch filter:
Location: kallithea/docs/usage/troubleshooting.rst - annotation
6f9970a36190
2.2 KiB
text/prs.fallenstein.rst
auth_ldap: fix interpretation of LDAP attributes in Python 3
The python-ldap module returns the LDAP attribute names as strings, and the
attribute values as arrays of bytes, e.g. for email:
'mail': [b'john.doe@example.com'],
See https://www.python-ldap.org/en/latest/bytes_mode.html, particularly:
https://www.python-ldap.org/en/latest/bytes_mode.html#what-s-text-and-what-s-bytes
Due to a missing conversion from bytes to unicode for the attribute values
obtained from LDAP, storing the values in a unicode field in the database would
fail. It would apparently either store a repr of the bytes or store them in
some other way.
Upon user login, SQLAlchemy warned about this:
.../sqlalchemy/sql/sqltypes.py:269: SAWarning: Unicode type received non-unicode bind param value b'John'. (this warning may be suppressed after 10 occurrences)
.../sqlalchemy/sql/sqltypes.py:269: SAWarning: Unicode type received non-unicode bind param value b'Doe'. (this warning may be suppressed after 10 occurrences)
In PostgreSQL, this would result in 'weird' values for first name, last
name, and email fields, both in the database and the web UI, e.g.
firstname: \x4a6f686e
lastname: \x446f65
email: \x6a6f686e406578616d706c652e636f6d
These values represent the actual values in hexadecimal, e.g.
\x4a6f686e = 0x4a 0x6f 0x68 0x6e = J o h n
In SQLite, the problem initially shows differently, as an exception in
gravatar_url():
File "_base_root_html", line 207, in render_body
File "_index_html", line 78, in render_header_menu
File "_base_base_html", line 479, in render_menu
File ".../kallithea/lib/helpers.py", line 908, in gravatar_div
gravatar(email_address, cls=cls, size=size)))
File ".../kallithea/lib/helpers.py", line 923, in gravatar
src = gravatar_url(email_address, size * 2)
File ".../kallithea/lib/helpers.py", line 956, in gravatar_url
.replace('{email}', email_address) \
TypeError: replace() argument 2 must be str, not bytes
but nevertheless the root cause of the problem is the same.
Fix the problem by converting the LDAP attributes from bytes to strings.
The python-ldap module returns the LDAP attribute names as strings, and the
attribute values as arrays of bytes, e.g. for email:
'mail': [b'john.doe@example.com'],
See https://www.python-ldap.org/en/latest/bytes_mode.html, particularly:
https://www.python-ldap.org/en/latest/bytes_mode.html#what-s-text-and-what-s-bytes
Due to a missing conversion from bytes to unicode for the attribute values
obtained from LDAP, storing the values in a unicode field in the database would
fail. It would apparently either store a repr of the bytes or store them in
some other way.
Upon user login, SQLAlchemy warned about this:
.../sqlalchemy/sql/sqltypes.py:269: SAWarning: Unicode type received non-unicode bind param value b'John'. (this warning may be suppressed after 10 occurrences)
.../sqlalchemy/sql/sqltypes.py:269: SAWarning: Unicode type received non-unicode bind param value b'Doe'. (this warning may be suppressed after 10 occurrences)
In PostgreSQL, this would result in 'weird' values for first name, last
name, and email fields, both in the database and the web UI, e.g.
firstname: \x4a6f686e
lastname: \x446f65
email: \x6a6f686e406578616d706c652e636f6d
These values represent the actual values in hexadecimal, e.g.
\x4a6f686e = 0x4a 0x6f 0x68 0x6e = J o h n
In SQLite, the problem initially shows differently, as an exception in
gravatar_url():
File "_base_root_html", line 207, in render_body
File "_index_html", line 78, in render_header_menu
File "_base_base_html", line 479, in render_menu
File ".../kallithea/lib/helpers.py", line 908, in gravatar_div
gravatar(email_address, cls=cls, size=size)))
File ".../kallithea/lib/helpers.py", line 923, in gravatar
src = gravatar_url(email_address, size * 2)
File ".../kallithea/lib/helpers.py", line 956, in gravatar_url
.replace('{email}', email_address) \
TypeError: replace() argument 2 must be str, not bytes
but nevertheless the root cause of the problem is the same.
Fix the problem by converting the LDAP attributes from bytes to strings.
aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 4e6dfdb3fa01 8b8edfc25856 aa90719e8520 01aca0a4f876 8b8edfc25856 8b8edfc25856 aa90719e8520 aa90719e8520 4e6dfdb3fa01 4e6dfdb3fa01 aa90719e8520 aa90719e8520 8b8edfc25856 aa90719e8520 4e6dfdb3fa01 4e6dfdb3fa01 8b8edfc25856 8b8edfc25856 aa90719e8520 aa90719e8520 4e6dfdb3fa01 4e6dfdb3fa01 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 4e6dfdb3fa01 aa90719e8520 aa90719e8520 aa90719e8520 aa90719e8520 4e6dfdb3fa01 4e6dfdb3fa01 aa90719e8520 aa90719e8520 aa90719e8520 03bbd33bc084 4e6dfdb3fa01 4e6dfdb3fa01 4e6dfdb3fa01 4e6dfdb3fa01 4e6dfdb3fa01 4e6dfdb3fa01 aa90719e8520 aa90719e8520 aa90719e8520 03bbd33bc084 03bbd33bc084 aa90719e8520 af2059eead28 af2059eead28 af2059eead28 03bbd33bc084 4a99684543f7 4a99684543f7 4a99684543f7 4a99684543f7 84d2a9aaa1a4 4e6dfdb3fa01 4a99684543f7 af2059eead28 aa90719e8520 cc21a2b86a30 aa90719e8520 aa90719e8520 aa90719e8520 | .. _troubleshooting:
===============
Troubleshooting
===============
:Q: **Missing static files?**
:A: Make sure either to set the ``static_files = true`` in the .ini file or
double check the root path for your http setup. It should point to
for example:
``/home/my-virtual-python/lib/python3.7/site-packages/kallithea/public``
|
:Q: **Can't install celery/rabbitmq?**
:A: Don't worry. Kallithea works without them, too. No extra setup is required.
Try out the great Celery docs for further help.
|
:Q: **Long lasting push timeouts?**
:A: Make sure you set a longer timeout in your proxy/fcgi settings. Timeouts
are caused by the http server and not Kallithea.
|
:Q: **Large pushes timeouts?**
:A: Make sure you set a proper ``max_body_size`` for the http server. Very often
Apache, Nginx, or other http servers kill the connection due to to large
body.
|
:Q: **Apache doesn't pass basicAuth on pull/push?**
:A: Make sure you added ``WSGIPassAuthorization true``.
|
:Q: **Git fails on push/pull?**
:A: Make sure you're using a WSGI http server that can handle chunked encoding
such as ``waitress`` or ``gunicorn``.
|
:Q: **How can I use hooks in Kallithea?**
:A: It's easy if they are Python hooks: just use advanced link in
hooks section in Admin panel, that works only for Mercurial. If
you want to use Git hooks, just install th proper one in the repository,
e.g., create a file `/gitrepo/hooks/pre-receive`. You can also use
Kallithea-extensions to connect to callback hooks, for both Git
and Mercurial.
|
:Q: **Kallithea is slow for me, how can I make it faster?**
:A: See the :ref:`performance` section.
|
:Q: **UnicodeDecodeError on Apache mod_wsgi**
:A: Please read: https://docs.djangoproject.com/en/dev/howto/deployment/wsgi/modwsgi/#if-you-get-a-unicodeencodeerror.
|
:Q: **Requests hanging on Windows**
:A: Please try out with disabled Antivirus software, there are some known problems with Eset Antivirus. Make sure
you have installed the latest Windows patches (especially KB2789397).
.. _python: http://www.python.org/
.. _mercurial: https://www.mercurial-scm.org/
.. _celery: http://celeryproject.org/
.. _rabbitmq: http://www.rabbitmq.com/
.. _python-ldap: http://www.python-ldap.org/
|