Deployed 3c79197 to main with MkDocs 1.6.0 and mike 2.1.3

main/features/DevReadMe/index.html

@@ -2834,30 +2834,35 @@ <h3 id="running-locally">Running Locally<a class="headerlink" href="#running-loc
 <p>For example:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>./scripts/run_docker<span class="w"> </span>start<span class="w"> </span>--inbound-transport<span class="w"> </span>http<span class="w"> </span><span class="m">0</span>.0.0.0<span class="w"> </span><span class="m">10000</span><span class="w"> </span>--outbound-transport<span class="w"> </span>http<span class="w"> </span>--debug<span class="w"> </span>--log-level<span class="w"> </span>DEBUG
 </code></pre></div>
-<p>To enable the <a href="https://github.com/Microsoft/ptvsd">ptvsd</a> Python debugger for Visual Studio/VSCode use the <code>--debug</code> command line parameter.</p>
+<p>To enable the <a href="https://microsoft.github.io/debug-adapter-protocol/">Debug Adapter Protocol</a> using the <a href="https://github.com/microsoft/debugpy/">debugpy implementation for Python 3</a> Python debugger for Visual Studio/VSCode use the <code>--debug</code> command line parameter.</p>
+<p>When debugging an agent running within a docker container, you will need to set the DAP_HOST environment variable (defaults to <code>localhost</code>)  to <code>0.0.0.0</code> to allow forwarding from within your docker container.</p>
+<p>Note that you may still find references to <a href="https://github.com/microsoft/ptvsd">PTVSD</a>, the deprecated implementation of DAP. PTVSD_HOST and PTVSD_PORT are interchangeable with DAP_HOST and DAP_PORT.</p>
+<p>Example:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="nv">ENV_VARS</span><span class="o">=</span><span class="s2">&quot;DAP_HOST=0.0.0.0&quot;</span><span class="w"> </span>scripts/run_docker<span class="w"> </span>provision<span class="w"> </span>--log-level<span class="w"> </span>debug<span class="w">  </span>--wallet-type<span class="w"> </span>askar<span class="w"> </span>--wallet-name<span class="w"> </span><span class="k">$(</span>whoami<span class="k">)</span><span class="w"> </span>--wallet-key<span class="w"> </span>mysecretkey<span class="w"> </span>--endpoint<span class="w"> </span>http://localhost:8080<span class="w"> </span>--no-ledger<span class="w"> </span>--debug
+</code></pre></div>
 <p>Any ports you will be using from the docker container should be published using the <code>PORTS</code> environment variable. For example:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="nv">PORTS</span><span class="o">=</span><span class="s2">&quot;5000:5000 8000:8000 10000:10000&quot;</span><span class="w"> </span>./scripts/run_docker<span class="w"> </span>start<span class="w"> </span>--inbound-transport<span class="w"> </span>http<span class="w"> </span><span class="m">0</span>.0.0.0<span class="w"> </span><span class="m">10000</span><span class="w"> </span>--outbound-transport<span class="w"> </span>http<span class="w"> </span>--debug<span class="w"> </span>--log-level<span class="w"> </span>DEBUG
+<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="nv">PORTS</span><span class="o">=</span><span class="s2">&quot;5000:5000 8000:8000 10000:10000&quot;</span><span class="w"> </span>./scripts/run_docker<span class="w"> </span>start<span class="w"> </span>--inbound-transport<span class="w"> </span>http<span class="w"> </span><span class="m">0</span>.0.0.0<span class="w"> </span><span class="m">10000</span><span class="w"> </span>--outbound-transport<span class="w"> </span>http<span class="w"> </span>--debug<span class="w"> </span>--log-level<span class="w"> </span>DEBUG
 </code></pre></div>
 <p>Refer to <a href="#running">the previous section</a> for instructions on how to run ACA-Py.</p>
 <h3 id="logging">Logging<a class="headerlink" href="#logging" title="Permanent link">&para;</a></h3>
 <p>You can find more details about logging and log levels <a href="../../testing/Logging/">here</a>.</p>
 <h3 id="running-tests">Running Tests<a class="headerlink" href="#running-tests" title="Permanent link">&para;</a></h3>
 <p>To run the ACA-Py test suite, use the following script:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>./scripts/run_tests
+<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>./scripts/run_tests
 </code></pre></div>
 <p>To run the ACA-Py test suite with ptvsd debugger enabled:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>./scripts/run_tests<span class="w"> </span>--debug
+<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>./scripts/run_tests<span class="w"> </span>--debug
 </code></pre></div>
 <p>To run specific tests pass parameters as defined by <a href="https://docs.pytest.org/en/stable/usage.html#specifying-tests-selecting-tests">pytest</a>:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>./scripts/run_tests<span class="w"> </span>aries_cloudagent/protocols/connections
+<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>./scripts/run_tests<span class="w"> </span>aries_cloudagent/protocols/connections
 </code></pre></div>
 <h3 id="running-aries-agent-test-harness-tests">Running Aries Agent Test Harness Tests<a class="headerlink" href="#running-aries-agent-test-harness-tests" title="Permanent link">&para;</a></h3>
 <p>You can run a full suite of integration tests using the <a href="https://github.com/hyperledger/aries-agent-test-harness">Aries Agent Test Harness (AATH)</a>.</p>
 <p>Check out and run AATH tests as follows (this tests the aca-py <code>main</code> branch):</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/hyperledger/aries-agent-test-harness.git
-<a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="nb">cd</span><span class="w"> </span>aries-agent-test-harness
-<a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a>./manage<span class="w"> </span>build<span class="w"> </span>-a<span class="w"> </span>acapy-main
-<a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a>./manage<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span>acapy-main<span class="w"> </span>-t<span class="w"> </span>@AcceptanceTest<span class="w"> </span>-t<span class="w"> </span>~@wip
+<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/hyperledger/aries-agent-test-harness.git
+<a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="nb">cd</span><span class="w"> </span>aries-agent-test-harness
+<a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a>./manage<span class="w"> </span>build<span class="w"> </span>-a<span class="w"> </span>acapy-main
+<a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a>./manage<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span>acapy-main<span class="w"> </span>-t<span class="w"> </span>@AcceptanceTest<span class="w"> </span>-t<span class="w"> </span>~@wip
 </code></pre></div>
 <p>The <code>manage</code> script is described in detail <a href="https://github.com/hyperledger/aries-agent-test-harness#the-manage-bash-script">here</a>, including how to modify the AATH code to run the tests against your aca-py repo/branch.</p>
 <h2 id="development-workflow">Development Workflow<a class="headerlink" href="#development-workflow" title="Permanent link">&para;</a></h2>