Skip to content

Commit

Permalink
fixing windows doc
Browse files Browse the repository at this point in the history
  • Loading branch information
bpetit committed Feb 12, 2024
1 parent b889a51 commit 64a0081
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ <h2 id="going-further"><a class="header" href="#going-further">Going further</a>
<div style="break-before: page; page-break-before: always;"></div><h1 id="install-scaphandre-on-windows"><a class="header" href="#install-scaphandre-on-windows">Install Scaphandre on Windows</a></h1>
<p><strong>!! Warning: Windows version of Scaphandre is still in early stage. !!</strong></p>
<h2 id="using-the-installer"><a class="header" href="#using-the-installer">Using the installer</a></h2>
<p>Download the <a href="https://scaphandre.s3.fr-par.scw.cloud/x86_64/scaphandre_0.5.0_installer.exe">package</a> and install it <strong>as an administrator</strong>.</p>
<p>Download the latest exe installer <a href="https://github.com/hubblo-org/scaphandre/releases">from the release page</a> and install it <strong>as an administrator</strong>.</p>
<h3 id="configuring-a-windows-service-to-run-scaphandre-in-the-background"><a class="header" href="#configuring-a-windows-service-to-run-scaphandre-in-the-background">Configuring a Windows service to run Scaphandre in the background</a></h3>
<p>For example, to run the prometheus-push exporter in the background and target the Prometheus Push Gateway server with ip address <code>198.51.100.5</code> using HTTPS on port 443 and a step to send metrics of 45s, without checking the certificate of the push gateway (remove that option if you have a properly signed TLS certificate):</p>
<pre><code>sc.exe create Scaphandre binPath=&quot;C:\Program Files (x86)\scaphandre\scaphandre.exe prometheus-push -H 198.51.100.5 -s 45 -S https -p 443 --no-tls-check&quot; DisplayName=Scaphandre start=auto
Expand Down Expand Up @@ -754,7 +754,7 @@ <h2 id="usage-1"><a class="header" href="#usage-1">Usage</a></h2>
<p>Metrics provided Scaphandre are documented <a href="references/references/metrics.html">here</a>.</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="prometheuspush-exporter-for-prometheus-push-gateway"><a class="header" href="#prometheuspush-exporter-for-prometheus-push-gateway">PrometheusPush Exporter for Prometheus Push Gateway</a></h1>
<h2 id="usage-2"><a class="header" href="#usage-2">Usage</a></h2>
<p>You can launch the prometheus exporter this way (running the default powercap_rapl sensor):</p>
<p>You can launch the prometheus exporter this way:</p>
<pre><code>scaphandre prometheus-push
</code></pre>
<p>As always exporter's options can be displayed with <code>-h</code>:</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/references/exporter-prometheuspush.html
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ <h1 class="menu-title">Scaphandre documentation</h1>
<main>
<h1 id="prometheuspush-exporter-for-prometheus-push-gateway"><a class="header" href="#prometheuspush-exporter-for-prometheus-push-gateway">PrometheusPush Exporter for Prometheus Push Gateway</a></h1>
<h2 id="usage"><a class="header" href="#usage">Usage</a></h2>
<p>You can launch the prometheus exporter this way (running the default powercap_rapl sensor):</p>
<p>You can launch the prometheus exporter this way:</p>
<pre><code>scaphandre prometheus-push
</code></pre>
<p>As always exporter's options can be displayed with <code>-h</code>:</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/searchindex.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/tutorials/installation-windows.html
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ <h1 class="menu-title">Scaphandre documentation</h1>
<h1 id="install-scaphandre-on-windows"><a class="header" href="#install-scaphandre-on-windows">Install Scaphandre on Windows</a></h1>
<p><strong>!! Warning: Windows version of Scaphandre is still in early stage. !!</strong></p>
<h2 id="using-the-installer"><a class="header" href="#using-the-installer">Using the installer</a></h2>
<p>Download the <a href="https://scaphandre.s3.fr-par.scw.cloud/x86_64/scaphandre_0.5.0_installer.exe">package</a> and install it <strong>as an administrator</strong>.</p>
<p>Download the latest exe installer <a href="https://github.com/hubblo-org/scaphandre/releases">from the release page</a> and install it <strong>as an administrator</strong>.</p>
<h3 id="configuring-a-windows-service-to-run-scaphandre-in-the-background"><a class="header" href="#configuring-a-windows-service-to-run-scaphandre-in-the-background">Configuring a Windows service to run Scaphandre in the background</a></h3>
<p>For example, to run the prometheus-push exporter in the background and target the Prometheus Push Gateway server with ip address <code>198.51.100.5</code> using HTTPS on port 443 and a step to send metrics of 45s, without checking the certificate of the push gateway (remove that option if you have a properly signed TLS certificate):</p>
<pre><code>sc.exe create Scaphandre binPath=&quot;C:\Program Files (x86)\scaphandre\scaphandre.exe prometheus-push -H 198.51.100.5 -s 45 -S https -p 443 --no-tls-check&quot; DisplayName=Scaphandre start=auto
Expand Down

0 comments on commit 64a0081

Please sign in to comment.