user-docs issueshttps://gitlab.nic.cz/turris/user-docs/-/issues2022-11-07T14:17:08+01:00https://gitlab.nic.cz/turris/user-docs/-/issues/165Rainbow and LEDs signaling2022-11-07T14:17:08+01:00Karel KociRainbow and LEDs signaling* [ ] documentation for `rainbow` command line tool and its configuration (in the future hopefully about reForis plugin as well)
* [ ] documentation about LEDs signaling for every board
Note that boards use LEDS to signal boot process a...* [ ] documentation for `rainbow` command line tool and its configuration (in the future hopefully about reForis plugin as well)
* [ ] documentation about LEDs signaling for every board
Note that boards use LEDS to signal boot process as well as hardware failures. With turris/os/packages!846 we also plan to signal running update and notifications.https://gitlab.nic.cz/turris/user-docs/-/issues/164Link to admonition documentation is invalid2023-08-29T11:10:34+02:00Lukas JelinekLink to admonition documentation is invalidIn the `README.md` file, the link to the admonition documentation is invalid. The linked page returns _404 Not Found_. The link should be fixed.In the `README.md` file, the link to the admonition documentation is invalid. The linked page returns _404 Not Found_. The link should be fixed.Lukas JelinekLukas Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/163Document schnapps savepoint/commit2024-03-12T16:04:56+01:00Lukas JelinekDocument schnapps savepoint/commitImprove the schnapps documentation - add the `schnapps savepoint` and `schnapps commit` commands.
The documentation should mention that these commands are experimental and may be changed at any time.Improve the schnapps documentation - add the `schnapps savepoint` and `schnapps commit` commands.
The documentation should mention that these commands are experimental and may be changed at any time.https://gitlab.nic.cz/turris/user-docs/-/issues/162There is no mention in our documentation, that we use Knot2021-10-26T17:31:11+02:00Stepan RechnerThere is no mention in our documentation, that we use KnotWe use Knot resolver in Turris OS instead of the OpenWrt default dnsmasq. This way, a set-up made in LuCI may not be actually applied and conflicts may occur.
What should be documented:
* this fact,
* which configuration files and optio...We use Knot resolver in Turris OS instead of the OpenWrt default dnsmasq. This way, a set-up made in LuCI may not be actually applied and conflicts may occur.
What should be documented:
* this fact,
* which configuration files and options were added in addition to the OpenWrt ones,
* how to set Knot resolver up.
~~For some users may be helpful:~~
* ~~How to switch back to the OpenWrt default configuration.~~Lukas JelinekLukas Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/161Link(s) to versions in changelog recognized as incorrect2022-03-17T17:34:16+01:00Lukas JelinekLink(s) to versions in changelog recognized as incorrectThe remote link checker recognizes links to Turris OS versions in the changelog as incorrect. This is because these links are build in JavaScript and the file itself contains only a template for these links.
We should modify the checker...The remote link checker recognizes links to Turris OS versions in the changelog as incorrect. This is because these links are build in JavaScript and the file itself contains only a template for these links.
We should modify the checker and/or the changelog to drop this false positive warning.https://gitlab.nic.cz/turris/user-docs/-/issues/160Re-flashing Shield needs a different medkit2021-10-19T14:58:17+02:00Stepan RechnerRe-flashing Shield needs a different medkitThere is a short info about [rescue modes of Turris Shield](https://docs.turris.cz/hw/shield/rescue-modes/) with a link to a MOX rescue modes article. A few little differences are mentioned, but a link to the specific medkit should be av...There is a short info about [rescue modes of Turris Shield](https://docs.turris.cz/hw/shield/rescue-modes/) with a link to a MOX rescue modes article. A few little differences are mentioned, but a link to the specific medkit should be available too ([mox-medkit-contract-shield-latest.tar.gz](https://repo.turris.cz/hbs/medkit/mox-medkit-contract-shield-latest.tar.gz))Lukas JelinekLukas Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/159Contribution guide states that it is possible to do forks on our Gitlab but t...2021-08-17T16:04:20+02:00Karel KociContribution guide states that it is possible to do forks on our Gitlab but that is not trueMost of the users (unless they get special rights) do not have rights to fork on our Gitlab thus we should not advertise this. At a minimum, we should state that this is available only on request after some contributions.Most of the users (unless they get special rights) do not have rights to fork on our Gitlab thus we should not advertise this. At a minimum, we should state that this is available only on request after some contributions.Lukas JelinekLukas Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/158Add warning to the PaKon documentation, that external storage is recommended2023-08-29T11:10:43+02:00Stepan RechnerAdd warning to the PaKon documentation, that external storage is recommendedIt may happen, that PaKon causes filled-up internal storage. There is such a label in the reForis Packages page, but nothing like that in Foris. I think it should be clearer in the documentation.It may happen, that PaKon causes filled-up internal storage. There is such a label in the reForis Packages page, but nothing like that in Foris. I think it should be clearer in the documentation.Lukas JelinekLukas Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/157HaaS token via reForis2023-08-29T11:10:37+02:00Stepan RechnerHaaS token via reForisIn the [documentation](https://docs.turris.cz/basics/collect/setup/#how-to-set-up-data-collection) there is a how-to on inserting the HaaS token via SSH. It is now possible via reForis though, so we should update it in the documentation ...In the [documentation](https://docs.turris.cz/basics/collect/setup/#how-to-set-up-data-collection) there is a how-to on inserting the HaaS token via SSH. It is now possible via reForis though, so we should update it in the documentation too.
![image](/uploads/20247011d947b0df74da3e4336400ac9/image.png)Lukas JelinekLukas Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/156Document ethernet cage leds behaviour for all our boards2021-06-28T09:25:46+02:00Karel KociDocument ethernet cage leds behaviour for all our boardsThis should add a table with status indication LEDs explanation.
* On 1.x we have non-standard behavior so we should describe it for sure
* Omnia has no ethernet cage LEDs and it should be noted that front leds are used instead (blinkin...This should add a table with status indication LEDs explanation.
* On 1.x we have non-standard behavior so we should describe it for sure
* Omnia has no ethernet cage LEDs and it should be noted that front leds are used instead (blinking on activity and light on link up, there is no standard way to indicate speed)
* Mox behavior is being discussed in turris/os/build#272https://gitlab.nic.cz/turris/user-docs/-/issues/154FAQ: Packages are missing or conflict new/existing file2021-10-15T13:23:22+02:00Josef SchlehoferFAQ: Packages are missing or conflict new/existing fileUsers are sometimes confused what to do if they receive some kind of notification:
```
inconsistent: Requested package python3-tornado that is not available.
```
It would be good, if we have some page tips&tricks or faq or updater page,...Users are sometimes confused what to do if they receive some kind of notification:
```
inconsistent: Requested package python3-tornado that is not available.
```
It would be good, if we have some page tips&tricks or faq or updater page, when we are going to tell why it happened (just basics), but most important that they need to remove it themselves, if they installed the package.
Because Update can not proceed otherwise. It could be good that we also say that it it nice to have email notifications enabled.
Then, we need to also something regarding collisions like this
```
• /usr/sbin/openvpn: openvpn-openssl (new-file), openvpn-mbedtls (existing-file)
```
In most cases, it is OK to remove one of the packages which it wants to install.
Could be connected to https://gitlab.nic.cz/turris/user-docs/-/issues/24https://gitlab.nic.cz/turris/user-docs/-/issues/153Add Errata how you can update your router from 4.0-beta (factory)2021-07-28T14:45:41+02:00Josef SchlehoferAdd Errata how you can update your router from 4.0-beta (factory)It would be nice, if we can document in our documentation in FAQ or in Erratum that once users unbox their router and plug them to the Internet, then they should not check any package lists before they are updated to the latest version.
...It would be nice, if we can document in our documentation in FAQ or in Erratum that once users unbox their router and plug them to the Internet, then they should not check any package lists before they are updated to the latest version.
This will prevent threads on our forum like this:
- https://forum.turris.cz/t/aktualizace-mox-4-0-beta/15581/3
- https://forum.turris.cz/t/runtime-string-requests-string-utils-uri-download-failed-the-requested-url-returned-error-404-not-found/14465?u=pepe
Related to https://gitlab.nic.cz/turris/os/build/-/issues/192#note_176493https://gitlab.nic.cz/turris/user-docs/-/issues/152Sentinel: rethink naming hierarchy2021-11-03T10:44:37+01:00Martin PrudekSentinel: rethink naming hierarchy*Note: the main goal is to get rid of `data collection` term*
Currently there is not strict hierarchy in Sentinel components naming from the users point of view. A different version of naming hierarchy is used in the [docs](https://docs...*Note: the main goal is to get rid of `data collection` term*
Currently there is not strict hierarchy in Sentinel components naming from the users point of view. A different version of naming hierarchy is used in the [docs](https://docs.turris.cz/basics/collect/collect/#data-collection) and in reForis:
![image](/uploads/f42b550d10100daa2944d00e02a110c0/image.png) ![image](/uploads/95849ceb2221ff8bc1b4ca3322780e24/image.png)
We should unify this and use the same convention wherever possible.
Unfortunately, there is not a simple guideline how to do that. Sentinel-related toolchain consists (from the docs/settings/user point of view) at least of these parts:
- Sentinel threat detecting collectors (minipot, fwlogs)
- Non-sentinel threat detecting collectors (HaaS client)
- Other data collectors where Sentinel is involved: (turris/sentinel/turris-survey>, sentinel status)
- Non collectors: dynfw client
### Option 1 (technology first)
Probably the best solution would be to ignore the fact that HaaS client is not a direct member of Sentinel family and it's activation involves visiting haas.nic.cz
- Sentinel
- EULA
- threat detectors (minipot, fwlogs, haas)
- dynfw
- usage statistics (survey)
The bad thing is that Sentinel is depicted here not as a security-only project and involves also *survey*.
### Option 2 (purpose first)
Since Sentinel is mainly a technology, it may be ignored. Security, including threat detectors and dynamic firewall should be strictly separated from usage statistics.
- Intrusion prevention
- EULA
- threat detectors (including haas)
- dynfw
- Usage statistics
### Option 3
As survey is only a side-effect of Sentinel technology, we may pretend it's not even part of it:
- Sentinel
- EULA
- thread detectors (with HaaS)
- dynfw
- Usage statistics
### Option 4 (conservative)
This option is based on what has been already agreed and is used in reForis. Basically it renames `Data collection` to `Threat detectors`. Survey is still in this section although it's not a threat detector.
- Sentinel
- EULA
- thread detectors
- dynfw
- HaaShttps://gitlab.nic.cz/turris/user-docs/-/issues/151Do not flatten lists in changelog2021-10-19T14:58:34+02:00Vojtech MyslivecDo not flatten lists in changelogThere is an error in parsing the changelog. There is a multi-level list in the changelog ([NEWS](https://gitlab.nic.cz/turris/os/build/-/blob/v5.2.0/NEWS#L4)) often and it is wrongly flatten in the docs
![Screenshot_from_2021-06-09_14-0...There is an error in parsing the changelog. There is a multi-level list in the changelog ([NEWS](https://gitlab.nic.cz/turris/os/build/-/blob/v5.2.0/NEWS#L4)) often and it is wrongly flatten in the docs
![Screenshot_from_2021-06-09_14-09-50](/uploads/10ee3ef6fff45e22310cd26a633253f9/Screenshot_from_2021-06-09_14-09-50.png)
![Screenshot_from_2021-06-09_14-09-57](/uploads/3edf967564ddee256db22b7a9ebd8d27/Screenshot_from_2021-06-09_14-09-57.png)Aleksandr GumroianAleksandr Gumroianhttps://gitlab.nic.cz/turris/user-docs/-/issues/150Add information about checking RAID health2021-06-08T18:52:20+02:00Lukas JelinekAdd information about checking RAID healthOriginally from this support ticket: https://tracker.nic.cz/Ticket/Display.html?id=1334688
The documentation page about the reForis storage plugin should contain information how to check RAID disks health.Originally from this support ticket: https://tracker.nic.cz/Ticket/Display.html?id=1334688
The documentation page about the reForis storage plugin should contain information how to check RAID disks health.https://gitlab.nic.cz/turris/user-docs/-/issues/148Describe way how it is possible to verify medkit signature2021-09-21T16:07:26+02:00Josef SchlehoferDescribe way how it is possible to verify medkit signatureIn documentation, we have described how we can verify checksum for medkit, but we need to provide way to geeks how they can verify medkit's signature by using ``signify`` tool.In documentation, we have described how we can verify checksum for medkit, but we need to provide way to geeks how they can verify medkit's signature by using ``signify`` tool.https://gitlab.nic.cz/turris/user-docs/-/issues/147Add how to report Unknown API error in reForis2024-03-27T13:02:58+01:00Josef SchlehoferAdd how to report Unknown API error in reForisWe need to have article, where we will explain which steps are required to have stack trace from foris-controller, so we can fix this like, where to find web developer console in browser, how to get the stack trace and so on.
On our for...We need to have article, where we will explain which steps are required to have stack trace from foris-controller, so we can fix this like, where to find web developer console in browser, how to get the stack trace and so on.
On our forum, I wrote it several times, so at least there is some idea.Aleksandr GumroianAleksandr Gumroianhttps://gitlab.nic.cz/turris/user-docs/-/issues/146Add section about updater download error to common-errors2021-06-22T12:23:12+02:00Jan PavlinecAdd section about updater download error to common-errorsThis could help lower the number of complaints from users (forum and/or support). We could also refer them to this page.
Related issues:
- https://gitlab.nic.cz/turris/updater/supervisor/-/issues/24
- https://gitlab.nic.cz/turris/update...This could help lower the number of complaints from users (forum and/or support). We could also refer them to this page.
Related issues:
- https://gitlab.nic.cz/turris/updater/supervisor/-/issues/24
- https://gitlab.nic.cz/turris/updater/supervisor/-/issues/15https://gitlab.nic.cz/turris/user-docs/-/issues/145Document DVB tuner(s)2021-05-31T13:36:53+02:00Josef SchlehoferDocument DVB tuner(s)Because DVB tuners are for now feature which we was prepared by our ex-colleagues, we should document it in our documentation and describe what needs to be done when the DVB tuner is not supported and so on.
Exactly like it was done in ...Because DVB tuners are for now feature which we was prepared by our ex-colleagues, we should document it in our documentation and describe what needs to be done when the DVB tuner is not supported and so on.
Exactly like it was done in wiki:
https://docs.turris.cz/basics/apps/atlas/https://gitlab.nic.cz/turris/user-docs/-/issues/144By switching to newer major version of Turris OS - project.turris.cz is not c...2021-10-19T14:58:29+02:00Josef SchlehoferBy switching to newer major version of Turris OS - project.turris.cz is not compatibleOn support, I see there were multiple responds about it and that people are trying to find registration code for our old data collection system to use it on project.turris.cz, but in fact, this is not necessary and they can be part of ne...On support, I see there were multiple responds about it and that people are trying to find registration code for our old data collection system to use it on project.turris.cz, but in fact, this is not necessary and they can be part of new device threat detection, but selecting and installing it from package list.
This is mostly related from migration from Turris OS 3.x to Turris OS 5.x.Lukas JelinekLukas Jelinek