deploy: 4fb35fb

Author: Ndpnt

collections/reference/configuration/index.html

@@ -43,7 +43,10 @@
 <i class="title-anchor icon" data-lucide=link></i></a></h3><p>The logger section configures logging and error notification settings.</p><div class=refItem id=ref-logger-smtp-host><div class=refItem-name><code>logger.smtp.host</code>
 <span class=refItem-type>string</span>
 <a class=refItem-anchor href=#ref-logger-smtp-host><i class="refItem-anchor-icon icon" data-lucide=link></i></a></div><div class=refItem-description>SMTP server hostname.</div><div class="refItem-details refItem-details__"><div class=refItem-default><span>Default:</span>
-<code>smtp-relay.sendinblue.com</code></div></div></div><div class=refItem id=ref-logger-smtp-username><div class=refItem-name><code>logger.smtp.username</code>
+<code>smtp-relay.brevo.com</code></div></div></div><div class=refItem id=ref-logger-smtp-port><div class=refItem-name><code>logger.smtp.port</code>
+<span class=refItem-type>number</span>
+<a class=refItem-anchor href=#ref-logger-smtp-port><i class="refItem-anchor-icon icon" data-lucide=link></i></a></div><div class=refItem-description>SMTP server port.</div><div class="refItem-details refItem-details__"><div class=refItem-default><span>Default:</span>
+<code>587</code></div></div></div><div class=refItem id=ref-logger-smtp-username><div class=refItem-name><code>logger.smtp.username</code>
 <span class=refItem-type>string</span>
 <a class=refItem-anchor href=#ref-logger-smtp-username><i class="refItem-anchor-icon icon" data-lucide=link></i></a></div><div class=refItem-description>Username for SMTP server authentication.</div><div class="refItem-details refItem-details__"><div class=refItem-default><span>Default:</span>
 <code>admin@opentermsarchive.org</code></div></div></div><div class=refItem id=ref-logger-sendmailonerror-to><div class=refItem-name><code>logger.sendMailOnError.to</code>

deployment/how-to/deploy/index.html

@@ -48,13 +48,14 @@
 </span></span><span class=line><span class=cl>-----END OPENSSH PRIVATE KEY-----
 </span></span></code></pre></div></li><li><p>Encrypt the private key file by running the following command inside the <code>deployment</code> folder of the collection:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-shell data-lang=shell><span class=line><span class=cl>ansible-vault encrypt github-bot-private-key
 </span></span></code></pre></div></li><li><p>Commit the changes to the repository</p></li><li><p>Add the public key to bot user&rsquo;s GitHub account:</p><ul><li>Still logged in as the user account dedicated to bot-related actions in GitHub</li><li>Go to <a href=https://github.com/settings/ssh/new>https://github.com/settings/ssh/new</a></li><li>Add the public key with title &ldquo;&lt;collection_name> collection&rdquo;</li></ul></li></ol><ol start=6 show-if-param-content data-param=ota data-value=true style=display:none><li show-if-param-content data-param=ota data-value=true style=display:none>Back up the key in the shared password database by creating an entry titled &ldquo;OTA-Bot GitHub SSH key&rdquo; in the collection folder and storing both public and private keys in this entry</li show-if-param-content data-param="ota" data-value="true" style="display: none;"></ol show-if-param-content data-param="ota" data-value="true" style="display: none;"><h2 id=7-configure-email-notifications><a class=title-link href=#7-configure-email-notifications>7. Configure email notifications
-<i class="title-anchor icon" data-lucide=link></i></a></h2><p>This section describes how to configure the engine to use a specific SMTP server to send email notifications when it encounters errors during the tracking process. This helps you stay informed about issues that need attention and allows you to restart the tracking process if needed.</p><ol><li><p>Get the SMTP credentials (host, username, password) from your email provider</p></li><li><p>Update collection SMTP configuration within the <code>logger</code> key of <code>@opentermsarchive/engine</code> in the <code>config/production.json</code> file:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-json data-lang=json><span class=line><span class=cl>   <span class=s2>&#34;logger&#34;</span><span class=err>:</span> <span class=p>{</span>
+<i class="title-anchor icon" data-lucide=link></i></a></h2><p>This section describes how to configure the engine to use a specific SMTP server to send email notifications when it encounters errors during the tracking process. This helps you stay informed about issues that need attention and allows you to restart the tracking process if needed.</p><ol><li><p>Get the SMTP credentials (host, port, username, password) from your email provider</p></li><li><p>Update collection SMTP configuration within the <code>logger</code> key of <code>@opentermsarchive/engine</code> in the <code>config/production.json</code> file:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-json data-lang=json><span class=line><span class=cl>   <span class=s2>&#34;logger&#34;</span><span class=err>:</span> <span class=p>{</span>
 </span></span><span class=line><span class=cl>      <span class=nt>&#34;smtp&#34;</span><span class=p>:</span> <span class=p>{</span>
 </span></span><span class=line><span class=cl>         <span class=nt>&#34;host&#34;</span><span class=p>:</span> <span class=s2>&#34;&lt;smtp_host&gt;&#34;</span><span class=p>,</span>
+</span></span><span class=line><span class=cl>         <span class=nt>&#34;port&#34;</span><span class=p>:</span> <span class=err>&lt;smtp_port&gt;</span><span class=p>,</span>
 </span></span><span class=line><span class=cl>         <span class=nt>&#34;username&#34;</span><span class=p>:</span> <span class=s2>&#34;&lt;smtp_username&gt;&#34;</span>
 </span></span><span class=line><span class=cl>      <span class=p>},</span>
 </span></span><span class=line><span class=cl>   <span class=p>}</span><span class=err>,</span>
-</span></span></code></pre></div></li><li><p>Store the password in <code>deployment/.env</code>:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-shell data-lang=shell><span class=line><span class=cl><span class=nv>OTA_ENGINE_SMTP_PASSWORD</span><span class=o>=</span>your_smtp_key
+</span></span></code></pre></div><blockquote><p><strong>Note</strong>: If the default port (587) is blocked by your hosting provider, you can try using 2525 as an alternative.</p></blockquote></li><li><p>Store the password in <code>deployment/.env</code>:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-shell data-lang=shell><span class=line><span class=cl><span class=nv>OTA_ENGINE_SMTP_PASSWORD</span><span class=o>=</span>your_smtp_key
 </span></span></code></pre></div><blockquote><p><strong>Note</strong>: To decrypt the file encrypted in a previous step in order to add the password, run <code>ansible-vault decrypt .env</code></p></blockquote></li><li><p>Encrypt the <code>.env</code> file:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-shell data-lang=shell><span class=line><span class=cl>ansible-vault encrypt .env
 </span></span></code></pre></div></li></ol><ol start=5 show-if-param-content data-param=ota data-value=true style=display:none><li show-if-param-content data-param=ota data-value=true style=display:none>Create a new SMTP key in Brevo and name it &ldquo;&lt;collection_name> collection&rdquo;</li show-if-param-content data-param="ota" data-value="true" style="display: none;"><li show-if-param-content data-param=ota data-value=true style=display:none>Back up the key in the shared password database by creating an entry titled &ldquo;SMTP Key&rdquo; in the collection folder and storing the credentials in this entry</li show-if-param-content data-param="ota" data-value="true" style="display: none;"></ol show-if-param-content data-param="ota" data-value="true" style="display: none;"><h2 id=8-test-the-deployment><a class=title-link href=#8-test-the-deployment>8. Test the deployment
 <i class="title-anchor icon" data-lucide=link></i></a></h2><ol><li><p>Via GitHub Actions:</p><ul><li>Check that the <code>deploy</code> action completes successfully</li></ul></li><li><p>Via local deployment:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-shell data-lang=shell><span class=line><span class=cl><span class=nb>cd</span> &lt;collection_id&gt;-declarations/deployment