Skip to content

Commit

Permalink
Deployed cb6a342 to 6.1.X with MkDocs 1.6.0 and mike 2.2.0.dev0
Browse files Browse the repository at this point in the history
  • Loading branch information
SamuelHassine committed Jun 2, 2024
1 parent 2bf2840 commit 9ac3084
Show file tree
Hide file tree
Showing 13 changed files with 301 additions and 120 deletions.
Binary file modified 6.1.X/administration/assets/update-group-new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified 6.1.X/administration/assets/user-manage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 15 additions & 8 deletions 6.1.X/administration/users/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5109,10 +5109,17 @@ <h3 id="manage-a-user">Manage a user</h3>
<li>Manage its sessions</li>
<li>Manage its triggers and digests</li>
<li>Visualize the history and operations</li>
<li>Manage its max confidence level (override the value inherited from the group)</li>
<li>Manage its max confidence levels</li>
</ul>
<p><a class="glightbox" href="../assets/user-overveiw-new.png" data-type="image" data-width="auto" data-height="auto" data-desc-position="bottom"><img alt="User overview" src="../assets/user-overveiw-new.png" /></a></p>
<p>In the image below, you can see how to override the value inherited from the group.</p>
<p>From this view you can edit the user's information by clicking the "Update" button, which opens a panel with several tabs.</p>
<ul>
<li>Overview tab: edit all basic information such as the name or language</li>
<li>Password tab: change the password for this user</li>
<li>Groups tab: select the groups this user belongs to</li>
<li>Organization Admin tab: see <a href="./#organization-administration">Organization administration</a></li>
<li>Confidences tab: manage the user's maximum confidence level and overrides per entity type</li>
</ul>
<p><a class="glightbox" href="../assets/user-manage.png" data-type="image" data-width="auto" data-height="auto" data-desc-position="bottom"><img alt="manage user" src="../assets/user-manage.png" /></a></p>
<div class="admonition warning">
<p class="admonition-title">Mandatory max confidence level</p>
Expand Down Expand Up @@ -5207,7 +5214,7 @@ <h2 id="organization-administration">Organization administration</h2>
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-05-21T13:59:23+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-05-21</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-05-30T14:27:45+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-05-30</span>
</span>


Expand Down Expand Up @@ -5235,6 +5242,11 @@ <h2 id="organization-administration">Organization administration</h2>

<nav>

<a href="https://github.com/labo-flg" class="md-author" title="@labo-flg">

<img src="https://avatars.githubusercontent.com/u/146674147?v=4&size=72" alt="labo-flg">
</a>

<a href="https://github.com/Lhorus6" class="md-author" title="@Lhorus6">

<img src="https://avatars.githubusercontent.com/u/70956706?v=4&size=72" alt="Lhorus6">
Expand All @@ -5250,11 +5262,6 @@ <h2 id="organization-administration">Organization administration</h2>
<img src="https://avatars.githubusercontent.com/u/148041607?v=4&size=72" alt="nino-filigran">
</a>

<a href="https://github.com/yassine-ouaamou" class="md-author" title="@yassine-ouaamou">

<img src="https://avatars.githubusercontent.com/u/7083405?v=4&size=72" alt="yassine-ouaamou">
</a>




Expand Down
26 changes: 13 additions & 13 deletions 6.1.X/deployment/installation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5472,7 +5472,7 @@ <h2 id="using-docker">Using Docker</h2>
<p>OpenCTI can be deployed using the <em>docker-compose</em> command.</p>
<div class="admonition note">
<p class="admonition-title">Deploy FIPS 140-2 compliant components</p>
<p>We are providing FIPS 140-2 compliant images, please read the <a href="../../reference/fips/">dedicated documentation</a> to understand how to deploy OpenCTI in FIPS-compliant mode.</p>
<p>We provide FIPS 140-2 compliant images. Please read the <a href="../../reference/fips/">dedicated documentation</a> to understand how to deploy OpenCTI in FIPS-compliant mode.</p>
</div>
<h3 id="pre-requisites">Pre-requisites</h3>
<p><strong><span class="twemoji middle"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14.62 8.35c-.42.28-1.75 1.04-1.95 1.19-.39.31-.75.29-1.14-.01-.2-.16-1.53-.92-1.95-1.19-.48-.31-.45-.7.08-.92 1.64-.69 3.28-.64 4.91.03.49.21.51.6.05.9m7.22 7.28c-.93-2.09-2.2-3.99-3.84-5.66a4.31 4.31 0 0 1-1.06-1.88c-.1-.33-.17-.67-.24-1.01-.2-.88-.29-1.78-.7-2.61-.73-1.58-2-2.4-3.84-2.47-1.81.05-3.16.81-3.95 2.4-.21.43-.36.88-.46 1.34-.17.76-.32 1.55-.5 2.32-.15.65-.45 1.21-.96 1.71-1.61 1.57-2.9 3.37-3.88 5.35-.14.29-.28.58-.37.88-.19.66.29 1.12.99.96.44-.09.88-.18 1.3-.31.41-.15.57-.05.67.35.65 2.15 2.07 3.66 4.24 4.5 4.12 1.56 8.93-.66 9.97-4.58.07-.27.17-.37.47-.27.46.14.93.24 1.4.35.49.09.85-.16.92-.64.03-.26-.06-.49-.16-.73"/></svg></span> Linux</strong></p>
Expand All @@ -5490,16 +5490,16 @@ <h3 id="configure-the-environment">Configure the environment</h3>
<div class="admonition warning">
<p class="admonition-title">ElasticSearch / OpenSearch configuration</p>
<ul>
<li>We highly recommend to put the ElasticSearch / OpenSearch following parameter:</li>
<li>We strongly recommend that you add the following ElasticSearch / OpenSearch parameter:</li>
</ul>
<div class="highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>thread_pool.search.queue_size<span class="o">=</span><span class="m">5000</span>
</span></code></pre></div>
<ul>
<li>Check the <a href="../rollover/#opencti-integration-user-permissions-in-opensearchelasticsearch">OpenCTI Integration User Permissions in OpenSearch/ElasticSearch</a> for detailed information about the necessary user permissions for the OpenSearch/ElasticSearch integration.</li>
<li>Check the <a href="../rollover/#opencti-integration-user-permissions-in-opensearchelasticsearch">OpenCTI Integration User Permissions in OpenSearch/ElasticSearch</a> for detailed information about the user permissions required for the OpenSearch/ElasticSearch integration.</li>
</ul>
</div>
<p>Before running the <code>docker-compose</code> command, the <code>docker-compose.yml</code> file should be configured. By default, the <code>docker-compose.yml</code> file is using environment variables available in the file <code>.env.sample</code>.</p>
<p>You can either rename the file <code>.env.sample</code> in <code>.env</code> and put the expected values or just fill directly the <code>docker-compose.yml</code> with the values corresponding to your environment.</p>
<p>You can either rename the file <code>.env.sample</code> as <code>.env</code> and enter the values or just directly edit the <code>docker-compose.yml</code> with the values for your environment.</p>
<div class="admonition note">
<p class="admonition-title">Configuration static parameters</p>
<p>The complete list of available static parameters is available in the <a href="../configuration/">configuration</a> section.</p>
Expand Down Expand Up @@ -5530,15 +5530,15 @@ <h3 id="configure-the-environment">Configure the environment</h3>
<p>If your <code>docker-compose</code> deployment does not support <code>.env</code> files, just export all environment variables before launching the platform:</p>
<div class="highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="nb">export</span><span class="w"> </span><span class="k">$(</span>cat<span class="w"> </span>.env<span class="w"> </span><span class="p">|</span><span class="w"> </span>grep<span class="w"> </span>-v<span class="w"> </span><span class="s2">&quot;#&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>xargs<span class="k">)</span>
</span></code></pre></div>
<p>As OpenCTI has a dependency on ElasticSearch, you have to set the <code>vm.max_map_count</code> before running the containers, as mentioned in the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-cli-run-prod-mode">ElasticSearch documentation</a>.</p>
<p>As OpenCTI has a dependency on ElasticSearch, you have to set <code>vm.max_map_count</code> before running the containers, as mentioned in the <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-cli-run-prod-mode">ElasticSearch documentation</a>.</p>
<div class="highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>sudo<span class="w"> </span>sysctl<span class="w"> </span>-w<span class="w"> </span>vm.max_map_count<span class="o">=</span><span class="m">1048575</span>
</span></code></pre></div>
<p>To make this parameter persistent, add the following to the end of your <code>/etc/sysctl.conf</code>:</p>
<div class="highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>vm.max_map_count<span class="o">=</span><span class="m">1048575</span>
</span></code></pre></div>
<h3 id="persist-data">Persist data</h3>
<p>The default for OpenCTI data is to be persistent.</p>
<p>In the <code>docker-compose.yml</code>, you will find at the end the list of necessary persistent volumes for the dependencies:</p>
<p>In <code>docker-compose.yml</code>, you will find the list of necessary persistent volumes for the dependencies at the end:</p>
<div class="highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="nt">volumes</span><span class="p">:</span>
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="w"> </span><span class="nt">esdata</span><span class="p">:</span><span class="w"> </span><span class="c1"># ElasticSearch data</span>
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span><span class="nt">s3data</span><span class="p">:</span><span class="w"> </span><span class="c1"># S3 bucket data</span>
Expand Down Expand Up @@ -5715,7 +5715,7 @@ <h4 id="rabbitmq">RabbitMQ</h4>
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-05-14T14:56:22+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-05-14</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-05-29T17:43:32+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-05-29</span>
</span>


Expand Down Expand Up @@ -5743,6 +5743,11 @@ <h4 id="rabbitmq">RabbitMQ</h4>

<nav>

<a href="https://github.com/damians-filigran" class="md-author" title="@damians-filigran">

<img src="https://avatars.githubusercontent.com/u/170478556?v=4&size=72" alt="damians-filigran">
</a>

<a href="https://github.com/SamuelHassine" class="md-author" title="@SamuelHassine">

<img src="https://avatars.githubusercontent.com/u/1334279?v=4&size=72" alt="SamuelHassine">
Expand All @@ -5758,16 +5763,11 @@ <h4 id="rabbitmq">RabbitMQ</h4>
<img src="https://avatars.githubusercontent.com/u/3634942?v=4&size=72" alt="aHenryJard">
</a>

<a href="https://github.com/c-neto" class="md-author" title="@c-neto">

<img src="https://avatars.githubusercontent.com/u/26532223?v=4&size=72" alt="c-neto">
</a>




<a href="https://github.com/OpenCTI-Platform/docs/blob/main/docs/deployment/installation.md" class="md-author md-author--more">
+4
+5
</a>


Expand Down
93 changes: 92 additions & 1 deletion 6.1.X/development/platform/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4759,6 +4759,45 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#continous-integration-and-features-cross-repository" class="md-nav__link">
<span class="md-ellipsis">

Continous Integration and features cross repository

</span>
</a>

<nav class="md-nav" aria-label="Continous Integration and features cross repository">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#naming-convention-of-branch" class="md-nav__link">
<span class="md-ellipsis">

Naming convention of branch

</span>
</a>

</li>

<li class="md-nav__item">
<a href="#labels" class="md-nav__link">
<span class="md-ellipsis">

Labels

</span>
</a>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -5182,6 +5221,45 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#continous-integration-and-features-cross-repository" class="md-nav__link">
<span class="md-ellipsis">

Continous Integration and features cross repository

</span>
</a>

<nav class="md-nav" aria-label="Continous Integration and features cross repository">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#naming-convention-of-branch" class="md-nav__link">
<span class="md-ellipsis">

Naming convention of branch

</span>
</a>

</li>

<li class="md-nav__item">
<a href="#labels" class="md-nav__link">
<span class="md-ellipsis">

Labels

</span>
</a>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -5441,6 +5519,14 @@ <h2 id="production-build">Production build</h2>
<div class="highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>../opencti-graphql
</span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a>$<span class="w"> </span>yarn<span class="w"> </span>serv
</span></code></pre></div>
<h2 id="continous-integration-and-features-cross-repository">Continous Integration and features cross repository</h2>
<p>When a feature requires changes in two or more repository in opencti, connectors and client-python; then some specific convention must be use to have the continuous integration build them all together.</p>
<h3 id="naming-convention-of-branch">Naming convention of branch</h3>
<p>The Pull Request on <strong><em>opencti</em></strong> repository should be (issue or bug)/number + optional, example: <code>issue/7062-contributing</code></p>
<p>The pull request on <strong><em>connector</em></strong> or <strong><em>client-python</em></strong> should refer to opencti one by starting with "opencti/" and then the same name. Example: <code>opencti/issue/7062-contributing</code></p>
<p>Note that if there are several matches, the first one is taken. So for example having <code>issue/7062-contributing</code> and <code>issue/7062</code> that are both marked as "multi-repository" is not a good idea.</p>
<h3 id="labels">Labels</h3>
<p>All Pull Requests involved must have the label <code>multi-repository</code> added in GitHub.</p>



Expand All @@ -5463,7 +5549,7 @@ <h2 id="production-build">Production build</h2>
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-03-12T08:05:56+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-03-12</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class="timeago" datetime="2024-05-30T12:30:48+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2024-05-30</span>
</span>


Expand Down Expand Up @@ -5491,6 +5577,11 @@ <h2 id="production-build">Production build</h2>

<nav>

<a href="https://github.com/aHenryJard" class="md-author" title="@aHenryJard">

<img src="https://avatars.githubusercontent.com/u/3634942?v=4&size=72" alt="aHenryJard">
</a>

<a href="https://github.com/labo-flg" class="md-author" title="@labo-flg">

<img src="https://avatars.githubusercontent.com/u/146674147?v=4&size=72" alt="labo-flg">
Expand Down
2 changes: 1 addition & 1 deletion 6.1.X/search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit 9ac3084

Please sign in to comment.