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/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'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/84Create page for vulnerability reporting2021-06-15T10:50:13+02:00Jan PavlinecCreate page for vulnerability reportingThis page should provide contact information and timelines for acknowledgment of receipt and status update timeline.
We can get inspiration from products with certification see https://www.csa.gov.sg/programmes/cybersecurity-labelling/p...This page should provide contact information and timelines for acknowledgment of receipt and status update timeline.
We can get inspiration from products with certification see https://www.csa.gov.sg/programmes/cybersecurity-labelling/product-list
example https://kylaconnect.com/vulnerability-disclosure-policy/
This should help meet the following mandatory requirements for Tier 1 defined by CSA Singapore's Cybersecurity Labeling Scheme
* 5.2-1:The manufacturer shall make a vulnerability disclosure policy publicly available. This policy shall include, at a minimum: contact information for the reporting of issues; and information on timelines for:
1)initial acknowledgment of receipt; and 2)status updates until the resolution of the reported issues.
Related to https://gitlab.nic.cz/turris/biz/singapore-certification/-/issues/1https://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/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/68Turris OS UCI configuration reference2022-06-06T14:20:03+02:00Karel KociTurris OS UCI configuration referenceThis should be reference table of all possible UCI configurations with use cases and intended purposes we added to OpenWrt. We could even document some of the OpenWrt stuff we touch in Foris and other components. We do not have to docume...This should be reference table of all possible UCI configurations with use cases and intended purposes we added to OpenWrt. We could even document some of the OpenWrt stuff we touch in Foris and other components. We do not have to document every single option in UCI but having table for our extensions makes sense. I am not sure if OpenWrt has some generic sheet about that (they have for example this https://openwrt.org/docs/guide-user/base-system/basic-networking - see tables in that wiki) but we can build on top of that.https://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.https://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/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/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/47Guide for statistics graphs2021-06-04T10:11:39+02:00Vojtech MyslivecGuide for statistics graphsThere is a possibility to enable statistics graphs in LuCI. These packages are preinstalled AFAIK and it is needed just to enable it and tune a configuration a bit.
It is really valuable information to monitor device load (like CPU, mem...There is a possibility to enable statistics graphs in LuCI. These packages are preinstalled AFAIK and it is needed just to enable it and tune a configuration a bit.
It is really valuable information to monitor device load (like CPU, memory and network bandwidth) and we should guide the users to get these information as soon as possible.https://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/38Explain difference between Turris OS and OpenWRT2024-03-27T16:35:14+01:00Michal HruseckyExplain difference between Turris OS and OpenWRTBasicsLukas JelinekLukas Jelinek2020-10-16https://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/24Explain updater internals2022-06-06T14:27:38+02:00Michal HruseckyExplain updater internalsExplain how configuration works, how to override stuff and few main advanced features that might be interesting for advance users.Explain how configuration works, how to override stuff and few main advanced features that might be interesting for advance users.Basicshttps://gitlab.nic.cz/turris/user-docs/-/issues/23Explain updates from end users point of view2022-06-06T14:27:43+02:00Michal HruseckyExplain updates from end users point of viewExplain why updates are important, what updater and it's settings does and probably also LuCI package installation in advance section and how it is affected by updater.
This could be also used for **Singapore Cybersecurity Labelling Sch...Explain why updates are important, what updater and it's settings does and probably also LuCI package installation in advance section and how it is affected by updater.
This could be also used for **Singapore Cybersecurity Labelling Scheme** (https://gitlab.nic.cz/turris/biz/singapore-certification/-/issues/1). To meet the requirements of this scheme, we have to somehow address the following topic
* 5.3-2: When the device is not a constrained device, it shall have an update mechanism for the secure installation of updates.
* 5.3-3: An update shall be simple for the user to apply.
* 5.3-7: The device shall use **best practice cryptography** to facilitate secure update mechanisms.
* 5.3-8: **Security updates shall be timely.**
* 5.3-10: Where updates are delivered over a network interface, the device shall **verify the authenticity and integrity of each update via a trust relationship.**
Also, there should be some description of updater **threat model** (For example something similar to "1.5.2. from Goals to protect against specific attacks" https://github.com/theupdateframework/specification/blob/master/tuf-spec.md#the-update-framework-specification)Basics2020-10-16