A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://github.com/janreges/siteone-crawler below:

janreges/siteone-crawler: SiteOne Crawler is a cross-platform website crawler and analyzer for SEO, security, accessibility, and performance optimizationβ€”ideal for developers, DevOps, QA engineers, and consultants. Supports Windows, macOS, and Linux (x64 and arm64).

SiteOne Crawler is a powerful and easy-to-use website analyzer, cloner, and converter designed for developers seeking security and performance insights, SEO specialists identifying optimization opportunities, and website owners needing reliable backups and offline versions.

Discover the SiteOne Crawler advantage:

GIF animation of the crawler in action (also available as a ▢️ video):

In short, the main benefits can be summarized in these points:

The following features are summarized in greater detail:

πŸ’Ύ Offline website generator πŸ“ Website to markdown converter

πŸ’‘ Tip: you can push the exported markdown folder to your GitHub repository, where it will be automatically rendered as a browsable documentation. You can look at the examples of converted websites to markdown.

Don't hesitate and try it. You will love it as we do! ❀️

🀝 For active contributors

You can download ready-to-use releases from πŸ™ GitHub releases for all major platforms (🐧 Linux, πŸͺŸ Windows, 🍎 macOS, arm64).

Unpack the downloaded archive, and you will find the crawler or crawler.bat (Windows) executable binary and run crawler by ./crawler --url=https://my.domain.tld.

Note for Windows users: use Cygwin-based release *-win-x64.zip only if you can't use WSL (Ubuntu/Debian), what is recommended. If you really have to use the Cygwin version, set --workers=1 for higher stability.

Note for macOS users: In case that Mac refuses to start the crawler from your Download folder, move the entire folder with the Crawler via the terminal to another location, for example to the homefolder ~.

Most easily installation is on most Linux (x64) distributions.

git clone https://github.com/janreges/siteone-crawler.git
cd siteone-crawler

# run crawler with basic options
./crawler --url=https://my.domain.tld

If using Windows, the best choice is to use Ubuntu or Debian in WSL.

Otherwise, you can download swoole-cli-v4.8.13-cygwin-x64.zip from Swoole releases and use precompiled Cygwin-based bin/swoole-cli.exe.

A really functional and tested Windows command looks like this (modify path to your swoole-cli.exe and src\crawler.php):

c:\Tools\swoole-cli-v4.8.13-cygwin-x64\bin\swoole-cli.exe C:\Tools\siteone-crawler\src\crawler.php --url=https://www.siteone.io/

NOTICE: Cygwin does not support STDERR with rewritable lines in the console. Therefore, the output is not as beautiful as on Linux or macOS.

If using macOS with latest arm64 M1/M2 CPU, download arm64 version swoole-cli-v4.8.13-macos-arm64.tar.xz, unpack and use its precompiled swoole-cli.

If using macOS with Intel CPU (x64), download x64 version swoole-cli-v4.8.13-macos-x64.tar.xz, unpack and use its precompiled swoole-cli.

If using arm64 Linux, you can download swoole-cli-v4.8.13-linux-arm64.tar.xz and use its precompiled swoole-cli.

To run the crawler, execute the crawler executable file from the command line and provide the required arguments:

./crawler --url=https://mydomain.tld/ --device=mobile
./crawler --url=https://mydomain.tld/ \
  --output=text \
  --workers=2 \
  --max-reqs-per-sec=10 \
  --memory-limit=1024M \
  --resolve='mydomain.tld:443:127.0.0.1' \
  --timeout=5 \
  --proxy=proxy.mydomain.tld:8080 \
  --http-auth=myuser:secretPassword123 \
  --user-agent="My User-Agent String" \
  --extra-columns="DOM,X-Cache(10),Title(40),Keywords(50),Description(50>),Heading1=xpath://h1/text()(20>),ProductPrice=regexp:/Price:\s*\$?(\d+(?:\.\d{2})?)/i#1(10)" \
  --accept-encoding="gzip, deflate" \
  --url-column-size=100 \
  --max-queue-length=3000 \
  --max-visited-urls=10000 \
  --max-url-length=5000 \
  --max-non200-responses-per-basename=10 \
  --include-regex="/^.*\/technologies.*/" \
  --include-regex="/^.*\/fashion.*/" \
  --ignore-regex="/^.*\/downloads\/.*\.pdf$/i" \
  --analyzer-filter-regex="/^.*$/i" \
  --remove-query-params \
  --add-random-query-params \
  --transform-url="live-site.com -> local-site.local" \
  --transform-url="/cdn\.live-site\.com/ -> local-site.local/cdn" \
  --show-scheme-and-host \
  --do-not-truncate-url \
  --output-html-report=tmp/myreport.html \
  --html-report-options="summary,seo-opengraph,visited-urls,security,redirects" \
  --output-json-file=/dir/report.json \
  --output-text-file=/dir/report.txt \
  --add-timestamp-to-output-file \
  --add-host-to-output-file \
  --offline-export-dir=tmp/mydomain.tld \
  --replace-content='/<foo[^>]+>/ -> <bar>' \
  --ignore-store-file-error \
  --sitemap-xml-file==/dir/sitemap.xml \
  --sitemap-txt-file==/dir/sitemap.txt \
  --sitemap-base-priority=0.5 \
  --sitemap-priority-increase=0.1 \
  --markdown-export-dir=tmp/mydomain.tld.md \
  --markdown-export-single-file=tmp/mydomain.tld.combined.md \
  --markdown-move-content-before-h1-to-end \
  --markdown-disable-images \
  --markdown-disable-files \
  --markdown-remove-links-and-images-from-single-file \
  --markdown-exclude-selector='.exclude-me' \
  --markdown-replace-content='/<foo[^>]+>/ -> <bar>' \
  --markdown-replace-query-string='/[a-z]+=[^&]*(&|$)/i -> $1__$2' \
  --mail-to=your.name@my-mail.tld \
  --mail-to=your.friend.name@my-mail.tld \
  --mail-from=crawler@ymy-mail.tld \
  --mail-from-name="SiteOne Crawler" \
  --mail-subject-template="Crawler Report for %domain% (%date%)" \
  --mail-smtp-host=smtp.my-mail.tld \
  --mail-smtp-port=25 \
  --mail-smtp-user=smtp.user \
  --mail-smtp-pass=secretPassword123

For a clearer list, I recommend going to the documentation: 🌐 https://crawler.siteone.io/configuration/command-line-options/

Parameter Description --url=<url> Required. HTTP or HTTPS URL address of the website or sitemap xml to be crawled.
Use quotation marks '' if the URL contains query parameters. --single-page Load only one page to which the URL is given (and its assets), but do not follow other pages. --max-depth=<int> Maximum crawling depth (for pages, not assets). Default is 0 (no limit). 1 means /about
or /about/, 2 means /about/contacts etc. --device=<val> Device type for choosing a predefined User-Agent. Ignored when --user-agent is defined.
Supported values: desktop, mobile, tablet. Defaults is desktop. --user-agent=<val> Custom User-Agent header. Use quotation marks. If specified, it takes precedence over
the device parameter. If you add ! at the end, the siteone-crawler/version will not be
added as a signature at the end of the final user-agent. --timeout=<int> Request timeout in seconds. Default is 3. --proxy=<host:port> HTTP proxy to use in host:port format. Host can be hostname, IPv4 or IPv6. --http-auth=<user:pass> Basic HTTP authentication in username:password format. Parameter Description --output=<val> Output type. Supported values: text, json. Default is text. --extra-columns=<values> Comma delimited list of extra columns added to output table. You can specify HTTP headers
(e.g. X-Cache), predefined values (Title, Keywords, Description, DOM), or custom
extraction from text files (HTML, JS, CSS, TXT, JSON, XML, etc.) using XPath or regexp.
For custom extraction, use the format Custom_column_name=method:pattern#group(length), where
method is xpath or regexp, pattern is the extraction pattern, an optional #group specifies the
capturing group (or node index for XPath) to return (defaulting to the entire match or first node), and an
optional (length) sets the maximum output length (append > to disable truncation).
For example, use Heading1=xpath://h1/text()(20>) to extract the text of the first H1 element
from the HTML document, and ProductPrice=regexp:/Price:\s*\$?(\d+(?:\.\d{2})?)/i#1(10)
to extract a numeric price (e.g., "29.99") from a string like "Price: $29.99". --url-column-size=<num> Basic URL column width. By default, it is calculated from the size of your terminal window. --rows-limit=<num> Max. number of rows to display in tables with analysis results (protection against very long and slow report).
Default is 200. --timezone=<val> Timezone for datetimes in HTML reports and timestamps in output folders/files, e.g. Europe/Prague.
Default is UTC. Available values can be found at Timezones Documentation. --do-not-truncate-url In the text output, long URLs are truncated by default to --url-column-size so the table does not
wrap due to long URLs. With this option, you can turn off the truncation. --show-scheme-and-host On text output, show scheme and host also for origin domain URLs. --hide-progress-bar Hide progress bar visible in text and JSON output for more compact view. --no-color Disable colored output. --force-color Force colored output regardless of support detection. --show-inline-criticals Show criticals from the analyzer directly in the URL table. --show-inline-warnings Show warnings from the analyzer directly in the URL table. Parameter Description --disable-all-assets Disables crawling of all assets and files and only crawls pages in href attributes.
Shortcut for calling all other --disable-* flags. --disable-javascript Disables JavaScript downloading and removes all JavaScript code from HTML,
including onclick and other on* handlers. --disable-styles Disables CSS file downloading and at the same time removes all style definitions
by <style> tag or inline by style attributes. --disable-fonts Disables font downloading and also removes all font/font-face definitions from CSS. --disable-images Disables downloading of all images and replaces found images in HTML with placeholder image only. --disable-files Disables downloading of any files (typically downloadable documents) to which various links point. --remove-all-anchor-listeners On all links on the page remove any event listeners. Useful on some types of sites with modern
JS frameworks that would like to compose content dynamically (React, Svelte, Vue, Angular, etc.). Advanced crawler settings Parameter Description --workers=<int> Maximum number of concurrent workers (threads).
Crawler will not make more simultaneous requests to the server than this number.
Use carefully! A high number of workers can cause a DoS attack. Default is 3. --max-reqs-per-sec=<val> Max requests/s for whole crawler. Be careful not to cause a DoS attack. Default value is 10. --memory-limit=<size> Memory limit in units M (Megabytes) or G (Gigabytes). Default is 2048M. --resolve=<host:port:ip> Custom DNS resolution in domain:port:ip format. Same as curl --resolve.
Can be specified multiple times for multiple domain:port pairs.
Example: --resolve='mydomain.tld:443:127.0.0.1 --allowed-domain-for-external-files=<domain> Primarily, the crawler crawls only the URL within the domain for initial URL. This allows
you to enable loading of file content from another domain as well (e.g. if you want to
load assets from a CDN). Can be specified multiple times. Use can use domains with wildcard *. --allowed-domain-for-crawling=<domain> This option will allow you to crawl all content from other listed domains - typically in the case
of language mutations on other domains. Can be specified multiple times.
Use can use domains with wildcard * including e.g. *.siteone.*. --single-foreign-page If crawling of other domains is allowed (using --allowed-domain-for-crawling),
it ensures that when another domain is not on same second-level domain, only that linked page
and its assets are crawled from that foreign domain. --include-regex=<regex> Regular expression compatible with PHP preg_match() for URLs that should be included.
Argument can be specified multiple times. Example: --include-regex='/^\/public\//' --ignore-regex=<regex> Regular expression compatible with PHP preg_match() for URLs that should be ignored.
Argument can be specified multiple times.
Example: --ignore-regex='/^.*\/downloads\/.*\.pdf$/i' --regex-filtering-only-for-pages Set if you want filtering by *-regex rules apply only to page URLs, but static assets (JS, CSS, images,
fonts, documents) have to be loaded regardless of filtering.
Useful where you want to filter only /sub-pages/ by --include-regex='/\/sub-pages\//', but
assets have to be loaded from any URLs. --analyzer-filter-regex Regular expression compatible with PHP preg_match() applied to Analyzer class names
for analyzers filtering.
Example: /(content|accessibility)/i or /^(?:(?!best|access).)*$/i for all
analyzers except BestPracticesAnalyzer and AccessibilityAnalyzer. --accept-encoding=<val> Custom Accept-Encoding request header. Default is gzip, deflate, br. --remove-query-params Remove query parameters from found URLs. Useful on websites where a lot of links
are made to the same pages, only with different irrelevant query parameters. --add-random-query-params Adds several random query parameters to each URL.
With this, it is possible to bypass certain forms of server and CDN caches. --transform-url=<from->to> Transform URLs before crawling. Use from -> to format for simple replacement or /regex/ -> replacement for pattern matching.
Useful when archiving sites that reference different domains.
Example: --transform-url="live-site.com -> local-site.local".
Can be specified multiple times. --ignore-robots-txt Should robots.txt content be ignored? Useful for crawling an otherwise internal/private/unindexed site. --http-cache-dir=<dir> Cache dir for HTTP responses. You can disable cache by --http-cache-dir='off'.
Default values is tmp/http-client-cache. --http-cache-compression Enable compression for HTTP cache storage. Saves disk space, but uses more CPU. --max-queue-length=<num> The maximum length of the waiting URL queue. Increase in case of large websites,
but expect higher memory requirements. Default is 9000. --max-visited-urls=<num> The maximum number of the visited URLs. Increase in case of large websites, but expect
higher memory requirements. Default is 10000. --max-skipped-urls=<num> The maximum number of the skipped URLs. Increase in case of large websites, but expect
higher memory requirements. Default is 10000. --max-url-length=<num> The maximum supported URL length in chars. Increase in case of very long URLs, but expect
higher memory requirements. Default is 2083. --max-non200-responses-per-basename=<num> Protection against looping with dynamic non-200 URLs. If a basename (the last part of the URL
after the last slash) has more non-200 responses than this limit, other URLs with same basename
will be ignored/skipped. Default is 5. Parameter Description --output-html-report=<file> Save HTML report into that file. Set to empty '' to disable HTML report.
By default saved into tmp/%domain%.report.%datetime%.html. --html-report-options=<sections> Comma-separated list of sections to include in HTML report.
Available sections: summary, seo-opengraph, image-gallery, video-gallery, visited-urls, dns-ssl, crawler-stats, crawler-info, headers, content-types, skipped-urls, caching, best-practices, accessibility, security, redirects, 404-pages, slowest-urls, fastest-urls, source-domains.
Default: all sections. --output-json-file=<file> File path for JSON output. Set to empty '' to disable JSON file.
By default saved into tmp/%domain%.output.%datetime%.json.
See JSON Output Documentation for format details. --output-text-file=<file> File path for TXT output. Set to empty '' to disable TXT file.
By default saved into tmp/%domain%.output.%datetime%.txt.
See Text Output Documentation for format details. Parameter Description --mail-to=<email> Recipients of HTML e-mail reports. Optional but required for mailer activation.
You can specify multiple emails separated by comma. --mail-from=<email> E-mail sender address. Default values is siteone-crawler@your-hostname.com. --mail-from-name=<val> E-mail sender name. Default values is SiteOne Crawler. --mail-subject-template=<val> E-mail subject template. You can use dynamic variables %domain%, %date% and %datetime%.
Default values is Crawler Report for %domain% (%date%). --mail-smtp-host=<host> SMTP host for sending emails. Default is localhost. --mail-smtp-port=<port> SMTP port for sending emails. Default is 25. --mail-smtp-user=<user> SMTP user, if your SMTP server requires authentication. --mail-smtp-pass=<pass> SMTP password, if your SMTP server requires authentication. Parameter Description --upload Enable HTML report upload to --upload-to. --upload-to=<url> URL of the endpoint where to send the HTML report. Default value is https://crawler.siteone.io/up. --upload-retention=<val> How long should the HTML report be kept in the online version?
Values: 1h / 4h / 12h / 24h / 3d / 7d / 30d / 365d / forever.
Default value is 30d. --upload-password=<val> Optional password, which must be entered (the user will be 'crawler')
to display the online HTML report. --upload-timeout=<int> Upload timeout in seconds. Default value is 3600. Parameter Description --offline-export-dir=<dir> Path to directory where to save the offline version of the website. If target directory
does not exist, crawler will try to create it (requires sufficient rights). --offline-export-store-only-url-regex=<regex> For debug - when filled it will activate debug mode and store only URLs
which match one of these PCRE regexes. Can be specified multiple times. --offline-export-remove-unwanted-code=<1/0> Remove unwanted code for offline mode? Typically, JS of the analytics, social networks,
cookie consent, cross origins, etc. Default values is 1. --offline-export-no-auto-redirect-html Disables the automatic creation of redirect HTML files for each subfolder that contains
an index.html. This solves situations for URLs where sometimes the URL ends with a slash,
sometimes it doesn't. --replace-content=<val> Replace content in HTML/JS/CSS with foo -> bar or regexp in PREG format,
e.g. /card[0-9]/i -> card. Can be specified multiple times. --replace-query-string=<val> Instead of using a short hash instead of a query string in the filename, just replace some characters.
You can use simple format foo -> bar or regexp in PREG format,
e.g. `'/([a-z]+)=([^&]*)(& --ignore-store-file-error Enable this option to ignore any file storing errors.
The export process will continue. Markdown exporter options Parameter Description --markdown-export-dir=<dir> Path to directory where to save the markdown version of the website.
Directory will be created if it doesn't exist. --markdown-export-single-file=<file> Path to a file where to save the combined markdown files into one document. Requires --markdown-export-dir to be set. Ideal for AI tools that need to process the entire website content in one go. --markdown-move-content-before-h1-to-end Move all content before the main H1 heading (typically the header with the menu) to the end of the markdown. --markdown-disable-images Do not export and show images in markdown files.
Images are enabled by default. --markdown-disable-files Do not export and link files other than HTML/CSS/JS/fonts/images - eg. PDF, ZIP, etc.
These files are enabled by default. --markdown-remove-links-and-images-from-single-file Remove links and images from the combined single markdown file. Useful for AI tools that don't need these elements.
Requires --markdown-export-single-file to be set. --markdown-exclude-selector=<val> Exclude some page content (DOM elements) from markdown export defined by CSS selectors like 'header', '.header', '#header', etc.
Can be specified multiple times. --markdown-replace-content=<val> Replace text content with foo -> bar or regexp in PREG format: /card[0-9]/i -> card.
Can be specified multiple times. --markdown-replace-query-string=<val> Instead of using a short hash instead of a query string in the filename, just replace some characters.
You can use simple format 'foo -> bar' or regexp in PREG format, e.g.
`'/([a-z]+)=([^&]*)(& --markdown-export-store-only-url-regex=<regex> For debug - when filled it will activate debug mode and store only URLs which match one of these
PCRE regexes.
Can be specified multiple times. --markdown-ignore-store-file-error Ignores any file storing errors. The export process will continue. Parameter Description --sitemap-xml-file=<file> File path where generated XML Sitemap will be saved.
Extension .xml is automatically added if not specified. --sitemap-txt-file=<file> File path where generated TXT Sitemap will be saved.
Extension .txt is automatically added if not specified. --sitemap-base-priority=<num> Base priority for XML sitemap. Default values is 0.5. --sitemap-priority-increase=<num> Priority increase value based on slashes count in the URL. Default values is 0.1. Parameter Description --debug Activate debug mode. --debug-log-file=<file> Log file where to save debug messages. When --debug is not set and --debug-log-file
is set, logging will be active without visible output. --debug-url-regex=<regex> Regex for URL(s) to debug. When crawled URL is matched, parsing, URL replacing,
and other actions are printed to output. Can be specified multiple times. --result-storage=<val> Result storage type for content and headers. Values: memory or file.
Use file for large websites. Default values is memory. --result-storage-dir=<dir> Directory for --result-storage=file. Default values is tmp/result-storage. --result-storage-compression Enable compression for results storage. Saves disk space, but uses more CPU. --http-cache-dir=<dir> Cache dir for HTTP responses. You can disable cache by --http-cache-dir='off'.
Default values is tmp/http-client-cache. --http-cache-compression Enable compression for HTTP cache storage.
Saves disk space, but uses more CPU. --websocket-server=<host:port> Start crawler with websocket server on given host:port, e.g. 0.0.0.0:8000.
To connected clients will be sent this message after each URL is crawled:
{"type":"urlResult","url":"...","statusCode":200,"size":4528,"execTime":0.823}. --console-width=<int> Enforce a fixed console width, disabling automatic detection. Parameter Description --fastest-urls-top-limit=<int> Number of URLs in TOP fastest list. Default is 20. --fastest-urls-max-time=<val> Maximum response time for an URL to be considered fast. Default is 1. SEO and OpenGraph analyzer Parameter Description --max-heading-level=<int> Max heading level from 1 to 6 for analysis. Default is 3. Parameter Description --slowest-urls-top-limit=<int> Number of URLs in TOP slowest list. Default is 20. --slowest-urls-min-time=<val> Minimum response time threshold for slow URLs. Default is 0.01. --slowest-urls-max-time=<val> Maximum response time for an URL to be considered very slow.
Default is 3.

To understand the richness of the data provided by the crawler, you can examine real output examples generated from crawling crawler.siteone.io:

These examples showcase the various tables and metrics generated, demonstrating the tool's capabilities in analyzing website structure, performance, SEO, security, and more.

If you have any suggestions or feature requests, please open an issue on GitHub. We'd love to hear from you!

Your contributions with realized improvements, bug fixes, and new features are welcome. Please open a pull request :-)

πŸ€” Motivation to create this tool

If you are interested in the author's motivation for creating this tool, read it on the project website 🌐.

Please use responsibly and ensure that you have the necessary permissions when crawling websites. Some sites may have rules against automated access detailed in their robots.txt.

The author is not responsible for any consequences caused by inappropriate use or deliberate misuse of this tool.

This work is licensed under a license.


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4