Skip to content

Commit

Permalink
User login doc
Browse files Browse the repository at this point in the history
Made login to actually redirect to specified next address.
  • Loading branch information
zgoda committed Aug 15, 2020
1 parent a76a378 commit 7a97daf
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 6 deletions.
Binary file added docs/_static/login_confirmed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/login_link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/login_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/user_menu_section.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions docs/adminguide.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
Dokumentacja administratora
===========================

Jako "administratora systemu" rozumiemy osobę odpowiedzialną za instalację, uruchomienie i utrzymanie serwisu Biuletynu w stanie sprawnym i działającym. Zakładamy że instalacja i uruchmienie aplikacji zostaną wykonane w systemie Linux. Dla mniej wprawnych użytkowników proponujemy wykonanie próbnej instalacji na maszynie wirtualnej Debiana 10 uruchomionej pod Virtualbox albo VMWare. Ogólnie instalacja **nie wymaga** niczego poza instalowaniem pakietów systemowych, instalowaniem pakietów bibliotek Pythona w środowisku wirtualnym oraz edytowania plików tekstowych z konfiguracją serwisów takich jak serwer aplikacji czy WWW.
Jako "administratora systemu" rozumiem osobę odpowiedzialną za instalację, uruchomienie i utrzymanie serwisu Biuletynu w stanie sprawnym i działającym. Zakładam że instalacja i uruchmienie aplikacji zostaną wykonane w systemie Linux. Dla mniej wprawnych użytkowników proponuję wykonanie próbnej instalacji na maszynie wirtualnej Debiana 10 uruchomionej pod Virtualbox albo VMWare. Ogólnie instalacja **nie wymaga** niczego poza instalowaniem pakietów systemowych, instalowaniem pakietów bibliotek Pythona w środowisku wirtualnym oraz edytowania plików tekstowych z konfiguracją serwisów takich jak serwer aplikacji czy WWW.

Usługi dodatkowe
----------------

Integracja z usługą zdalnego logowania Sentry
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Aplikacja BIP może być opcjonalnie zintegrowana z usługą zdalnego logowania błędów Sentry. Do zintegrowania aplikacji z Sentry konieczne jest dostarczenie poprzez zmienną środowiskową parametrów połączenia do serwera Sentry. Poniższy przykład pokazuje jak to zrobić przy użyciu pliku ze zmiennymi środowiskowymi używanego przez ``systemd`` w definicji usługi aplikacji. W pliku tym należy umieścić poniższą linię, zastępując ``klucz``, ``konto`` i ``projekt`` odpowiednimi wartościami z panelu administracji projektu.
Aplikacja BIP może być opcjonalnie zintegrowana z usługą zdalnego logowania błędów `Sentry <https://sentry.io/welcome/>`_. Do zintegrowania aplikacji z Sentry konieczne jest dostarczenie poprzez zmienną środowiskową parametrów połączenia do serwera Sentry. Poniższy przykład pokazuje jak to zrobić przy użyciu pliku ze zmiennymi środowiskowymi używanego przez ``systemd`` w definicji usługi aplikacji. W pliku tym należy umieścić poniższą linię, zastępując ``klucz``, ``konto`` i ``projekt`` odpowiednimi wartościami z panelu administracji projektu.

.. code-block:: shell
Expand All @@ -20,3 +20,5 @@ Zawartość tej zmiennej można znaleźć w ustawieniach projektu na stronie adm
.. image:: /_static/sentry_config.png

Usługa Sentry przesyła na bieżąco informacje o napotkanych nieprawidłowościach w działaniu aplikacji, które nie zostały obsłużone w jej kodzie.

Integracja działa zarówno z wersją darmową, jak i płatną.
20 changes: 19 additions & 1 deletion docs/userguide.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,22 @@
Przewodnik użytkownika
======================

Jako "użytkownika serwisu" rozumiemy redaktora Biuletynu, który będzie tworzył i modyfikował zawartość.
Jako "użytkownika serwisu" rozumiemy redaktora Biuletynu, który będzie tworzył i modyfikował zawartość. Ta część podręcznika opisuje wykonywanie w serwisie BIP czynności redakcyjnych, tj. dodawania i modyfikowania treści.

Logowanie do konta
------------------

Odnośnik do strony logowania znajduje się z prawej strony, w sekcji "Konto redaktora" menu bocznego aplikacji. Jest on widoczny tylko wtedy, gdy użytkownik nie jest zalogowany - po zalogowaniu znika.

.. image:: /_static/login_link.png

Odnośnik ten prowadzi do strony logowania, na której trzeba podać nazwę użytkownika oraz hasło.

.. image:: /_static/login_page.png

Po podaniu prawidłowych danych użytkownik zostanie przeniesiony z powrotem do ostatnio otwartej strony, a u góry strony pojawi się winieta informująca o pomyślnym logowaniu.

.. image:: /_static/login_confirmed.png

Zarządzanie danymi użytkownika
------------------------------
2 changes: 1 addition & 1 deletion src/bip/__version__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = '0.7.0'
__version__ = '0.7.1'


def get_version():
Expand Down
2 changes: 1 addition & 1 deletion src/bip/auth/templates/auth/login.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@

{% block content %}
<h1>Logowanie redaktora BIP</h1>
{{ render_form(form, url_for('auth.login')) }}
{{ render_form(form, request.full_path) }}
{% endblock %}
2 changes: 1 addition & 1 deletion src/bip/templates/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ <h6>Konto redaktora</h6>
<li class="nav-item"><a class="nav-link" href="{{ item.url }}">{{ item.title }}</a></li>
{% endfor %}
{% else %}
<li class="nav-item"><a class="nav-link" href="{{ url_for('auth.login') }}">zaloguj</a></li>
<li class="nav-item"><a class="nav-link" href="{{ url_for('auth.login') }}?next={{request.path}}">zaloguj</a></li>
{% endif %}
</ul>
{% if current_user.is_authenticated and current_user.admin %}
Expand Down

0 comments on commit 7a97daf

Please sign in to comment.