Skip to content

Commit 1fc4aef

Browse files
clementbironclementbiron
committed
deploy: 451bb8f 
1 parent 7e0cd30 commit 1fc4aef

5 files changed

Lines changed: 6 additions & 78 deletions

File tree

‎collections/reference/configuration/index.html‎

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,14 @@
3232
<code>30000</code></div></div></div><div class=refItem id=ref-fetcher-language><div class=refItem-name><code>fetcher.language</code>
3333
<span class=refItem-type>string</span>
3434
<a class=refItem-anchor href=#ref-fetcher-language><i class="refItem-anchor-icon icon" data-lucide=link></i></a></div><div class=refItem-description>Language code (ISO 639-1) for request headers.</div><div class="refItem-details refItem-details__"><div class=refItem-default><span>Default:</span>
35-
<code>en</code></div></div></div><h3 id=notifier><a class=title-link href=#notifier>Notifier
36-
<i class="title-anchor icon" data-lucide=link></i></a></h3><p>The notifier section sets up how notifications are sent when new versions of terms are recorded.</p><div class=refItem id=ref-notifier-sendinblue-updateslistid><div class=refItem-name><code>notifier.sendInBlue.updatesListId</code>
37-
<span class=refItem-type>string</span>
38-
<a class=refItem-anchor href=#ref-notifier-sendinblue-updateslistid><i class="refItem-anchor-icon icon" data-lucide=link></i></a></div><div class=refItem-description>SendInBlue contacts list ID of persons to notify on terms updates.</div><div class="refItem-details refItem-details__"><div class=refItem-default><span>Default:</span>
39-
<code>850</code></div></div></div><div class=refItem id=ref-notifier-sendinblue-updatetemplateid><div class=refItem-name><code>notifier.sendInBlue.updateTemplateId</code>
40-
<span class=refItem-type>string</span>
41-
<a class=refItem-anchor href=#ref-notifier-sendinblue-updatetemplateid><i class="refItem-anchor-icon icon" data-lucide=link></i></a></div><div class=refItem-description>SendInBlue email template ID used for updates notifications.</div><div class="refItem-details refItem-details__"><div class=refItem-default><span>Default:</span>
42-
<code>7</code></div></div></div><h3 id=logger><a class=title-link href=#logger>Logger
35+
<code>en</code></div></div></div><h3 id=logger><a class=title-link href=#logger>Logger
4336
<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>
4437
<span class=refItem-type>string</span>
45-
<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>
46-
<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>
38+
<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></div><div class=refItem id=ref-logger-smtp-port><div class=refItem-name><code>logger.smtp.port</code>
4739
<span class=refItem-type>number</span>
48-
<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>
49-
<code>587</code></div></div></div><div class=refItem id=ref-logger-smtp-username><div class=refItem-name><code>logger.smtp.username</code>
40+
<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></div><div class=refItem id=ref-logger-smtp-username><div class=refItem-name><code>logger.smtp.username</code>
5041
<span class=refItem-type>string</span>
51-
<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>
52-
<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>
42+
<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></div><div class=refItem id=ref-logger-sendmailonerror-to><div class=refItem-name><code>logger.sendMailOnError.to</code>
5343
<span class=refItem-type>string</span>
5444
<a class=refItem-anchor href=#ref-logger-sendmailonerror-to><i class="refItem-anchor-icon icon" data-lucide=link></i></a></div><div class=refItem-description>Email address for error notifications.</div><div class="refItem-details refItem-details__"><div class=refItem-example><span class=refItem-label>Example</span>
5545
<code>admin@example.com</code></div></div></div><div class=refItem id=ref-logger-sendmailonerror-from><div class=refItem-name><code>logger.sendMailOnError.from</code>

‎collections/reference/environment-variables/index.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@
1818
<i class="title-anchor icon" data-lucide=link></i></a></h2><p>This reference documentation details all available environment variables that can be used to configure sensitive information. These variables can be defined in a <code>.env</code> file at the root of the collection repository.</p><h3 id=engine><a class=title-link href=#engine>Engine
1919
<i class="title-anchor icon" data-lucide=link></i></a></h3><div class=refItem id=ref-ota-engine-smtp-password><div class=refItem-name><code>OTA_ENGINE_SMTP_PASSWORD</code>
2020
<span class=refItem-type>string</span>
21-
<a class=refItem-anchor href=#ref-ota-engine-smtp-password><i class="refItem-anchor-icon icon" data-lucide=link></i></a></div><div class=refItem-description>SMTP password for email error notifications.</div><div class="refItem-details refItem-details__"></div></div><div class=refItem id=ref-ota-engine-sendinblue-api-key><div class=refItem-name><code>OTA_ENGINE_SENDINBLUE_API_KEY</code>
22-
<span class=refItem-type>string</span>
23-
<a class=refItem-anchor href=#ref-ota-engine-sendinblue-api-key><i class="refItem-anchor-icon icon" data-lucide=link></i></a></div><div class=refItem-description>API key for SendInBlue.</div><div class="refItem-details refItem-details__"></div></div><div class=refItem id=ref-ota-engine-github-token><div class=refItem-name><code>OTA_ENGINE_GITHUB_TOKEN</code>
21+
<a class=refItem-anchor href=#ref-ota-engine-smtp-password><i class="refItem-anchor-icon icon" data-lucide=link></i></a></div><div class=refItem-description>SMTP password for email error notifications.</div><div class="refItem-details refItem-details__"></div></div><div class=refItem id=ref-ota-engine-github-token><div class=refItem-name><code>OTA_ENGINE_GITHUB_TOKEN</code>
2422
<span class=refItem-type>string</span>
2523
<a class=refItem-anchor href=#ref-ota-engine-github-token><i class="refItem-anchor-icon icon" data-lucide=link></i></a></div><div class=refItem-description>GitHub token for API access and dataset publishing. If both GitHub and GitLab tokens are configured, GitHub takes precedence for dataset publishing.</div><div class="refItem-details refItem-details__"></div></div><div class=refItem id=ref-ota-engine-gitlab-token><div class=refItem-name><code>OTA_ENGINE_GITLAB_TOKEN</code>
2624
<span class=refItem-type>string</span>

‎collections/reference/index.xml‎

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1103,36 +1103,6 @@
11031103

11041104

11051105

1106-
&lt;div class="refItem" id="ref-ota-engine-sendinblue-api-key">
1107-
&lt;div class="refItem-name">
1108-
&lt;code>OTA_ENGINE_SENDINBLUE_API_KEY&lt;/code>
1109-
&lt;span class="refItem-type">string&lt;/span>
1110-
1111-
&lt;a class="refItem-anchor" href="#ref-ota-engine-sendinblue-api-key">
1112-
&lt;i class="refItem-anchor-icon icon" data-lucide="link">&lt;/i>
1113-
&lt;/a>
1114-
&lt;/div>
1115-
&lt;div class="refItem-description">API key for SendInBlue.&lt;/div>
1116-
&lt;div class="refItem-details refItem-details__">
1117-
1118-
1119-
1120-
1121-
&lt;/div>
1122-
&lt;/div>
1123-
1124-
1125-
1126-
1127-
1128-
1129-
1130-
1131-
1132-
1133-
1134-
1135-
11361106
&lt;div class="refItem" id="ref-ota-engine-github-token">
11371107
&lt;div class="refItem-name">
11381108
&lt;code>OTA_ENGINE_GITHUB_TOKEN&lt;/code>

‎deployment/how-to/deploy/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
</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>
5656
</span></span><span class=line><span class=cl> <span class=p>},</span>
5757
</span></span><span class=line><span class=cl> <span class=p>}</span><span class=err>,</span>
58-
</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
58+
</span></span></code></pre></div><blockquote><p><strong>Note</strong>: If 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
5959
</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
6060
</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
6161
<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

‎index.xml‎

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1869,36 +1869,6 @@ content filters, raw content data, and MIME type information.&lt;/p></descriptio
18691869

18701870

18711871

1872-
&lt;div class="refItem" id="ref-ota-engine-sendinblue-api-key">
1873-
&lt;div class="refItem-name">
1874-
&lt;code>OTA_ENGINE_SENDINBLUE_API_KEY&lt;/code>
1875-
&lt;span class="refItem-type">string&lt;/span>
1876-
1877-
&lt;a class="refItem-anchor" href="#ref-ota-engine-sendinblue-api-key">
1878-
&lt;i class="refItem-anchor-icon icon" data-lucide="link">&lt;/i>
1879-
&lt;/a>
1880-
&lt;/div>
1881-
&lt;div class="refItem-description">API key for SendInBlue.&lt;/div>
1882-
&lt;div class="refItem-details refItem-details__">
1883-
1884-
1885-
1886-
1887-
&lt;/div>
1888-
&lt;/div>
1889-
1890-
1891-
1892-
1893-
1894-
1895-
1896-
1897-
1898-
1899-
1900-
1901-
19021872
&lt;div class="refItem" id="ref-ota-engine-github-token">
19031873
&lt;div class="refItem-name">
19041874
&lt;code>OTA_ENGINE_GITHUB_TOKEN&lt;/code>

0 commit comments

Comments
 (0)