user-docs issueshttps://gitlab.nic.cz/turris/user-docs/-/issues2021-04-12T10:19:51+02:00https://gitlab.nic.cz/turris/user-docs/-/issues/96Erratum for Turris Shield2021-04-12T10:19:51+02:00Karel KociErratum for Turris ShieldThis should mention at minimum:
* LAN4 port issue
* IP assignment issue (that LAN IP address is removed if connected to 192.168.1.1/24 network on WAN side)This should mention at minimum:
* LAN4 port issue
* IP assignment issue (that LAN IP address is removed if connected to 192.168.1.1/24 network on WAN side)Michal HruseckyMichal Hruseckyhttps://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/121Explain status of LED colors using rescue modes2021-03-06T05:34:58+01:00Josef SchlehoferExplain status of LED colors using rescue modesOne guy on Reddit reported to us what means if all LEDs are green and it would be good to mention what means if all LEDs are blue or red. And what users should do if it ends up in error.
Reference: https://www.reddit.com/r/Turris/commen...One guy on Reddit reported to us what means if all LEDs are green and it would be good to mention what means if all LEDs are blue or red. And what users should do if it ends up in error.
Reference: https://www.reddit.com/r/Turris/comments/l5meas/all_leds_green_during_restore/Michal HruseckyMichal Hruseckyhttps://gitlab.nic.cz/turris/user-docs/-/issues/118Add a bridge/access point/switch mode setting how-to2021-01-22T15:51:55+01:00Stepan RechnerAdd a bridge/access point/switch mode setting how-toIt is possible to set a Turris router up via (re)Foris to a mode when it does not provide services like DHCP or DNS. It may be wanted for example for a use-case when there is a need to extend a Wi-Fi signal to a further place of a house....It is possible to set a Turris router up via (re)Foris to a mode when it does not provide services like DHCP or DNS. It may be wanted for example for a use-case when there is a need to extend a Wi-Fi signal to a further place of a house. It is even more convenient when there the same SSID and password is set up because this way the switch between the two APs is smooth.
We send to those, who are interested in this setting similar instruction as follows:
>>>
If you wish to set your Turris router to a bridge/access point/switch mode, it is possible to do that in the (re)Foris interface in two steps:
1st step: Go to the tab "NETWORK INTERFACES" (or in reForis "Interfaces" tab in the "Network Settings" menu):
- Move all the interfaces from WAN to LAN. If you click on an interface, you will find an option to change the network.
- Then confirm with the "Save" button.
2nd step: Move to the "LAN" tab and choose:
- "LAN mode" as "Computer"
- "IPv4 protocol" as "DHCP (automatic configuration)
- and confirm with the "Save" button.
At this point, the IP addresses change (your router will not listen at its default address anymore, but on the one, that it receives from the main router). You may need to disconnect the Ethernet cable and connect it again. The address <https://turris.local> may keep working.
After that, you may be reconnected to the new IP address automatically. If not, you will need to find out the new address in your main router.
>>>https://gitlab.nic.cz/turris/user-docs/-/issues/104Correct router uplink connection documentation2020-12-17T13:14:47+01:00Karel KociCorrect router uplink connection documentationWell I thought it is pretty much clear how router should be connected but from feedback on support it is not clear at all.
This should cover cases such as:
* connect it as directly as possible (replace existing router and/or connect di...Well I thought it is pretty much clear how router should be connected but from feedback on support it is not clear at all.
This should cover cases such as:
* connect it as directly as possible (replace existing router and/or connect directly behind modem)
* switch modem to bridge mode if possiblehttps://gitlab.nic.cz/turris/user-docs/-/issues/103Add a how-to about Turris MOX (dis)assembly2020-12-08T15:08:03+01:00Stepan RechnerAdd a how-to about Turris MOX (dis)assemblySuggested notes to mention:
* link to an [instruction video](https://youtu.be/yL8Rpo0Wshc)
* to be careful while pulling off the sides if a Wi-Fi card is included (antennas are glued to them)
* how to arrange the pigtails (especially the...Suggested notes to mention:
* link to an [instruction video](https://youtu.be/yL8Rpo0Wshc)
* to be careful while pulling off the sides if a Wi-Fi card is included (antennas are glued to them)
* how to arrange the pigtails (especially the SDIO card; @jhoracek knows)
* the order or different modules matters + link to our [configurator](https://mox-configurator.turris.cz/)
Related ticket in the RT system: `#1187655: Opening the router?`https://gitlab.nic.cz/turris/user-docs/-/issues/98Review factory image for Shield2020-11-14T01:07:11+01:00Vojtech MyslivecReview factory image for ShieldShield is distributed with %"Turris OS 5.1.2", yet we announce it was %"Turris OS 5.1.0"
From currently published [docs](https://docs.turris.cz/basics/tos_versions/):
![Screenshot_from_2020-11-14_01-04-42](/uploads/ad92c58c267310e8a99...Shield is distributed with %"Turris OS 5.1.2", yet we announce it was %"Turris OS 5.1.0"
From currently published [docs](https://docs.turris.cz/basics/tos_versions/):
![Screenshot_from_2020-11-14_01-04-42](/uploads/ad92c58c267310e8a99286446a60429a/Screenshot_from_2020-11-14_01-04-42.png)
From fresh new unpacked Shield:
![Screenshot_from_2020-11-14_01-06-12](/uploads/109e977befbf54ca60a85379aad88653/Screenshot_from_2020-11-14_01-06-12.png)
It would be nice to include this info in the docsMichal HruseckyMichal Hruseckyhttps://gitlab.nic.cz/turris/user-docs/-/issues/93Distinguish the software version in documentation2020-11-09T14:34:33+01:00Jan PavlinecDistinguish the software version in documentation
Why this could be helpful.
In the case of device certification, we would like to link to the user documentation for info confirmation, etc. The reviewed version of SW could include different feature sets (there could be new features no...
Why this could be helpful.
In the case of device certification, we would like to link to the user documentation for info confirmation, etc. The reviewed version of SW could include different feature sets (there could be new features not presented in the older version, some features could be removed from the new version, etc.).
Possible solutions:
* Archive older documentary with SW version ( example https://knot-resolver.readthedocs.io/en/v5.1.3/)
* Highlight - new/obsolete features in SW documentation **(this is preferred method)**
Related to https://gitlab.nic.cz/turris/biz/singapore-certification/-/issues/1https://gitlab.nic.cz/turris/user-docs/-/issues/88Add support period for Turris devices2020-10-27T17:31:03+01:00Jan PavlinecAdd support period for Turris devices
This could be part of Turris OS version table from https://docs.turris.cz/basics/tos_versions/
This should help meet the following mandatory requirements for Tier 1 defined by CSA Singapore&#39;s Cybersecurity Labeling Scheme
* 5.3-...
This could be part of Turris OS version table from https://docs.turris.cz/basics/tos_versions/
This should help meet the following mandatory requirements for Tier 1 defined by CSA Singapore's Cybersecurity Labeling Scheme
* 5.3-13:The manufacturer shall publish, in an accessible way that is clear and transparent to the user, the defined support period.
Related to https://gitlab.nic.cz/turris/biz/singapore-certification/-/issues/1https://gitlab.nic.cz/turris/user-docs/-/issues/85Extend rescue mod documentation with medkit signature description2020-10-27T15:02:32+01:00Jan PavlinecExtend rescue mod documentation with medkit signature descriptionDocumentation is describing how to verify sha256 checksum but signature verification is missing.
see https://docs.turris.cz/hw/omnia/rescue_modes/#re-flash-router
We should also describe what the signature algorithm is used.
This shoul...Documentation is describing how to verify sha256 checksum but signature verification is missing.
see https://docs.turris.cz/hw/omnia/rescue_modes/#re-flash-router
We should also describe what the signature algorithm is used.
This should help meet the following mandatory requirements for Tier 1 defined by CSA Singapore's Cybersecurity Labeling Scheme
* 5.3-2:When the device is not a constrained device, it shall have an update mechanism for the secure installation of updates.
Related to https://gitlab.nic.cz/turris/biz/singapore-certification/-/issues/1https://gitlab.nic.cz/turris/user-docs/-/issues/57Community translations2020-10-26T10:48:27+01:00Karel KociCommunity translationsWe could provide community translated documentation. This doesn't mean that we should tell users that it is authoritative but we could allow users to translate it somehow.
The idea is to use same framework as rest of our tools that mean...We could provide community translated documentation. This doesn't mean that we should tell users that it is authoritative but we could allow users to translate it somehow.
The idea is to use same framework as rest of our tools that means weblate. That means we have to generate pot files from our markdown and later on translate it.
Example of script and project doing that is https://github.com/tvheadend/tvheadend-documentation/blob/master/tvhmd.pyhttps://gitlab.nic.cz/turris/user-docs/-/issues/79Full-page search2020-10-16T10:01:18+02:00Lukas JelinekFull-page searchOriginally from here (by [fantomas](https://forum.turris.cz/u/fantomas)): https://forum.turris.cz/t/search-on-docs-turris-cz/13962
Is it possible to search on docs.turris.cz via full-page search? Currently I’m only able to get that “Typ...Originally from here (by [fantomas](https://forum.turris.cz/u/fantomas)): https://forum.turris.cz/t/search-on-docs-turris-cz/13962
Is it possible to search on docs.turris.cz via full-page search? Currently I’m only able to get that “Type to start searching” box which opens small window with results. Can I get these results in full page?
This is similar to what [this forum](https://forum.turris.cz) does, but in this forum I can get the full page by clicking “options”.https://gitlab.nic.cz/turris/user-docs/-/issues/76Expand interesting features to try2020-10-14T15:13:42+02:00Karel KociExpand interesting features to tryI even didn't know that we have this page but we have (https://docs.turris.cz/basics/highlights/). We should expand that. It looks rather empty. For example adding logos and potentially link to upstream would make sense in case of Nextcl...I even didn't know that we have this page but we have (https://docs.turris.cz/basics/highlights/). We should expand that. It looks rather empty. For example adding logos and potentially link to upstream would make sense in case of Nextcloud. Also we do not have just three highlights. How about data collect? LXC? Snapshots? Guest network? Storage? Netmetr?https://gitlab.nic.cz/turris/user-docs/-/issues/55Add article about supported HW2020-10-13T19:35:43+02:00Michal HruseckyAdd article about supported HWDescribe how HW support works and link to community wikiDescribe how HW support works and link to community wikiMichal HruseckyMichal Hruseckyhttps://gitlab.nic.cz/turris/user-docs/-/issues/27Explain how boot process work2020-10-12T14:38:42+02:00Michal HruseckyExplain how boot process workOur default configuration is a little bit tweaked, so describe how the whole boot process works, how distro boot works, what are our tweaks. Consider only new u-boot.Our default configuration is a little bit tweaked, so describe how the whole boot process works, how distro boot works, what are our tweaks. Consider only new u-boot.https://gitlab.nic.cz/turris/user-docs/-/issues/71Add documentation about adapter power2020-10-12T14:37:12+02:00Vojtech MyslivecAdd documentation about adapter powerEspecially for MOX F (4x USB) with extra power source.Especially for MOX F (4x USB) with extra power source.Jan HoracekJan Horacek2020-10-16https://gitlab.nic.cz/turris/user-docs/-/issues/60NAS article2020-10-12T14:24:32+02:00Josef SchlehoferNAS articleSimilar to this one: https://doc.turris.cz/doc/en/howto/nasSimilar to this one: https://doc.turris.cz/doc/en/howto/nas2020-10-16https://gitlab.nic.cz/turris/user-docs/-/issues/42Describe how to configure Firewall via LuCI2020-10-12T14:02:33+02:00Michal HruseckyDescribe how to configure Firewall via LuCIhttps://gitlab.nic.cz/turris/user-docs/-/issues/62Device Detection2020-07-16T17:45:27+02:00Josef SchlehoferDevice DetectionWe should document to our users what Device Detection do, where is the configuration file. What they can do and if they can delete or list specified devices in CLI.We should document to our users what Device Detection do, where is the configuration file. What they can do and if they can delete or list specified devices in CLI.https://gitlab.nic.cz/turris/user-docs/-/issues/61mwan howto2020-04-08T01:36:47+02:00Vojtech Myslivecmwan howtoPrepare `mwan3` documentation, especially failover for *LTE module* (which is as well missing, see turris/user-docs#59), similar as we have in [an article in the original documentation](https://doc.turris.cz/doc/en/howto/multiwan).
We s...Prepare `mwan3` documentation, especially failover for *LTE module* (which is as well missing, see turris/user-docs#59), similar as we have in [an article in the original documentation](https://doc.turris.cz/doc/en/howto/multiwan).
We should have this covered as some Omnias were shipped with LTE modem, we announce LTE support and we have SIM slot for that on all mPCIe boards/devices.