user-docs issueshttps://gitlab.nic.cz/turris/user-docs/-/issues2021-09-21T16:07:26+02:00https://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 Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/143Make it more clear where users can found the serial number2021-09-22T11:37:27+02:00Josef SchlehoferMake it more clear where users can found the serial numberFor the RMA purposes, we usually require sending us the serial number, but we need to count with cases when users no longer have the box, and the device is not working, and it is hard to find it on Turris MOX.
We should describe it and ...For the RMA purposes, we usually require sending us the serial number, but we need to count with cases when users no longer have the box, and the device is not working, and it is hard to find it on Turris MOX.
We should describe it and make it easier for users to avoid misunderstandings.Lukas JelinekLukas Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/142Article about hardening Turris router2021-07-28T14:45:54+02:00Karel KociArticle about hardening Turris routerAlthough Turris routers are as secure as possible out of the box there might still be some considerations and options users could choose to investigate. This should point possibly to topics such as:
* Sentinel
* Jail and Seccomp if we t...Although Turris routers are as secure as possible out of the box there might still be some considerations and options users could choose to investigate. This should point possibly to topics such as:
* Sentinel
* Jail and Seccomp if we trust them enoughhttps://gitlab.nic.cz/turris/user-docs/-/issues/141How to remove or uninstalled packages2024-03-27T16:40:54+01:00Josef SchlehoferHow to remove or uninstalled packagesOn our support, we received a response, then he installed some packages from our documentation, but he does not know how he should uninstall it.
I think it is not clear that unchecking and saving it in Package management tab will remove...On our support, we received a response, then he installed some packages from our documentation, but he does not know how he should uninstall it.
I think it is not clear that unchecking and saving it in Package management tab will remove it. :thinking:
What do you think @ljelinek ?Lukas JelinekLukas Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/140Timeouts on remote link checks2021-09-22T13:07:28+02:00Lukas JelinekTimeouts on remote link checksThe link check script (`test-links.sh`) fails with timeout for many remote links. The same link work well from my computer however. It means that there is some problem which should be resolved.The link check script (`test-links.sh`) fails with timeout for many remote links. The same link work well from my computer however. It means that there is some problem which should be resolved.https://gitlab.nic.cz/turris/user-docs/-/issues/139Improve instructions how to build/deploy documentation2021-10-19T14:58:20+02:00Lukas JelinekImprove instructions how to build/deploy documentationInstructions how to build and deploy the documentation are incomplete (e.g don't contain authentication to the GitLab server) and need to be improved.Instructions how to build and deploy the documentation are incomplete (e.g don't contain authentication to the GitLab server) and need to be improved.Lukas JelinekLukas Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/138tyy → tty2021-05-18T12:37:59+02:00Dirk Hoffmanntyy → ttyIt's a minor issue, but you have two occurences of `tyy` (instead of `tty`) in [hw/serial.md](docs/hw/serial.md#L79-92)It's a minor issue, but you have two occurences of `tyy` (instead of `tty`) in [hw/serial.md](docs/hw/serial.md#L79-92)https://gitlab.nic.cz/turris/user-docs/-/issues/137Add documentation for running diagnostics from terminal2021-10-15T13:21:53+02:00Karel KociAdd documentation for running diagnostics from terminalThe current documentation specifies how to collect logs manually but we can also generate diagnostics from terminal. With turris/os/packages!743 this should be even easier:
```sh
turris-diagnostics | gzip > diag.gz
```
The documentation...The current documentation specifies how to collect logs manually but we can also generate diagnostics from terminal. With turris/os/packages!743 this should be even easier:
```sh
turris-diagnostics | gzip > diag.gz
```
The documentation should probably state:
* How to generate diagnostics
* How to get them from router over SSH
* That user should remove them afterwards so they are not taking up space or that he should generate them in /tmphttps://gitlab.nic.cz/turris/user-docs/-/issues/136Micro SD card check2021-05-10T16:34:52+02:00Lukas JelinekMicro SD card checkThe documentation should mention that the Micro SD card can be checked whether it is inserted and locked properly if MOX or Shield can't boot (and that if the card isn't inserted properly the device can't boot).
Based on experience of o...The documentation should mention that the Micro SD card can be checked whether it is inserted and locked properly if MOX or Shield can't boot (and that if the card isn't inserted properly the device can't boot).
Based on experience of our support (reported by @mblazkova).https://gitlab.nic.cz/turris/user-docs/-/issues/135Document that ISP or some research organization migh contant users running Se...2021-04-27T14:09:24+02:00Karel KociDocument that ISP or some research organization migh contant users running SentinelIt is possible that ISP or some research organization can contact users and tell them or even request from them blockage of "unsecure" service they are running. In most cases that is going to be Sentinel Minipot but user should check any...It is possible that ISP or some research organization can contact users and tell them or even request from them blockage of "unsecure" service they are running. In most cases that is going to be Sentinel Minipot but user should check anyway and respond to such request with info that he is running honeypot as part of CZ.NIC security research. We should document such response and and tell explicitly users that this can happen and that all sides are rather doing their work pretty well at that point.Lukas JelinekLukas Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/134Document SSH connection2021-04-21T11:54:14+02:00Martin PrudekDocument SSH connectionSince we advertise our routers as open and we grant the user full root access to the device we should have a proper documentation page about SSH access. Similar page already exists on our [old wiki](https://wiki.turris.cz/doc/cs/howto/ss...Since we advertise our routers as open and we grant the user full root access to the device we should have a proper documentation page about SSH access. Similar page already exists on our [old wiki](https://wiki.turris.cz/doc/cs/howto/ssh?s[]=putty).https://gitlab.nic.cz/turris/user-docs/-/issues/133Shield overall description2021-06-16T17:35:22+02:00Vojtech MyslivecShield overall descriptionAdd or extend overall Shield description to make clear what it exactly is.
Shield
- Is not a MOX
- Is not modular/extensible
- Has automatic updates enabled and not configurable
- Has Turris Sentinel, OpenVPN and NetMetr preinstalled
- ...Add or extend overall Shield description to make clear what it exactly is.
Shield
- Is not a MOX
- Is not modular/extensible
- Has automatic updates enabled and not configurable
- Has Turris Sentinel, OpenVPN and NetMetr preinstalled
- Does not have full-value Turris OS
- Does not have LuCI
- Does not include options to install extra software
- ReForis interface is pruned and crippled (e.g. no Guest network)
- The only supported setup is a router with WAN Ethernet uplink (PPPoE possible) and 4x LAN Ethernet downlink, with IPv4 NAT and IPv6 prefix delegation (from DHCPv6)
Also, we must mark visibly some software features that are not present or supported on Shield.Lukas JelinekLukas Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/132Fix links to firmware and uboot2021-06-04T09:59:58+02:00Lukas JelinekFix links to firmware and ubootThe remote link checker currently reports two broken links:
- [secure-firmware](https://gitlab.nic.cz/turris/turris-os-packages/-/raw/master/hardware/mox/mox-support/files/secure-firmware.bin)
- [uboot](https://gitlab.nic.cz/turris/turri...The remote link checker currently reports two broken links:
- [secure-firmware](https://gitlab.nic.cz/turris/turris-os-packages/-/raw/master/hardware/mox/mox-support/files/secure-firmware.bin)
- [uboot](https://gitlab.nic.cz/turris/turris-os-packages/-/raw/master/hardware/mox/mox-support/files/uboot)
These links are apparently no longer valid and should be replaced by the working ones.https://gitlab.nic.cz/turris/user-docs/-/issues/131Proper cables2021-05-18T15:58:21+02:00Vojtech MyslivecProper cablesBased on [tracker#1258200](https://tracker.nic.cz/Ticket/Display.html?id=1258200), we should state somewhere near "first setup" this warning/information:
> Make sure you use proper Gigabit Ethernet cables i.e. Cat 5e or Cat 6 straight u...Based on [tracker#1258200](https://tracker.nic.cz/Ticket/Display.html?id=1258200), we should state somewhere near "first setup" this warning/information:
> Make sure you use proper Gigabit Ethernet cables i.e. Cat 5e or Cat 6 straight unshielded twisted pair cables with 8 wires (8P8C) to connect your devices to the Turris as well as your Turris to the modem or other ISP device.
exact wording could be improvedLukas JelinekLukas Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/130Documentation performance problems in Firefox2021-03-17T20:23:31+01:00Lukas JelinekDocumentation performance problems in FirefoxSome documentation pages, especially those with multiple images, are very slow when scrolling. This process is very CPU-consuming and allocates huge amounts of memory (hundreds of MBs per second up to several GBs; it could lead to killin...Some documentation pages, especially those with multiple images, are very slow when scrolling. This process is very CPU-consuming and allocates huge amounts of memory (hundreds of MBs per second up to several GBs; it could lead to killing the browser by oom_killer).
These problems occur only in Firefox (version 86.0 in Linux). They probably don't affect browsers based on Webkit/Blink (tested in Chromium, Opera and Rekonq).https://gitlab.nic.cz/turris/user-docs/-/issues/129Shield factory reset / rescue modes2021-05-03T16:15:52+02:00Lukas JelinekShield factory reset / rescue modesThere are factory reset guides (for rescue modes respectively) for various device but not for Shield. It is performed similarly to [MOX](https://docs.turris.cz/hw/mox/rescue-modes/) but there are some differences which should be document...There are factory reset guides (for rescue modes respectively) for various device but not for Shield. It is performed similarly to [MOX](https://docs.turris.cz/hw/mox/rescue-modes/) but there are some differences which should be documented. Some parts of the documentation can be shared between MOX and Shield.
Originally suggested in #72 but not yet written.