Vše co jste kdy chtěli říci o dokumentaci

Bylo by možné doplnit do dokumentace high-level overview SW stránky Turrisu?
Moje představa je tato:

  1. Jaké části vyvíjíte nad samotným openwrt, aneb co vše je v Turrisu navíc?
  2. základní schéma foris frontendu a backendu ((k tomu jsem již něco našel na gitlabu), ale vyloženě high-level to nebylo)
  3. něco jako roadmapa - taky hodně high-level, vyjadřující představu Turris SW za několik let?

Hlavní je pro mne číslo jedna, zbytek jsou zajímavé nápady, které bych ocenil.

5 Likes

Zdravím,

  1. Zdá se mi, že takový článek zrovna připravujeme. :slight_smile: Napsali jsme do něj jaký software je v Turris OS nad rámec OpenWRT. Nejedná se o úplný seznam přidaných balíčků, ale o výčet větších projektů, kterými Turris OS tvoří nadstavbu nad OpenWRT. Měl jste na mysli něco takového?
    EDIT: Článek jsem před několika minutami zveřejnila tady. Můžete mi dát vědět, co vás ještě zajímá a třeba bude možné tam nějaké informace doplnit.
  2. Tohle je trochu větší oříšek a v podstatě na to v této chvíli nemáme kapacity, nicméně bychom to někdy v budoucnu snad rádi zvládli.
  3. Byli bychom rádi, kdybychom to uměli vyvěštit s takovou jistotou, abychom to mohli napsat černé na bílém. :wink: Pokud vás zajímá co plánujeme v roce 2018, doporučuji například na toto video z letošního InstallFestu: https://youtu.be/d7Un2pX2hvs
3 Likes

Moc děkuji za reakci a rozšíření dokumentace. Mám různé nápady, tohle ve mě krystalizovalo několik měsíců. :slight_smile:

Je něco nového ohledně doplnění dolumentace pro DNS/DHCP? Současný článek (https://doc.turris.cz/doc/cs/howto/dns) mi nepřijde dostačující, je tam popsáno proč to nejde nastavit v Luci ale chybí mi tam příklady jak to tedy udělat.

Jinak, něco pro Omnii je Anglicky v komunitní dokumentaci: https://doc.turris.cz/doc/en/public/dns_knot_misc

Mohu vědět, co konkrétně byste tam přidal? Např. změnu DNS serverů?

Ano, já bych ocenil návod jak změnit DNS servery. Jak pro Omnii tak pro “modráky”.

1 Like

No konkrétně, spíš bych si představoval že když je v nějakém návodu napsáno že něco přes Luci nejde tak by tam mělo být i popsáno jak to teda udělat.

Další věc je že bych čekal že to co přes Luci nejde se vůbec nebude ukazovat, je dost matoucí.

Rychle jsem shlédl část prezentace pana Zandla a musím říci, že nemluvil pravdu v tom, že žádný jiný výrobce než nic nedělá automatické update SW routeru. Synology tuto funci má…

Ještě mě jako uživatele v prezentaci “vytočilo”, jak pan Zandl obrací nedostatky projektu Turris v přednost, kdy konstatuje něco jako : “chybějící dokumentace a neúplné www rozhraní přece nevadí, máme příkazovou řádku… Uživatel si nikdy neřekne Já jsem blbec

2 Likes

Pro mě osobně není chybějící dokumentace a GUI překážkou. Omnii jsem si pořizoval kvůli hardware a bezpečnosti. VPN, síť pro hosty i jiné jsem si nastavil dříve, než vzniklo příslušné menu ve Forisu (protože to Turris OS z podstaty OpenWrt podporoval, lze odtud i čerpat stran návodů a rad). Jinak souhlasím, že aktualizace má i Synology a kromě něj třeba také Mikrotik, Ubiquiti nebo ASUS (který má taktéž jako základ Wrt).

protože to Turris OS z podstaty OpenWrt podporoval

No to je právě to co dělá dost propblémy, některé věco jksou v TO jinak než v původním OpenWRT.

Jinak k tomu GUI, mně ani tak nevadí že nejde všechno z GUI, mně vadí že i když to nejde to v GUI je a není to nijak označené. Takže uživatel něco nastacvuje a diví se že to nefunguje.

Na to že byl TO propagován jako bezpečný router do domácností, bez uvedení toho že je spíš pro toho kdo není úplný laik, je velký fail projektu.

3 Likes

Myslím si, že možnosti ve Forisu laikům stačí a tam pokud vím vše funguje (to málo co se tam dá nastavit). I mně to relativně dlouhou dobu stačilo. Uznávám, že občas se vyskytla potíž která takovým lidem bude nepříjemná, ale takové chyby jsou už poněkud odlišné téma…

EDIT: předpokládám, že máte na mysli hlavně DNS možnosti v luci modulu který konfiguruje dnsmasq (který se v Turris defaultu o DNS téměř nestará).

EDIT2: diskusi do nedokumentačních směrů zde rozvíjet nebudu, protože do tohoto vlákna nepatří a stejně se nezdá že by někam vedla.

Vy si opravdu myslíte, že laik, kterému stačí Foris, dá 7 tisíc za router? Nebo že ten, kdo se o problematiku zajímá a dá 7 tisíc se naopak spokojí s Forisem? V Praze jsou zřejmě platy dost jinde, že předpokládáte, že BFU najednou koupí router 10x dražší než minule jen proto, že se nějak dozví, že by měl být bezpečnější, ale podle mě většina cz zákazníků od takového routeru bude chtít trochu více.

3 Likes

předpokládám, že máte na mysli hlavně DNS možnosti v luci modulu který konfiguruje dnsmasq

Ano, narážím na LUCI kde si myslím by měli věci co nejdou nastavit disablované nebo alespoň nějak označené. Pokud to nejde měl by být součástí dokumentace seznam co nefunguje a musí se dělat jinak.

6 Likes

Ona ta dokumentace je právě v oblasti DHCP/DNS takovým koncentrátem nectností, kterými dokumentace v různé míře na různých místech trpí. Namátkou:

  1. Kdo je to laik a jaké jsou obecně “cílové skupiny” pro dokumentaci? Dělá to na mě dojem, že se snažíte psát (díky!), ovšem dost nahodile a živelně.
  2. Některé části dokumentace implicitně předpokládají zkušenosti s OpenWRT/LEDE, což dělá zbytečné potíže lidem (obecně rozhodně ne laikům) se zkušenostmi z jiných *nixových oblastí.
  3. Dokumentaci po napsání zřejmě nikdo moc systematicky neudržuje, takže obsahuje neaktuální věci (konrétně vím o odkazech na dávno nefungující návody).
  4. Některé vaše úpravy nejsou dokumentované vůbec. To už tu sice zčásti zaznělo (nekonzistence LuCi rozhraní), ale ty problémy jsou širší: automatické vytahování statických záznamů z /etc/config/dhcp a jejich vpisování do konfigurace unboundu (na modrých – nevím jestli se to děje i u Knotu na Omniích) nejenže není dokumentováno, ale je i těžko k nalezení, protože se nezapisuje do /etc/config/unbound (kde si toho admin všimne), ale jen do generované finální konfigurace ve /var/etc/unbound.
  5. U těch informací v dokumentaci, kde je pravděpodobnost změny stavu v čase, by bylo vhodné uvádět datum nebo verzi SW. Příklad: nekvalitní implementace DNSSEC v dnsmasq.
  6. Videonávody by neměly mít samostatnou kategorii. Kdo něco neví, nehledá podle formy dokumentace, ale podle problému.
  7. Ne vždy je poznat, že dokumentace existuje, ale jen v některém jazyce. Zdá se, že např. v anglické dokumentaci jsou červené odkazy na návody, které existují jen v češtině, ale opačně to vždy nefunguje. Vizte např. tento návod – opět z oblasti DNS a zcela jistě užitečný. Opět jen náhodný příklad, nekontroloval jsem to celé.

Pak samozřejmě existují různé chyby a nelogičnosti, ale to se samozřejmě stává běžně – tady jsem chtěl spíš popsat neduhy, které vypadají na systémový problém.

2 Likes

Obecně mi přišlo že jsou místa kde nevím co user interface udělá. Myslím že by také stálo dotáhnout dokumentaci nějakých scénářů které se častěji používají.

Jedna z věcí co jsem se svým Turrisem chtěl udělat bylo nahradit WD My cloud - tedy nastavit NAS a zpřístupnit ho z internetu. Zabil jsem tím několik dní , informace jak na to tu tak nějak jsou ale detaily chybí nebo člověk tomu musí předem dobře rozumět.

  1. Chtěl jsem nas s raidem 1 což asi storage plugin neumí. Nikde jsem nenašel co vlastně ten plugin dělá jen formátuje nebo něco navíc. Použil jsem pak návod z fóra co dělá btrfs a mdadm. Pročetl jsem fórum a nevím jestli je návod aktuální např jestli je potřeba vypínat NCQ ale nějak to funguje.

  2. Na navodech to sice někde zmíněné je ale konkrétně v tom jednom když člověk dělá NAS krok za krokem to uvedené není, že se očekává že disk bude namountován do /srv tím jsem se spálil.

  3. není nikde uvedené co dělá owncloud install script a jak nastavit ukladani data někam rozumně - tzn upravit umisteni dat. Doinstaloval jsem si nakonec aplikaci na external storage do owncloudu a prohlasil cestu nekam do /srv/neco za externi storage pak to nějak fungovalo ale musel jsem ještě upravit práva na čtení / zápis souborů.

  4. na ten /srv/neco jsem si nastavil read only access pres sambu ale pro write access a vytvoreni noveho uzivatele mi take chyběli informace jak to rozběhat s owncloude a jake tomu dat prava aby to chodilo dobre dohromady

  5. na pristup z vnejsku potrebuju fixni ip4 nebo ip6 a openvpn. konfigurace se da vygenerovat a pak přejmenovat a importovat do aplikace a pak ten soubor klidne smazat. Narazil jsem tam na problemy s testovanim ip6 nevim jestli ji ma powkytovatel zaplou protoze test se zasekne a clovek pak moc netusi co dal.

Obecne proste ty guidy nejsou uplne step by step a clovek nevi proc napr v raid guidu je mdadm a ze je alternativa nativní btrfs. Pochopil jsem nekde z fora ze možnosti je vic ale bylo by fajn vedet co ktere konfigurace dela - tzn nejake vysvetleni k tem krokum - nemam takove znalosti aby mi hned bylo jasne co delaji ktere linux prikazy a proc bych je mel chtit pouzit.

Typickým příkladem úplné rezignace na správu dokumentace je tak “triviální” stránka change log viz https://doc.turris.cz/doc/cs/howto/changelog
Na ní “zmrzla” historie na verzi Turris 3.10.5.

Dobrý den, při instalaci Turris MOX jsem postupoval podle návodu. Udělal jsem to proto, že Foris po instalaci nextcloud balíčku bylo k dispozici menu pro zadání jména a hesla k nextcloud. Bohužel z popisu mi nebylo zřejmé, že se jedná (asi, nezkusil jsem to) rozhraní pro konfiguraci instance nextCloud (dohaduji se, protože po instalaci pomocí skriptu z návodu se menu již změnilo). Aktualizovat dokumentaci pro MOX (možná obecně pro novější verze Foris) s odkazem na možnost základního nastavení přímo z menu Foris by pomohlo, jakož i lehce upravit stránku v menu Foris, aby bylo zřejmé, že se nemají zadávate nějaké již existující přihlašovací údaje, ale že budou použity pro vytvoření nové instance nextCloud. Nemaje žádnou zkušenost s NextColud, byl jsem zmaten, co mám zadat a raději jsem použil instalační skripty z doby před možností základního nastavení z forris. Tam jsem si zase z kontextu myslel, že zadávám přihlašovací údaje do MySQL a ne do NextCloud. Pro nezkušeného uživatele je to peklo matoucího kontextu k jinak prima kusu SW s pro mne jinak bezproblémovou integrací.
Zase jsem díky použití skriptu mohl dostat chybové hlášení: “The PHP memory limit is below the recommended value of 512MB” a nastavení paměti pro PHP upravit, NextCloud začal reagovat daleko lépe.
Krásný den a hodně zdaru s skvělým projektem Turris!

1 Like