<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
<title>CodeGraphContext Docker Deployment Checklist - CodeGraphContext</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="purple">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#codegraphcontext-docker-deployment-checklist" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="CodeGraphContext" class="md-header__button md-logo" aria-label="CodeGraphContext" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
CodeGraphContext
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
CodeGraphContext Docker Deployment Checklist
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="purple" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="teal" data-md-color-accent="lime" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/CodeGraphContext/CodeGraphContext" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
CodeGraphContext/CodeGraphContext
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../../getting-started/prerequisites/" class="md-tabs__link">
Getting Started
</a>
</li>
<li class="md-tabs__item">
<a href="../../use_cases_detailed/" class="md-tabs__link">
Usage
</a>
</li>
<li class="md-tabs__item">
<a href="../../guides/setup_deep_dive/" class="md-tabs__link">
Guides
</a>
</li>
<li class="md-tabs__item">
<a href="../../concepts/how_it_works/" class="md-tabs__link">
Core Concepts
</a>
</li>
<li class="md-tabs__item">
<a href="../../reference/cli_master/" class="md-tabs__link">
CLI Reference
</a>
</li>
<li class="md-tabs__item">
<a href="../../reference/mcp_master/" class="md-tabs__link">
MCP Reference
</a>
</li>
<li class="md-tabs__item">
<a href="../../roadmap/" class="md-tabs__link">
Project Info
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="CodeGraphContext" class="md-nav__button md-logo" aria-label="CodeGraphContext" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
CodeGraphContext
</label>
<div class="md-nav__source">
<a href="https://github.com/CodeGraphContext/CodeGraphContext" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
CodeGraphContext/CodeGraphContext
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../getting-started/prerequisites/" class="md-nav__link">
<span class="md-ellipsis">
Prerequisites & Context
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/installation/" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/quickstart/" class="md-nav__link">
<span class="md-ellipsis">
Quickstart (5 min)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Usage
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Usage
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../use_cases_detailed/" class="md-nav__link">
<span class="md-ellipsis">
Real-World Scenarios (ROI)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../user_journeys/" class="md-nav__link">
<span class="md-ellipsis">
User Journeys (Stories)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../integration_guide/" class="md-nav__link">
<span class="md-ellipsis">
Integration & Workflows
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../guides/setup_deep_dive/" class="md-nav__link">
<span class="md-ellipsis">
Neo4j Setup Wizard
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/mcp_guide/" class="md-nav__link">
<span class="md-ellipsis">
MCP Setup Wizard
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/visualization/" class="md-nav__link">
<span class="md-ellipsis">
Visualizing the Graph
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/bundles/" class="md-nav__link">
<span class="md-ellipsis">
Using On-Demand Bundles
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../guides/ci_cd/" class="md-nav__link">
<span class="md-ellipsis">
CI/CD & Advanced
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Core Concepts
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Core Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../concepts/how_it_works/" class="md-nav__link">
<span class="md-ellipsis">
How it Works
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../architecture/" class="md-nav__link">
<span class="md-ellipsis">
System Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../concepts/the_graph/" class="md-nav__link">
<span class="md-ellipsis">
The Graph Model
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../concepts/modes/" class="md-nav__link">
<span class="md-ellipsis">
CLI vs MCP Modes
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
CLI Reference
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
CLI Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../reference/cli_master/" class="md-nav__link">
<span class="md-ellipsis">
All Commands (Master List)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../reference/cli_indexing/" class="md-nav__link">
<span class="md-ellipsis">
Indexing & Management
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../reference/cli_analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis & Querying
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../reference/cli_system/" class="md-nav__link">
<span class="md-ellipsis">
System & Config
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
MCP Reference
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
MCP Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../reference/mcp_master/" class="md-nav__link">
<span class="md-ellipsis">
All Tools (Master List)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../cookbook/" class="md-nav__link">
<span class="md-ellipsis">
Example Cookbook
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
<span class="md-ellipsis">
Project Info
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
Project Info
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../roadmap/" class="md-nav__link">
<span class="md-ellipsis">
Roadmap
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../contributing/" class="md-nav__link">
<span class="md-ellipsis">
Contributing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../license/" class="md-nav__link">
<span class="md-ellipsis">
License
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../reference/configuration/" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../reference/cgcignore/" class="md-nav__link">
<span class="md-ellipsis">
.cgcignore Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../reference/troubleshooting/" class="md-nav__link">
<span class="md-ellipsis">
Troubleshooting
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#pre-deployment" class="md-nav__link">
<span class="md-ellipsis">
π Pre-Deployment
</span>
</a>
<nav class="md-nav" aria-label="π Pre-Deployment">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#local-testing" class="md-nav__link">
<span class="md-ellipsis">
Local Testing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#code-preparation" class="md-nav__link">
<span class="md-ellipsis">
Code Preparation
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#infrastructure-setup" class="md-nav__link">
<span class="md-ellipsis">
ποΈ Infrastructure Setup
</span>
</a>
<nav class="md-nav" aria-label="ποΈ Infrastructure Setup">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#choose-hosting-option" class="md-nav__link">
<span class="md-ellipsis">
Choose Hosting Option
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-cloud-vm-deployment" class="md-nav__link">
<span class="md-ellipsis">
For Cloud VM Deployment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-container-platform-gcpawsazure" class="md-nav__link">
<span class="md-ellipsis">
For Container Platform (GCP/AWS/Azure)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#for-kubernetes" class="md-nav__link">
<span class="md-ellipsis">
For Kubernetes
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#security-configuration" class="md-nav__link">
<span class="md-ellipsis">
π Security Configuration
</span>
</a>
<nav class="md-nav" aria-label="π Security Configuration">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#secrets-management" class="md-nav__link">
<span class="md-ellipsis">
Secrets Management
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#network-security" class="md-nav__link">
<span class="md-ellipsis">
Network Security
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#access-control" class="md-nav__link">
<span class="md-ellipsis">
Access Control
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#deployment" class="md-nav__link">
<span class="md-ellipsis">
π Deployment
</span>
</a>
<nav class="md-nav" aria-label="π Deployment">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#build-and-deploy" class="md-nav__link">
<span class="md-ellipsis">
Build and Deploy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#database-setup" class="md-nav__link">
<span class="md-ellipsis">
Database Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#application-verification" class="md-nav__link">
<span class="md-ellipsis">
Application Verification
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#monitoring-maintenance" class="md-nav__link">
<span class="md-ellipsis">
π Monitoring & Maintenance
</span>
</a>
<nav class="md-nav" aria-label="π Monitoring & Maintenance">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#logging" class="md-nav__link">
<span class="md-ellipsis">
Logging
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#monitoring" class="md-nav__link">
<span class="md-ellipsis">
Monitoring
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#backups" class="md-nav__link">
<span class="md-ellipsis">
Backups
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#updates" class="md-nav__link">
<span class="md-ellipsis">
Updates
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#performance-optimization" class="md-nav__link">
<span class="md-ellipsis">
π Performance Optimization
</span>
</a>
<nav class="md-nav" aria-label="π Performance Optimization">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#resource-allocation" class="md-nav__link">
<span class="md-ellipsis">
Resource Allocation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#database-optimization" class="md-nav__link">
<span class="md-ellipsis">
Database Optimization
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#application-optimization" class="md-nav__link">
<span class="md-ellipsis">
Application Optimization
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#testing" class="md-nav__link">
<span class="md-ellipsis">
π§ͺ Testing
</span>
</a>
<nav class="md-nav" aria-label="π§ͺ Testing">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#functional-testing" class="md-nav__link">
<span class="md-ellipsis">
Functional Testing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#performance-testing" class="md-nav__link">
<span class="md-ellipsis">
Performance Testing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#disaster-recovery" class="md-nav__link">
<span class="md-ellipsis">
Disaster Recovery
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#documentation" class="md-nav__link">
<span class="md-ellipsis">
π Documentation
</span>
</a>
<nav class="md-nav" aria-label="π Documentation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#deployment-documentation" class="md-nav__link">
<span class="md-ellipsis">
Deployment Documentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#operational-documentation" class="md-nav__link">
<span class="md-ellipsis">
Operational Documentation
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-deployment" class="md-nav__link">
<span class="md-ellipsis">
π― Post-Deployment
</span>
</a>
<nav class="md-nav" aria-label="π― Post-Deployment">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#immediate-first-24-hours" class="md-nav__link">
<span class="md-ellipsis">
Immediate (First 24 Hours)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#first-week" class="md-nav__link">
<span class="md-ellipsis">
First Week
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#ongoing" class="md-nav__link">
<span class="md-ellipsis">
Ongoing
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#emergency-contacts" class="md-nav__link">
<span class="md-ellipsis">
π Emergency Contacts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#support-resources" class="md-nav__link">
<span class="md-ellipsis">
π Support Resources
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#final-sign-off" class="md-nav__link">
<span class="md-ellipsis">
β
Final Sign-Off
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="codegraphcontext-docker-deployment-checklist">CodeGraphContext Docker Deployment Checklist</h1>
<p>Use this checklist to ensure a successful deployment.</p>
<h2 id="pre-deployment">π Pre-Deployment</h2>
<h3 id="local-testing">Local Testing</h3>
<ul>
<li>[ ] Docker and Docker Compose installed</li>
<li>[ ] Run <code>./docker-quickstart.sh</code> successfully</li>
<li>[ ] Test basic cgc commands inside container</li>
<li>[ ] Verify FalkorDB Lite works (default)</li>
<li>[ ] Test Neo4j connection (if using)</li>
<li>[ ] Index a sample project</li>
<li>[ ] Verify data persists after container restart</li>
</ul>
<h3 id="code-preparation">Code Preparation</h3>
<ul>
<li>[ ] Latest code committed to Git</li>
<li>[ ] All tests passing</li>
<li>[ ] Documentation updated</li>
<li>[ ] <code>.cgcignore</code> configured properly</li>
<li>[ ] Environment variables documented</li>
</ul>
<h2 id="infrastructure-setup">ποΈ Infrastructure Setup</h2>
<h3 id="choose-hosting-option">Choose Hosting Option</h3>
<ul>
<li>[ ] Selected hosting provider (VM/Container Platform/Kubernetes)</li>
<li>[ ] Account created and billing configured</li>
<li>[ ] Region/zone selected (choose closest to users)</li>
<li>[ ] Resource sizing determined (see DOCKER_SUMMARY.md)</li>
</ul>
<h3 id="for-cloud-vm-deployment">For Cloud VM Deployment</h3>
<ul>
<li>[ ] VM provisioned (Ubuntu 22.04+ recommended)</li>
<li>[ ] SSH access configured</li>
<li>[ ] Firewall rules configured</li>
<li>[ ] Port 22 (SSH) - Your IP only</li>
<li>[ ] Port 7474 (Neo4j HTTP) - Optional, secure</li>
<li>[ ] Port 7687 (Neo4j Bolt) - Optional, secure</li>
<li>[ ] Docker installed on VM</li>
<li>[ ] Docker Compose installed on VM</li>
</ul>
<h3 id="for-container-platform-gcpawsazure">For Container Platform (GCP/AWS/Azure)</h3>
<ul>
<li>[ ] Container registry access configured</li>
<li>[ ] Image pushed to registry</li>
<li>[ ] Service/task definition created</li>
<li>[ ] Environment variables configured</li>
<li>[ ] Persistent storage configured</li>
</ul>
<h3 id="for-kubernetes">For Kubernetes</h3>
<ul>
<li>[ ] Cluster created and accessible</li>
<li>[ ] kubectl configured</li>
<li>[ ] Namespace created</li>
<li>[ ] Storage class available</li>
<li>[ ] Ingress controller configured (if needed)</li>
</ul>
<h2 id="security-configuration">π Security Configuration</h2>
<h3 id="secrets-management">Secrets Management</h3>
<ul>
<li>[ ] Changed default Neo4j password</li>
<li>[ ] Secrets stored securely (not in git)</li>
<li>[ ] Environment variables configured</li>
<li>[ ] <code>.env</code> file created (if needed)</li>
<li>[ ] Credentials documented securely</li>
</ul>
<h3 id="network-security">Network Security</h3>
<ul>
<li>[ ] Firewall rules configured</li>
<li>[ ] Security groups configured (cloud)</li>
<li>[ ] VPN configured (if needed)</li>
<li>[ ] HTTPS/TLS configured (production)</li>
<li>[ ] Rate limiting configured (if applicable)</li>
</ul>
<h3 id="access-control">Access Control</h3>
<ul>
<li>[ ] SSH key-based authentication only</li>
<li>[ ] Sudo access restricted</li>
<li>[ ] Docker socket secured</li>
<li>[ ] Database authentication enabled</li>
<li>[ ] Backup access secured</li>
</ul>
<h2 id="deployment">π Deployment</h2>
<h3 id="build-and-deploy">Build and Deploy</h3>
<ul>
<li>[ ] Image built successfully
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>build<span class="w"> </span>-t<span class="w"> </span>codegraphcontext:latest<span class="w"> </span>.
</code></pre></div></li>
<li>[ ] Image tagged properly</li>
<li>[ ] Image pushed to registry (if using)</li>
<li>[ ] Containers started
<div class="highlight"><pre><span></span><code>docker-compose<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div></li>
<li>[ ] Health checks passing</li>
<li>[ ] Logs reviewed for errors</li>
</ul>
<h3 id="database-setup">Database Setup</h3>
<ul>
<li>[ ] Database service running</li>
<li>[ ] Database accessible from app</li>
<li>[ ] Schema created (automatic)</li>
<li>[ ] Test query executed successfully</li>
<li>[ ] Backup configured</li>
</ul>
<h3 id="application-verification">Application Verification</h3>
<ul>
<li>[ ] Container running
<div class="highlight"><pre><span></span><code>docker-compose<span class="w"> </span>ps
</code></pre></div></li>
<li>[ ] cgc command accessible
<div class="highlight"><pre><span></span><code>docker-compose<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>codegraphcontext<span class="w"> </span>cgc<span class="w"> </span>--version
</code></pre></div></li>
<li>[ ] Can index test project</li>
<li>[ ] Can query indexed data</li>
<li>[ ] MCP server starts (if using)</li>
</ul>
<h2 id="monitoring-maintenance">π Monitoring & Maintenance</h2>
<h3 id="logging">Logging</h3>
<ul>
<li>[ ] Log aggregation configured</li>
<li>[ ] Log retention policy set</li>
<li>[ ] Error alerting configured</li>
<li>[ ] Log rotation enabled</li>
</ul>
<h3 id="monitoring">Monitoring</h3>
<ul>
<li>[ ] Resource monitoring enabled (CPU, RAM, Disk)</li>
<li>[ ] Container health monitoring</li>
<li>[ ] Database monitoring</li>
<li>[ ] Uptime monitoring</li>
<li>[ ] Alert thresholds configured</li>
</ul>
<h3 id="backups">Backups</h3>
<ul>
<li>[ ] Backup strategy defined</li>
<li>[ ] Automated backups configured
<div class="highlight"><pre><span></span><code><span class="c1"># Example backup script</span>
docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>-v<span class="w"> </span>cgc-data:/data<span class="w"> </span>-v<span class="w"> </span><span class="k">$(</span><span class="nb">pwd</span><span class="k">)</span>:/backup<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>alpine<span class="w"> </span>tar<span class="w"> </span>czf<span class="w"> </span>/backup/cgc-backup-<span class="k">$(</span>date<span class="w"> </span>+%Y%m%d<span class="k">)</span>.tar.gz<span class="w"> </span>/data
</code></pre></div></li>
<li>[ ] Backup restoration tested</li>
<li>[ ] Backup retention policy set</li>
<li>[ ] Off-site backup configured</li>
</ul>
<h3 id="updates">Updates</h3>
<ul>
<li>[ ] Update schedule defined</li>
<li>[ ] Update process documented</li>
<li>[ ] Rollback procedure documented</li>
<li>[ ] Automated updates configured (optional)</li>
</ul>
<h2 id="performance-optimization">π Performance Optimization</h2>
<h3 id="resource-allocation">Resource Allocation</h3>
<ul>
<li>[ ] CPU limits set appropriately</li>
<li>[ ] Memory limits set appropriately</li>
<li>[ ] Storage size adequate</li>
<li>[ ] Swap configured (if needed)</li>
</ul>
<h3 id="database-optimization">Database Optimization</h3>
<ul>
<li>[ ] Indexes created (automatic)</li>
<li>[ ] Query performance tested</li>
<li>[ ] Connection pooling configured</li>
<li>[ ] Cache configured (if applicable)</li>
</ul>
<h3 id="application-optimization">Application Optimization</h3>
<ul>
<li>[ ] <code>.cgcignore</code> optimized</li>
<li>[ ] Batch processing configured</li>
<li>[ ] Concurrent processing tuned</li>
<li>[ ] Resource limits tested under load</li>
</ul>
<h2 id="testing">π§ͺ Testing</h2>
<h3 id="functional-testing">Functional Testing</h3>
<ul>
<li>[ ] Index operation works</li>
<li>[ ] Query operations work</li>
<li>[ ] Watch functionality works</li>
<li>[ ] MCP server works (if using)</li>
<li>[ ] All CLI commands tested</li>
</ul>
<h3 id="performance-testing">Performance Testing</h3>
<ul>
<li>[ ] Indexing large codebase tested</li>
<li>[ ] Query performance acceptable</li>
<li>[ ] Memory usage acceptable</li>
<li>[ ] Disk usage acceptable</li>
</ul>
<h3 id="disaster-recovery">Disaster Recovery</h3>
<ul>
<li>[ ] Backup restoration tested</li>
<li>[ ] Container restart tested</li>
<li>[ ] Database failover tested (if applicable)</li>
<li>[ ] Data persistence verified</li>
</ul>
<h2 id="documentation">π Documentation</h2>
<h3 id="deployment-documentation">Deployment Documentation</h3>
<ul>
<li>[ ] Deployment steps documented</li>
<li>[ ] Configuration documented</li>
<li>[ ] Credentials documented (securely)</li>
<li>[ ] Architecture diagram created</li>
<li>[ ] Runbook created</li>
</ul>
<h3 id="operational-documentation">Operational Documentation</h3>
<ul>
<li>[ ] Common operations documented</li>
<li>[ ] Troubleshooting guide created</li>
<li>[ ] Escalation procedures defined</li>
<li>[ ] On-call procedures defined (if applicable)</li>
</ul>
<h2 id="post-deployment">π― Post-Deployment</h2>
<h3 id="immediate-first-24-hours">Immediate (First 24 Hours)</h3>
<ul>
<li>[ ] Monitor logs continuously</li>
<li>[ ] Check resource usage</li>
<li>[ ] Verify all functionality</li>
<li>[ ] Test backup/restore</li>
<li>[ ] Document any issues</li>
</ul>
<h3 id="first-week">First Week</h3>
<ul>
<li>[ ] Review performance metrics</li>
<li>[ ] Optimize resource allocation</li>
<li>[ ] Fine-tune monitoring alerts</li>
<li>[ ] Update documentation</li>
<li>[ ] Train team members</li>
</ul>
<h3 id="ongoing">Ongoing</h3>
<ul>
<li>[ ] Weekly log review</li>
<li>[ ] Monthly security updates</li>
<li>[ ] Quarterly disaster recovery test</li>
<li>[ ] Regular performance reviews</li>
<li>[ ] Continuous improvement</li>
</ul>
<h2 id="emergency-contacts">π Emergency Contacts</h2>
<p>Document your emergency contacts:</p>
<ul>
<li>[ ] Cloud provider support: <strong><em>_</em></strong><strong><em>_</em></strong>_</li>
<li>[ ] Database administrator: <strong><em>_</em></strong><strong><em>_</em></strong>_</li>
<li>[ ] DevOps team: <strong><em>_</em></strong><strong><em>_</em></strong>_</li>
<li>[ ] Security team: <strong><em>_</em></strong><strong><em>_</em></strong>_</li>
<li>[ ] On-call rotation: <strong><em>_</em></strong><strong><em>_</em></strong>_</li>
</ul>
<h2 id="support-resources">π Support Resources</h2>
<ul>
<li><strong>Documentation:</strong> DOCKER_DEPLOYMENT.md, DOCKER_SUMMARY.md</li>
<li><strong>GitHub Issues:</strong> https://github.com/CodeGraphContext/CodeGraphContext/issues</li>
<li><strong>Discord Community:</strong> https://discord.gg/dR4QY32uYQ</li>
<li><strong>Website:</strong> http://codegraphcontext.vercel.app/</li>
</ul>
<h2 id="final-sign-off">β
Final Sign-Off</h2>
<ul>
<li>[ ] All checklist items completed</li>
<li>[ ] Deployment reviewed by team</li>
<li>[ ] Stakeholders notified</li>
<li>[ ] Documentation handed off</li>
<li>[ ] Monitoring confirmed working</li>
<li>[ ] Backup verified</li>
<li>[ ] Ready for production! π</li>
</ul>
<hr />
<p><strong>Deployment Date:</strong> <strong><em>_</em></strong><strong><em>_</em></strong><em>
<strong>Deployed By:</strong> <strong><em>_</em></strong><strong><em>_</em></strong></em>
<strong>Reviewed By:</strong> <strong><em>_</em></strong><strong><em>_</em></strong><em>
<strong>Production URL:</strong> <strong><em>_</em></strong><strong><em>_</em></strong></em>
<strong>Notes:</strong> <strong><em>_</em></strong><strong><em>_</em></strong>_</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.tabs", "navigation.sections", "navigation.expand", "content.code.copy", "toc.follow"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
</body>
</html>