user-docs issueshttps://gitlab.nic.cz/turris/user-docs/-/issues2020-12-01T09:14:15+01:00https://gitlab.nic.cz/turris/user-docs/-/issues/99wrong information in https://docs.turris.cz/basics/tos_versions/ about how to...2020-12-01T09:14:15+01:00Jan Filipovskywrong information in https://docs.turris.cz/basics/tos_versions/ about how to check version of Turris OS over sshIn documentation is written
`
Using SSH
You can connect to your router using SSH and view file /etc/os-release. The easiest option is to just simply print it to console with cat /etc/os-release.
Alternatively for script usage you can...In documentation is written
`
Using SSH
You can connect to your router using SSH and view file /etc/os-release. The easiest option is to just simply print it to console with cat /etc/os-release.
Alternatively for script usage you can source /etc/os-release and use variable $(VERSION_ID}. Example follows:
. /etc/os-release
echo "${VERSION_ID}" `
in reality:
<pre>
root@turris:/etc# cat /etc/os-release
cat: can't open '/etc/os-release': No such file or directory
root@turris:/etc#
root@turris:/etc# uname -a
Linux turris 4.4.199-a890a5a94ebb621f8f1720c24d12fef1-1 #1 SMP Fri Nov 13 00:42:57 CET 2020 armv7l GNU/Linux
</pre>
there are only files
<pre>
root@turris:/etc# ls -la |grep rel
-rw-r--r-- 1 root root 201 Nov 5 15:00 openwrt_release
root@turris:/etc# ls -la |grep openw
-rw-r--r-- 1 root root 201 Nov 5 15:00 openwrt_release
-rw-r--r-- 1 root root 6 Nov 5 15:00 openwrt_version
</pre>https://gitlab.nic.cz/turris/user-docs/-/issues/1Document how to found out where to report issues with packages2020-11-22T00:44:50+01:00Karel KociDocument how to found out where to report issues with packagesThe idea is to document a way for users to found out to which package specific file belongs to and how to found out where to report issue. The idea is to lower issues reporting for packages that are not maintained by use at all but rathe...The idea is to document a way for users to found out to which package specific file belongs to and how to found out where to report issue. The idea is to lower issues reporting for packages that are not maintained by use at all but rather by upstream. It is possible to do that by looking at `Maintainer` field of package and if there is `CZ.NIC` then it should be reported to us, otherwise in general it should go to upstream.Lukas JelinekLukas Jelinek2020-11-06https://gitlab.nic.cz/turris/user-docs/-/issues/75Add limits for SDIO wifi on Mox2020-11-15T19:53:57+01:00Karel KociAdd limits for SDIO wifi on MoxSDIO on Mox can support only eight clients and only four SSIDs. This should be mentioned in documentation.SDIO on Mox can support only eight clients and only four SSIDs. This should be mentioned in documentation.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/86Create article about updates2020-11-03T13:04:01+01:00Jan PavlinecCreate article about updates
I&#39;m not sure if this should be a separate page or if it should be in Foris/Updater documentation.
There should be a reference to all supported ways of SW update (updater via cli/foris, medkit via usb/network)
There should be a re...
I'm not sure if this should be a separate page or if it should be in Foris/Updater documentation.
There should be a reference to all supported ways of SW update (updater via cli/foris, medkit via usb/network)
There should be a reference about used encryption in medkit signature and in packages installed by the updater. We should also describe the properties of repo.turris.cz TLS certificate.
There should be a reference to updater documentation which describes its security consideration
(example "Goals to protect against specific attacks" https://github.com/theupdateframework/specification/blob/master/tuf-spec.md#the-update-framework-specification)
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.
* 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.
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/36Contribution guideline2020-10-21T14:49:55+02:00Michal HruseckyContribution guidelineDescribe various ways how to contribute.Describe various ways how to contribute.Lukas JelinekLukas Jelinek2020-11-06https://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/65Publish MOX addons schematics2020-10-13T09:33:08+02:00Karel KociPublish MOX addons schematicsWe should publish Mox SDIO and POE addons schematics to fully open-source MOX.We should publish Mox SDIO and POE addons schematics to fully open-source MOX.2020-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/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/67geek/tos3_migration: add notes about upgrade process and branch changes2020-10-08T23:30:36+02:00David Beiteygeek/tos3_migration: add notes about upgrade process and branch changesIt would be helpful if the 3.x to 5.x documentation explained that my OS branch would be switched to HBK (I was on stable) and likewise knowing what to expect from the upgrade process would help someone going through this for the first t...It would be helpful if the 3.x to 5.x documentation explained that my OS branch would be switched to HBK (I was on stable) and likewise knowing what to expect from the upgrade process would help someone going through this for the first time.
I've attached a patch with some suggestions, based on my person experience of seeing my branch change etc; feel free to adjust accordingly.
[update-docs-with-notes.patch](/uploads/09e1c0c6fe7943600ee2ddc3af0239bd/update-docs-with-notes.patch)https://gitlab.nic.cz/turris/user-docs/-/issues/73Add a lightbox and wrap images into it2020-09-24T21:18:12+02:00Aleksandr GumroianAdd a lightbox and wrap images into itIt would be nice to wrap images into a lightbox. It will allow users to open images in a full-size by click.It would be nice to wrap images into a lightbox. It will allow users to open images in a full-size by click.Aleksandr GumroianAleksandr Gumroian