user-docs issueshttps://gitlab.nic.cz/turris/user-docs/-/issues2024-03-12T15:51:50+01:00https://gitlab.nic.cz/turris/user-docs/-/issues/82Update factory image for Omnia 20202024-03-12T15:51:50+01:00Vojtech MyslivecUpdate factory image for Omnia 2020Since another production batch of Omnia routers started recently, we should update [list of Turris OS factory versions](https://docs.turris.cz/basics/tos_versions/#list-of-turris-os-factory-versions).
@mhrusecky will you handle that ple...Since another production batch of Omnia routers started recently, we should update [list of Turris OS factory versions](https://docs.turris.cz/basics/tos_versions/#list-of-turris-os-factory-versions).
@mhrusecky will you handle that please? I am not sure what exact TOS version is in production these daysMichal HruseckyMichal Hrusecky2020-11-13https://gitlab.nic.cz/turris/user-docs/-/issues/81Add heading to every article about applicable routers and level of knowledge2021-09-22T11:38:29+02:00Karel KociAdd heading to every article about applicable routers and level of knowledgeWe can use meta tags for this (https://squidfunk.github.io/mkdocs-material/reference/meta-tags/). We should somehow display it in compact form (probably icons of routers).We can use meta tags for this (https://squidfunk.github.io/mkdocs-material/reference/meta-tags/). We should somehow display it in compact form (probably icons of routers).Aleksandr GumroianAleksandr Gumroianhttps://gitlab.nic.cz/turris/user-docs/-/issues/80Documentation about WiFi coverage and router placement2021-05-18T15:58:41+02:00Karel KociDocumentation about WiFi coverage and router placementWe should write some article about WiFi coverage and how to place router at home to get best coverage (potentially how to expend it with Mox?)
This should also include some suggestion on how to debug/scan coverage such as suggestion of ...We should write some article about WiFi coverage and how to place router at home to get best coverage (potentially how to expend it with Mox?)
This should also include some suggestion on how to debug/scan coverage such as suggestion of wifi analyzer on phone (https://f-droid.org/en/packages/com.vrem.wifianalyzer/).Lukas JelinekLukas Jelinekhttps://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/78Collect data about visitors behavior2024-03-27T16:39:18+01:00Jan BetikCollect data about visitors behaviorWe do not have any information about the visitors of docs.turris.cz
I would like to use the Piwik/Matomo on the site to have better insight about the behavior of our visitors.We do not have any information about the visitors of docs.turris.cz
I would like to use the Piwik/Matomo on the site to have better insight about the behavior of our visitors.https://gitlab.nic.cz/turris/user-docs/-/issues/77Create article for common post-first-setup steps2023-08-29T11:10:46+02:00Karel KociCreate article for common post-first-setup stepsThis should include:
* [x] Configuration of notifications to email
* [x] Configure automatic restarts
* [x] Think about enabling data collect
There can be more and we should think about including more. The idea is to provide users with ...This should include:
* [x] Configuration of notifications to email
* [x] Configure automatic restarts
* [x] Think about enabling data collect
There can be more and we should think about including more. The idea is to provide users with checklist of things to do with their new device but not stuff they have to investigate more in depth such as LXC or Pakon. I mean to tell them what they probably want to configure immediately after guide.Lukas JelinekLukas Jelinekhttps://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/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/74Migrate GPIO documentation from wiki2023-08-29T11:09:51+02:00Karel KociMigrate GPIO documentation from wikiWe should migrate article about GPIO and primarily about electric capabilities of GPIOs (https://wiki.turris.cz/doc/cs/howto/gpio).We should migrate article about GPIO and primarily about electric capabilities of GPIOs (https://wiki.turris.cz/doc/cs/howto/gpio).Lukas JelinekLukas Jelinekhttps://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 Gumroianhttps://gitlab.nic.cz/turris/user-docs/-/issues/72Add Shield sections2021-05-18T16:02:53+02:00Lukas JelinekAdd Shield sectionsAdd Shield sections under the following (similarly to Omnia and MOX):
- [x] First setup !123
- [x] Hardware
- [ ] ~~Rescue modes~~ moved to #129
Update all relevant documentation pages too.Add Shield sections under the following (similarly to Omnia and MOX):
- [x] First setup !123
- [x] Hardware
- [ ] ~~Rescue modes~~ moved to #129
Update all relevant documentation pages too.Michal HruseckyMichal Hrusecky2020-10-16https://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/69Improving documentation for netboot2021-05-18T16:03:10+02:00janicalubosImproving documentation for netbootI was playing with netboot and I discovered few missing items in documentation about netboot or issues in netboot components:
- if user `turris-netboot` cannot read file `/etc/config/wireless` default configuration for wifi is not workin...I was playing with netboot and I discovered few missing items in documentation about netboot or issues in netboot components:
- if user `turris-netboot` cannot read file `/etc/config/wireless` default configuration for wifi is not working.
- unreadable file for user `turris-netboot` in `/srv/turris-netboot/rootfs/overlay` will be not included in final netboot filesystem. This should be mentioned in documentation
- styling for 4th level of section, which is little confusing. In text is SETUP.SH, on right pane in table of content is setup.sh.
- No information about changing hostname for netbooted turrises. When you have mutliple boxes, each has hostname turris. I found solution for changing hostname here https://forum.openwrt.org/t/solved-how-to-change-hostname-without-restarting/12357 and I think that it should be in official doc.Michal HruseckyMichal Hruseckyhttps://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/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/66[Booting from external and removable storage] not applicable for u-boot 2019....2020-08-06T13:06:20+02:00Ghost User[Booting from external and removable storage] not applicable for u-boot 2019.07 and newerBoth
https://doc.turris.cz/doc/en/howto/omnia_booting_from_external_storage#booting_from_ssd
https://doc.turris.cz/doc/en/howto/omnia_booting_from_external_storage#booting_from_usb
cite `btrload` which though is a legacy command and...Both
https://doc.turris.cz/doc/en/howto/omnia_booting_from_external_storage#booting_from_ssd
https://doc.turris.cz/doc/en/howto/omnia_booting_from_external_storage#booting_from_usb
cite `btrload` which though is a legacy command and produces
>Unknown command 'btrload' - try 'help'
https://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/64Document Sentinel plugin and services2021-05-18T15:58:53+02:00Vojtech MyslivecDocument Sentinel plugin and servicesRelates to #51 #70
- [x] Greylist
- [x] DynFW
- [x] Minipots
- [x] FWlogs
- [x] SurveyRelates to #51 #70
- [x] Greylist
- [x] DynFW
- [x] Minipots
- [x] FWlogs
- [x] SurveySentinel migrationhttps://gitlab.nic.cz/turris/user-docs/-/issues/63Explain how switch-branch works/how to migrate between major versions2020-04-20T06:37:58+02:00Petr ŠpačekExplain how switch-branch works/how to migrate between major versionsI'm attempting to follow https://docs.turris.cz/geek/testing/ and it seems that the guide is missing some steps or information.
This is my attempt to switch to from Turris OS 3 to Turris OS 5 in HBT:
```
# opkg list turris-version
turr...I'm attempting to follow https://docs.turris.cz/geek/testing/ and it seems that the guide is missing some steps or information.
This is my attempt to switch to from Turris OS 3 to Turris OS 5 in HBT:
```
# opkg list turris-version
turris-version - 3.11.16 - turris-version
```
```
root@turris:~# switch-branch
You are currently in: rc
You can choose from one of these branches:
deploy
Default and most stable branch. Suggested for unexperienced users.
rc
Release candidate. This branch contains next Turris OS release. Please join
this branch to help us test next release. It's more stable than daily but it
can contain bugs.
daily
This branch is same as nightly except it is updated only when automatic
tests are successful. Should be more stable than nightly but manual
intervention might be sometimes required too.
nightly
Branch built every night containing latest software. Suggested only for
experienced users as it's sometimes broken and requires manual intervention.
test
Branch used during development. It's often broken. It's usage is highly
discouraged.
Please enter name of a branch branch: rc
+ '[' rc '=' deploy ]
+ VBRANCH=-rc
+ sed -i '/\(turris\|omnia\)_nightly_/d;s#\(https://repo\.turris\.cz/\(turris\|omnia\)\)[^/]*/#\1-rc/#' /etc/opkg/distfeeds.conf
+ uci set 'updater.override=override'
+ '[' rc '=' deploy ]
+ VBRANCH=rc
+ uci set 'updater.override.branch=rc'
+ uci commit updater.override.branch
+ false
+ UPDATER_ARGS=
+ uci get updater.approvals.need
+ '[' 1 '=' 1 ]
+ pkgupdate
WARN:Branch overriden to rc
WARN:Requested package luci-i18n-ddns-en that is missing, ignoring as requested.
+ set +x
```
```
# opkg list turris-version
turris-version - 3.11.16 - turris-version
```
Maybe the guide is missing a last step, or maybe it is not applicable to Turris OS 3.x?
In either case it warrants some clarification.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.