Skip to content

Commit

Permalink
Upgrade documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ygalnezri committed Jan 9, 2025
1 parent 9084abf commit 8a18b0b
Show file tree
Hide file tree
Showing 11 changed files with 6 additions and 8 deletions.
Binary file modified Watcher/docs/_build/doctrees/README.doctree
Binary file not shown.
Binary file modified Watcher/docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified Watcher/docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file modified Watcher/docs/_build/doctrees/modules/common_core.doctree
Binary file not shown.
Binary file modified Watcher/docs/_build/doctrees/modules/data_leak_core.doctree
Binary file not shown.
Binary file modified Watcher/docs/_build/doctrees/modules/dns_finder_core.doctree
Binary file not shown.
Binary file modified Watcher/docs/_build/doctrees/modules/site_monitoring_core.doctree
Binary file not shown.
Binary file modified Watcher/docs/_build/doctrees/modules/site_monitoring_misp.doctree
Binary file not shown.
Binary file modified Watcher/docs/_build/doctrees/modules/threats_watcher_core.doctree
Binary file not shown.
3 changes: 1 addition & 2 deletions Watcher/docs/_build/html/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ <h3>Configure your Email notifications<a class="headerlink" href="#configure-you
<li><p>Choose your email provider (example: Gmail, Outlook…).</p></li>
<li><p>Go to the email provider’s settings and generate the <strong>SMTP configuration</strong>:</p>
<ul class="simple">
<li><p>For <strong>Gmail</strong>, detailed instructions can be found in <a class="reference external" href="https://support.google.com/a/answer/176600?hl=en">Google’s SMTP documentation</a>.</p></li>
<li><p>For <strong>Gmail</strong>, detailed instructions can be found in <a class="reference external" href="https://support.google.com/a/answer/176600?hl=en">Google SMTP documentation</a>.</p></li>
<li><p>For <strong>Outlook</strong>, you can refer to the <a class="reference external" href="https://support.microsoft.com/en-us/office/pop-imap-and-smtp-settings-for-outlook-com-d088b986-291d-42b8-9564-9c414e2aa040">Outlook SMTP documentation</a> for more information.</p></li>
</ul>
</li>
Expand Down Expand Up @@ -461,7 +461,6 @@ <h3>Configure your Citadel notifications<a class="headerlink" href="#configure-y
</div>
<p>Follow these steps to get the required information:</p>
<ol class="arabic simple">
<li><p>If you don’t have an account, go to this link to create one: Citadel Team Documentation.</p></li>
<li><p>Create a <strong>New Room</strong>.</p></li>
<li><p>Retrieve the <code class="docutils literal notranslate"><span class="pre">CITADEL_ROOM_ID</span></code> from the room’s settings. Copy the room’s link, then extract the ID after <code class="docutils literal notranslate"><span class="pre">/#/room/</span></code> and add it to your .env file.</p></li>
<li><p>Next, visit this link: <a class="reference external" href="https://cds.thalesgroup.com/en/ercom/citadel">Citadel Team Website</a> to request your <code class="docutils literal notranslate"><span class="pre">CITADEL_API_TOKEN</span></code>. This token will allow you to send automatic notifications.</p></li>
Expand Down
11 changes: 5 additions & 6 deletions Watcher/docs/_build/html/_sources/README.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ Follow these steps to get the required information:

1. Choose your email provider (example: Gmail, Outlook...).
2. Go to the email provider’s settings and generate the **SMTP configuration**:
- For **Gmail**, detailed instructions can be found in [Google's SMTP documentation](https://support.google.com/a/answer/176600?hl=en).
- For **Gmail**, detailed instructions can be found in [Google SMTP documentation](https://support.google.com/a/answer/176600?hl=en).
- For **Outlook**, you can refer to the [Outlook SMTP documentation](https://support.microsoft.com/en-us/office/pop-imap-and-smtp-settings-for-outlook-com-d088b986-291d-42b8-9564-9c414e2aa040) for more information.
3. Follow the instructions to retrieve the SMTP server, email port, and other necessary credentials.
4. Save these values in your `.env` file.
Expand Down Expand Up @@ -288,11 +288,10 @@ To configure Citadel, you need the following variables, in the `.env` file:

Follow these steps to get the required information:

1. If you don't have an account, go to this link to create one: Citadel Team Documentation.
2. Create a **New Room**.
3. Retrieve the `CITADEL_ROOM_ID` from the room's settings. Copy the room's link, then extract the ID after `/#/room/` and add it to your .env file.
4. Next, visit this link: [Citadel Team Website](https://cds.thalesgroup.com/en/ercom/citadel) to request your `CITADEL_API_TOKEN`. This token will allow you to send automatic notifications.
5. For the `CITADEL_URL` variable, if you're using a public instance, the URL should be: [https://join.citadel.team/](https://join.citadel.team/). Otherwise, enter your customized instance URL.
1. Create a **New Room**.
2. Retrieve the `CITADEL_ROOM_ID` from the room's settings. Copy the room's link, then extract the ID after `/#/room/` and add it to your .env file.
3. Next, visit this link: [Citadel Team Website](https://cds.thalesgroup.com/en/ercom/citadel) to request your `CITADEL_API_TOKEN`. This token will allow you to send automatic notifications.
4. For the `CITADEL_URL` variable, if you're using a public instance, the URL should be: [https://join.citadel.team/](https://join.citadel.team/). Otherwise, enter your customized instance URL.

Now, you can restart your instance and the parameters will be taken into account:

Expand Down

0 comments on commit 8a18b0b

Please sign in to comment.