WIP manual

== Configuration

Default environment configuration is stored in a `portal/config.py` file.

To override the defaults, you should edit a custom configuration file

``portal.local.cfg`` and place it in the project ROOT.

To override the defaults, you should edit the custom configuration file

``portal.local.cfg`` and place it in the project root directory.

== Variables

File is logically split into multiple sections.

Each variable should have some short expectation with example.

The configuration file is split into multiple sections.

Each variable has a short description and an example value.

== Features configuration

In this section there will be some documentation to configure additional features

This section describes how to configure specific portal features.

=== Emails

- To test emails on the `localhost` without mail server you can use

link:https://github.com/mailhog/MailHog[MailHog]

- Best way to use it, is to use the Docker:

- The easiest way to use it is to use the Docker:

[source,bash]

----

docker pull mailhog/mailhog

           -p 8025:8025 \

           mailhog/mailhog

----

- This will create you an MailHog instance, on your `localhost`

- This will create a MailHog instance on your `localhost`

    - Web UI: `http://localhost:8025/`

    - SMTP port: `1025`

    - There is no additional security, no username and password

= Kontr portal installation

There are multiple installation methods

There are several installation methods

== Global prerequisites

== Používateľská príručka _portálu_ systému Kontr 2

=== Prehľad _povolení_ (permissions):

Povolenia sú viazané na roly v kurzoch. Výsledné používateľove práva v kurze

sú maximálnou hodnotou povolení jeho rolí.

==== Zoznam povolení

* archive_projects:

** povoľuje archiváciu projektov v kurze

** typicky vhodná pre vlastníka kurzu

** zatiaľ nevyužitá hodnota (archivácia projektov nie je implementovaná)

* assign_roles:

** povoľuje manipuláciu so zoznamami používateľov v rolách kurzu

** nepovoľuje iné zmeny rolí

* create_submissions:

** povoľuje vytváranie odovzdaní pod vlastnou identitou s ohľadom na časové obmedzenia projektov (submissions allowed from-to)

** typické povolenie pre študenta

* evaluate_submissions:

** umožňuje vytváranie hodnotení pre odovzdania v kurze

** typické povolenie pre vyučujúcich a cvičiacich

** predpokladané využitie spolu s povolením read_submissions_X: používateľ smie hodnotiť len odovzdania, ku ktorým má prístup

** zatiaľ nevyužitá hodnota (zadávanie hodnotenia nie je implementované)

* handle_notes_access_token:

** umožňuje manipuláciu (CRUD) s prístupovým kľúčom ku IS API kurzu (poznámkové bloky)

** zatiaľ nevyužitá hodnota (portál nekomunikuje s IS API)

** typické povolenie vlastníka kurzu

* read_all_submission_files:

** povoľuje prístup ku všetkým súborom prístupných odovzdaní

*** testovacie súbory

*** učiteľské výsledky odovzdaní (plný výstup testov)

** typické povolenie vyučujúceho

** zatiaľ nevyužitá hodnota (portál neumožňuje zobrazovanie súborov odovzdaní)

* read_submissions_all:

** používateľ má prístup na čítanie ku všetkým odovzdaniam v kurze

* read_submissions_groups:

** používateľ má prístup na čítanie ku všetkým odovzdaniam používateľov v skupinách, ktorých je členom

** typicky vedúci seminárnej skupiny

* read_submissions_own:

** používateľ má prístup na čítanie ku svojim odovzdaniam

** typické povolenie študenta

* resubmit_submissions:

** používateľ smie znovu odovzdať existujúce odovzdanie pod identitou pôvodného vlastníka

** neobmedzené časovými obmedzeniami projektu (submissions allowed from-to)

** typické povolenie vlastníka kurzu

** TODO: nevyužité?

* update_course:

** umožňuje zmenu informácii kurzu (meno, kód)

** umožňuje vytváranie, mazanie a úpravu rolí, skupín a projektov

** typické povolenie vlastníka kurzu

* view_course_full:

** používateľ má plný prístup k informáciám o kurze

*** aj skupiny, roly a projekty

** typické povolenie vyučujúceho

* view_course_limited:

** povoľuje obmedzené množstvo informácii o kurze

*** používateľ má prístup iba k rolám a skupinám, do ktorých patria

*** používateľ vidí iba aktívne projekty, ktoré sú priradené aspoň k jednej jeho skupine

* write_groups:

** povoľuje úpravu existujúcich skupín v kurze (členovia, meno skupiny) TODO: projekty?

* write_projects:

** povoľuje úpravu existujúcich projektov v kurze (meno, konfigurácia) TODO: prepojenie na skupiny?

* write_reviews_all: TODO: mazanie komentárov?

** umožňuje vytváranie, zmenu a mazanie komentárov všetkých odovzdaní v kurze

** zatiaľ využité iba v backende, frontend neumožňuje vytváranie komentárov

* write_reviews_group:

** umožňuje používateľovi vytváranie, zmenu a mazanie komentárov odovzdaní používateľov v skupinách, ktorých je členom

** typické povolenie vedúceho seminárnej skupiny

** zatiaľ využité iba v backende, frontend neumožňuje vytváranie komentárov

* write_reviews_own:

** umožňuje používateľovi vytváranie, zmenu a mazanie komentárov k vlastným odovzdaniam

** typické povolenie študenta

** zatiaľ využité iba v backende, frontend neumožňuje vytváranie komentárov

* write_roles:

** povoľuje úpravu existujúcich rolí v kurze (členovia, meno roly, popis)

=== Ukážka nastavenia kurzu

=== Prehľad rozhrania backendu

=== Popis nasadenia

=== Dostupné CLI príkazy

 No newline at end of file