[{"data":1,"prerenderedAt":689},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fsettings":3,"docs-sib-\u002Fdocs\u002Fsettings":587,"docs-nav":663},{"id":4,"title":5,"body":6,"description":577,"extension":578,"meta":579,"navigation":580,"order":581,"path":582,"section":583,"seo":584,"stem":585,"__hash__":586},"docs\u002Fdocs\u002Fsettings.md","Settings",{"type":7,"value":8,"toc":561},"minimark",[9,14,23,26,32,36,41,51,57,117,126,130,133,207,212,246,255,269,273,276,286,303,310,314,381,386,390,393,462,474,478,520,528,532,539,543,550,554],[10,11,13],"h2",{"id":12},"how-settings-work","How settings work",[15,16,17,18,22],"p",{},"The Settings screen holds the ",[19,20,21],"strong",{},"defaults for new crawls",", plus a few app preferences. Changes are saved as you make them.",[15,24,25],{},"Each crawl keeps the settings it started with. Changing a setting affects the next crawl you start, not the crawls you already have, and not a crawl you resume.",[27,28],"screenshot",{"alt":29,"caption":30,"src":31},"The Settings screen in light mode with appearance, politeness and scope options","The defaults for every new crawl, all on one screen.","\u002Fscreenshots\u002Fsettings.png",[10,33,35],{"id":34},"appearance","Appearance",[27,37],{"alt":38,"caption":39,"src":40},"The Settings screen in dark mode","The same screen in dark mode. Pick a theme and a palette and the whole app follows.","\u002Fscreenshots\u002Fsettings-dark.png",[15,42,43,46,47,50],{},[19,44,45],{},"Theme:"," System, Light or Dark. ",[19,48,49],{},"System"," follows your operating system's setting.",[15,52,53,56],{},[19,54,55],{},"Colour:"," the palette used across the app, in light and dark alike.",[58,59,60,73],"table",{},[61,62,63],"thead",{},[64,65,66,70],"tr",{},[67,68,69],"th",{},"Palette",[67,71,72],{},"What it looks like",[74,75,76,87,97,107],"tbody",{},[64,77,78,84],{},[79,80,81],"td",{},[19,82,83],{},"Ember",[79,85,86],{},"A vivid orange accent with the usual red, amber and green severities. The default.",[64,88,89,94],{},[79,90,91],{},[19,92,93],{},"Gold on graphite",[79,95,96],{},"The website's gold, with severity shown by lightness rather than colour. Quieter, and legible if you can't tell red from green.",[64,98,99,104],{},[79,100,101],{},[19,102,103],{},"Graphite",[79,105,106],{},"Gold on the main buttons and nowhere else. Selection, focus and severity are all steps on one grey scale.",[64,108,109,114],{},[79,110,111],{},[19,112,113],{},"Monochrome",[79,115,116],{},"Black and white throughout. No colour anywhere: severity, status and the main button are all shades of grey.",[15,118,119,120,125],{},"The palette only changes how CrawlStat looks. A ",[121,122,124],"a",{"href":123},"\u002Fdocs\u002Fclient-reports","client report"," has its own brand colour, chosen when you export it.",[10,127,129],{"id":128},"politeness","Politeness",[15,131,132],{},"These settings control how hard CrawlStat works the site's server. The defaults are deliberately gentle.",[58,134,135,148],{},[61,136,137],{},[64,138,139,142,145],{},[67,140,141],{},"Setting",[67,143,144],{},"Default",[67,146,147],{},"What it does",[74,149,150,168,181,194],{},[64,151,152,157,160],{},[79,153,154],{},[19,155,156],{},"Respect robots.txt",[79,158,159],{},"On",[79,161,162,163,167],{},"Obeys the site's Disallow rules and ",[164,165,166],"code",{},"Crawl-delay",".",[64,169,170,175,178],{},[79,171,172],{},[19,173,174],{},"Simultaneous requests",[79,176,177],{},"5",[79,179,180],{},"How many URLs are in flight at once, per host. Range 1 to 50.",[64,182,183,188,191],{},[79,184,185],{},[19,186,187],{},"Delay between requests",[79,189,190],{},"0 ms",[79,192,193],{},"A pause between requests. Zero means as fast as the server answers. Range 0 to 10,000 ms.",[64,195,196,201,204],{},[79,197,198],{},[19,199,200],{},"Request timeout",[79,202,203],{},"20,000 ms",[79,205,206],{},"How long to wait for a response before giving up. Range 1,000 to 120,000 ms.",[208,209,211],"h3",{"id":210},"when-to-change-them","When to change them",[213,214,215,228,237],"ul",{},[216,217,218,221,222,224,225,227],"li",{},[19,219,220],{},"The site is slow or returns 503s or 429s."," Lower ",[19,223,174],{}," to 1 or 2, and add a ",[19,226,187],{}," of a few hundred milliseconds.",[216,229,230,233,234,236],{},[19,231,232],{},"It's your own site, on capable hosting."," You can raise ",[19,235,174],{}," to speed things up. Watch the live view for server errors, which mean you've gone too far.",[216,238,239,242,243,245],{},[19,240,241],{},"Pages take a long time to generate."," Raise the ",[19,244,200],{}," so slow pages aren't recorded as failures.",[15,247,248,249,251,252,254],{},"If the site's robots.txt sets a ",[164,250,166],{},", CrawlStat honours it while ",[19,253,156],{}," is on, even if your own delay is shorter.",[256,257,259],"callout",{"type":258},"warning",[15,260,261,262,264,265,167],{},"Turning off ",[19,263,156],{}," is meant for sites you own, for example to audit a staging server that blocks all crawlers. It isn't a way to hammer someone else's site. See ",[121,266,268],{"href":267},"\u002Fdocs\u002Fcrawler-and-robots","The crawler and robots.txt",[10,270,272],{"id":271},"user-agent","User agent",[15,274,275],{},"This is the name CrawlStat sends with every request. The default is:",[277,278,284],"pre",{"className":279,"code":281,"language":282,"meta":283},[280],"language-text","CrawlStatBot\u002F1.0 (+https:\u002F\u002Fcrawlstat.com\u002Fbot)\n","text","",[164,285,281],{"__ignoreMap":283},[15,287,288,289,292,293,296,297,300,301,167],{},"The user agent is also what robots.txt rules are matched against. CrawlStat uses the first word of your user agent (the part before the first ",[164,290,291],{},"\u002F"," or space) as its robots.txt name. With the default, rules addressed to ",[164,294,295],{},"CrawlStatBot"," apply, or the rules for ",[164,298,299],{},"*"," if there are none for ",[164,302,295],{},[15,304,305,306,309],{},"You can change it, for example to see how a site responds to a different client. Click ",[19,307,308],{},"Reset"," to go back to the default. Identifying the crawler honestly is what keeps it welcome, so we recommend keeping the default for sites you don't run.",[10,311,313],{"id":312},"scope","Scope",[58,315,316,326],{},[61,317,318],{},[64,319,320,322,324],{},[67,321,141],{},[67,323,144],{},[67,325,147],{},[74,327,328,353,365],{},[64,329,330,335,338],{},[79,331,332],{},[19,333,334],{},"Crawl subdomains",[79,336,337],{},"Off",[79,339,340,341,344,345,348,349,352],{},"Treats subdomains as part of the site, so ",[164,342,343],{},"blog.example.com"," is crawled along with ",[164,346,347],{},"example.com",". ",[164,350,351],{},"www."," is always treated as the same site.",[64,354,355,360,362],{},[79,356,357],{},[19,358,359],{},"Check external links",[79,361,159],{},[79,363,364],{},"Fetches links to other sites once to see whether they work. They're never followed any further.",[64,366,367,372,374],{},[79,368,369],{},[19,370,371],{},"Follow nofollow links",[79,373,337],{},[79,375,376,377,380],{},"Follows links marked ",[164,378,379],{},"rel=\"nofollow\"",". Off by default, which is what a search engine does.",[15,382,261,383,385],{},[19,384,359],{}," makes crawls faster and keeps CrawlStat entirely on your site, but you won't find broken outbound links.",[10,387,389],{"id":388},"resources-to-crawl","Resources to crawl",[15,391,392],{},"HTML pages are always crawled. These settings decide which other files are fetched as well. Resources are fetched to check that they load and to record their size. CrawlStat never looks inside them for more links.",[58,394,395,407],{},[61,396,397],{},[64,398,399,402,404],{},[67,400,401],{},"Resource",[67,403,144],{},[67,405,406],{},"Why you'd want it",[74,408,409,426,438,450],{},[64,410,411,416,418],{},[79,412,413],{},[19,414,415],{},"Images",[79,417,159],{},[79,419,420,421,425],{},"Needed for the ",[121,422,424],{"href":423},"\u002Fdocs\u002Faudits\u002Foversized-images","oversized images"," audit to know real file sizes, and to find broken images.",[64,427,428,433,435],{},[79,429,430],{},[19,431,432],{},"Documents",[79,434,159],{},[79,436,437],{},"Checks PDFs and office files linked from the site.",[64,439,440,445,447],{},[79,441,442],{},[19,443,444],{},"Stylesheets",[79,446,337],{},[79,448,449],{},"Checks that CSS files load. This adds URLs to every crawl.",[64,451,452,457,459],{},[79,453,454],{},[19,455,456],{},"JavaScript",[79,458,337],{},[79,460,461],{},"Checks that script files load. They're never executed.",[256,463,465],{"type":464},"note",[15,466,467,468,470,471,473],{},"Every URL CrawlStat fetches counts towards a crawl's URL limit, if you set one, including resources and external link checks. A site with lots of images can reach your limit sooner than you'd expect. Turn off ",[19,469,415],{}," or ",[19,472,359],{}," if you only want to check pages.",[10,475,477],{"id":476},"storage","Storage",[58,479,480,490],{},[61,481,482],{},[64,483,484,486,488],{},[67,485,141],{},[67,487,144],{},[67,489,147],{},[74,491,492,508],{},[64,493,494,499,501],{},[79,495,496],{},[19,497,498],{},"Run audits when a crawl finishes",[79,500,159],{},[79,502,503,504,167],{},"Runs all 45 audits automatically. On a large crawl this takes a moment. If it's off, you can run them at any time from the ",[121,505,507],{"href":506},"\u002Fdocs\u002Fissues","Issues screen",[64,509,510,515,517],{},[79,511,512],{},[19,513,514],{},"Keep raw HTML",[79,516,337],{},[79,518,519],{},"Stores every page's source in the crawl file. This takes a lot of disk space. Custom extraction, which is planned, will work from stored HTML.",[15,521,522,523,527],{},"Below these, Settings shows where crawls are saved and where exports are written. These locations are shown for reference. See ",[121,524,526],{"href":525},"\u002Fdocs\u002Finstalling#where-crawlstat-keeps-its-files","Installing"," for the paths on each platform.",[10,529,531],{"id":530},"keyboard","Keyboard",[15,533,534,535,167],{},"A reference list of shortcuts. See ",[121,536,538],{"href":537},"\u002Fdocs\u002Fkeyboard-shortcuts","Keyboard shortcuts",[10,540,542],{"id":541},"about","About",[15,544,545,546,167],{},"Shows the version of CrawlStat's crawl engine and the crawl data folder. Include the version if you ",[121,547,549],{"href":548},"\u002Fdocs\u002Ftroubleshooting","get in touch about a problem",[10,551,553],{"id":552},"where-settings-are-stored","Where settings are stored",[15,555,556,557,560],{},"Settings are saved in a small ",[164,558,559],{},"settings.json"," file in CrawlStat's application data folder. If the file is ever damaged, CrawlStat ignores it and starts with the defaults.",{"title":283,"searchDepth":562,"depth":562,"links":563},2,[564,565,566,570,571,572,573,574,575,576],{"id":12,"depth":562,"text":13},{"id":34,"depth":562,"text":35},{"id":128,"depth":562,"text":129,"children":567},[568],{"id":210,"depth":569,"text":211},3,{"id":271,"depth":562,"text":272},{"id":312,"depth":562,"text":313},{"id":388,"depth":562,"text":389},{"id":476,"depth":562,"text":477},{"id":530,"depth":562,"text":531},{"id":541,"depth":562,"text":542},{"id":552,"depth":562,"text":553},"Every option on the Settings screen, covering appearance, politeness, user agent, scope, resources and storage, with the defaults and when to change them.","md",{},true,12,"\u002Fdocs\u002Fsettings","Using CrawlStat",{"title":5,"description":577},"docs\u002Fsettings","B-wSydUsq6NK1jlbY_GJ0pAShWSKDnbmrFcTGKst-r4",[588,591,594,598,601,604,608,612,615,619,623,627,631,635,639,640,642,646,650,652,656,659],{"title":589,"path":123,"order":590},"Client reports",null,{"title":592,"path":593,"order":590},"UX testing","\u002Fdocs\u002Fux-testing",{"title":595,"path":596,"order":597},"Getting started","\u002Fdocs\u002Fgetting-started",1,{"title":599,"path":600,"order":562},"Installing CrawlStat","\u002Fdocs\u002Finstalling",{"title":602,"path":603,"order":569},"Your first crawl","\u002Fdocs\u002Fyour-first-crawl",{"title":605,"path":606,"order":607},"Watching a crawl","\u002Fdocs\u002Fwatching-a-crawl",4,{"title":609,"path":610,"order":611},"The Pages table","\u002Fdocs\u002Fresults-table",5,{"title":613,"path":506,"order":614},"Issues",6,{"title":616,"path":617,"order":618},"The plan","\u002Fdocs\u002Fthe-plan",7,{"title":620,"path":621,"order":622},"Journeys","\u002Fdocs\u002Fjourneys",8,{"title":624,"path":625,"order":626},"Competitor Intelligence","\u002Fdocs\u002Fcompetitor-intelligence",8.7,{"title":628,"path":629,"order":630},"Accessibility","\u002Fdocs\u002Faccessibility",9,{"title":632,"path":633,"order":634},"Comparing crawls","\u002Fdocs\u002Fcomparing-crawls",10,{"title":636,"path":637,"order":638},"Projects","\u002Fdocs\u002Fprojects",11,{"title":5,"path":582,"order":581},{"title":538,"path":537,"order":641},13,{"title":643,"path":644,"order":645},"Open source and licence","\u002Fdocs\u002Flicensing",14,{"title":647,"path":648,"order":649},"Privacy and your data","\u002Fdocs\u002Fprivacy-and-data",15,{"title":268,"path":267,"order":651},16,{"title":653,"path":654,"order":655},"Local AI","\u002Fdocs\u002Flocal-ai",17,{"title":657,"path":548,"order":658},"Troubleshooting",18,{"title":660,"path":661,"order":662},"FAQ","\u002Fdocs\u002Ffaq",19,[664,665,666,668,669,670,671,672,673,674,675,676,677,678,679,680,681,683,684,685,686,688],{"title":589,"path":123,"section":590,"order":590},{"title":592,"path":593,"section":590,"order":590},{"title":595,"path":596,"section":667,"order":597},"Start here",{"title":599,"path":600,"section":667,"order":562},{"title":602,"path":603,"section":667,"order":569},{"title":605,"path":606,"section":583,"order":607},{"title":609,"path":610,"section":583,"order":611},{"title":613,"path":506,"section":583,"order":614},{"title":616,"path":617,"section":583,"order":618},{"title":620,"path":621,"section":583,"order":622},{"title":624,"path":625,"section":583,"order":626},{"title":628,"path":629,"section":583,"order":630},{"title":632,"path":633,"section":583,"order":634},{"title":636,"path":637,"section":583,"order":638},{"title":5,"path":582,"section":583,"order":581},{"title":538,"path":537,"section":583,"order":641},{"title":643,"path":644,"section":682,"order":645},"Account & data",{"title":647,"path":648,"section":682,"order":649},{"title":268,"path":267,"section":682,"order":651},{"title":653,"path":654,"section":682,"order":655},{"title":657,"path":548,"section":687,"order":658},"Help",{"title":660,"path":661,"section":687,"order":662},1793827598253]