CINXE.COM

<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/clusterfuzz/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/clusterfuzz/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav > ul.nav-list:first-child > li:not(:nth-child(2)) > a, .site-nav > ul.nav-list:first-child > li > ul > li a { background-image: none; } .site-nav > ul.nav-list:not(:first-child) a, .site-nav li.external a { background-image: none; } .site-nav > ul.nav-list:first-child > li:nth-child(2) > a { font-weight: 600; text-decoration: none; }.site-nav > ul.nav-list:first-child > li:nth-child(2) > button svg { transform: rotate(-90deg); }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(2) > ul.nav-list { display: block; } </style> <script async src="https://www.googletagmanager.com/gtag/js?id=G-DBK55850L0"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-DBK55850L0'); </script> <script src="/clusterfuzz/assets/js/vendor/lunr.min.js"></script> <script src="/clusterfuzz/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" href="/clusterfuzz/favicon.ico" type="image/x-icon">  <title>Getting started | ClusterFuzz</title> <meta name="generator" content="Jekyll v3.10.0" /> <meta property="og:title" content="Getting started" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="Documentation for ClusterFuzz" /> <meta property="og:description" content="Documentation for ClusterFuzz" /> <link rel="canonical" href="/clusterfuzz/getting-started/" /> <meta property="og:url" content="/clusterfuzz/getting-started/" /> <meta property="og:site_name" content="ClusterFuzz" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary" /> <meta property="twitter:title" content="Getting started" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"Documentation for ClusterFuzz","headline":"Getting started","url":"/clusterfuzz/getting-started/"}</script>  </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol>  <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol>  <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-header" role="banner"> <a href="/clusterfuzz/" class="site-title lh-tight"> ClusterFuzz </a> <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in ClusterFuzz category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/clusterfuzz/" class="nav-list-link">ClusterFuzz</a><ul class="nav-list"><li class="nav-list-item"><a href="/clusterfuzz/architecture/" class="nav-list-link">Architecture</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Getting started category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/clusterfuzz/getting-started/" class="nav-list-link">Getting started</a><ul class="nav-list"><li class="nav-list-item"><a href="/clusterfuzz/getting-started/prerequisites/" class="nav-list-link">Prerequisites</a></li><li class="nav-list-item"><a href="/clusterfuzz/getting-started/local-instance/" class="nav-list-link">Running a local instance</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Setting up fuzzing category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/clusterfuzz/setting-up-fuzzing/" class="nav-list-link">Setting up fuzzing</a><ul class="nav-list"><li class="nav-list-item"><a href="/clusterfuzz/setting-up-fuzzing/libfuzzer-and-afl/" class="nav-list-link">libFuzzer and AFL++</a></li><li class="nav-list-item"><a href="/clusterfuzz/setting-up-fuzzing/blackbox-fuzzing/" class="nav-list-link">Blackbox fuzzing</a></li><li class="nav-list-item"><a href="/clusterfuzz/setting-up-fuzzing/heartbleed-example/" class="nav-list-link">Heartbleed example</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Production setup category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/clusterfuzz/production-setup/" class="nav-list-link">Production setup</a><ul class="nav-list"><li class="nav-list-item"><a href="/clusterfuzz/production-setup/clusterfuzz/" class="nav-list-link">ClusterFuzz</a></li><li class="nav-list-item"><a href="/clusterfuzz/production-setup/build-pipeline/" class="nav-list-link">Build pipeline</a></li><li class="nav-list-item"><a href="/clusterfuzz/production-setup/setting-up-fuzzing-job/" class="nav-list-link">Setting up a fuzzing job</a></li><li class="nav-list-item"><a href="/clusterfuzz/production-setup/setting-up-bots/" class="nav-list-link">Setting up bots</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Using ClusterFuzz category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/clusterfuzz/using-clusterfuzz/" class="nav-list-link">Using ClusterFuzz</a><ul class="nav-list"><li class="nav-list-item"><a href="/clusterfuzz/using-clusterfuzz/ui-overview/" class="nav-list-link">UI overview</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Workflows category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/clusterfuzz/using-clusterfuzz/workflows/" class="nav-list-link">Workflows</a><ul class="nav-list"><li class="nav-list-item"><a href="/clusterfuzz/using-clusterfuzz/workflows/triaging-new-crashes/" class="nav-list-link">Triaging new crashes</a></li><li class="nav-list-item"><a href="/clusterfuzz/using-clusterfuzz/workflows/fixing-a-bug/" class="nav-list-link">Fixing a bug</a></li><li class="nav-list-item"><a href="/clusterfuzz/using-clusterfuzz/workflows/analyzing-fuzzing-performance/" class="nav-list-link">Analyzing fuzzer performance</a></li><li class="nav-list-item"><a href="/clusterfuzz/using-clusterfuzz/workflows/uploading-a-testcase/" class="nav-list-link">Uploading a testcase</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Advanced features category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/clusterfuzz/using-clusterfuzz/advanced/" class="nav-list-link">Advanced features</a><ul class="nav-list"><li class="nav-list-item"><a href="/clusterfuzz/using-clusterfuzz/advanced/access-control/" class="nav-list-link">Access control</a></li><li class="nav-list-item"><a href="/clusterfuzz/using-clusterfuzz/advanced/code-coverage/" class="nav-list-link">Code coverage</a></li></ul></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Contributing code category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/clusterfuzz/contributing-code/" class="nav-list-link">Contributing code</a><ul class="nav-list"><li class="nav-list-item"><a href="/clusterfuzz/contributing-code/source-code/" class="nav-list-link">Source code</a></li><li class="nav-list-item"><a href="/clusterfuzz/contributing-code/running-unit-tests/" class="nav-list-link">Running unit tests</a></li><li class="nav-list-item"><a href="/clusterfuzz/contributing-code/staging-changes/" class="nav-list-link">Staging changes</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Reference category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/clusterfuzz/reference/" class="nav-list-link">Reference</a><ul class="nav-list"><li class="nav-list-item"><a href="/clusterfuzz/reference/glossary/" class="nav-list-link">Glossary</a></li><li class="nav-list-item"><a href="/clusterfuzz/reference/coverage-guided-vs-blackbox/" class="nav-list-link">Coverage guided vs blackbox fuzzing</a></li><li class="nav-list-item"><a href="/clusterfuzz/reference/job-definition/" class="nav-list-link">Job definition</a></li><li class="nav-list-item"><a href="/clusterfuzz/reference/faq/" class="nav-list-link">FAQ</a></li></ul></li></ul> </nav> <footer class="site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </footer> </div> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search ClusterFuzz" aria-label="Search ClusterFuzz" autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label> </div> <div id="search-results" class="search-results"></div> </div> <nav aria-label="Auxiliary" class="aux-nav"> <ul class="aux-nav-list"> <li class="aux-nav-list-item"> <a href="https://github.com/google/clusterfuzz" class="site-button" > ClusterFuzz on GitHub </a> </li> </ul> </nav> </div> <div class="main-content-wrap"> <div id="main-content" class="main-content"> <main> <h1 id="getting-started"> <a href="#getting-started" class="anchor-heading" aria-labelledby="getting-started"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Getting started </h1> <p>These pages walk you through the process of setting up ClusterFuzz locally for development and testing purposes.</p> <hr> <h2 class="text-delta">Table of contents</h2> <ul> <li> <a href="/clusterfuzz/getting-started/prerequisites/">Prerequisites</a> </li> <li> <a href="/clusterfuzz/getting-started/local-instance/">Running a local instance</a> </li> </ul> </main> </div> </div> <div class="search-overlay"></div> </div> </body> </html>