Skip to content

Commit

Permalink
Deploying to gh-pages from @ fe51b8d 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@MaddyUnderStars
MaddyUnderStars committed Jul 7, 2024
1 parent 57e08b7 commit eff3979
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 24 deletions.
2 changes: 1 addition & 1 deletion search/search_index.json
View file

Large diffs are not rendered by default.

114 changes: 93 additions & 21 deletions setup/server/configuration/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1247,15 +1247,15 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
</tr>
<tr>
<td>cdn_endpointPrivate</td>
<td><a href="http://localhost:3001">http://localhost:3001</a></td>
<td>null</td>
<td>string</td>
<td>See gateway_endpointPrivate</td>
<td>CDN endpoint. See gateway_endpointPrivate</td>
</tr>
<tr>
<td>cdn_endpointPublic</td>
<td><a href="http://localhost:3001">http://localhost:3001</a></td>
<td>null</td>
<td>string</td>
<td>See gateway_endpointPublic</td>
<td>CDN endpoint. See gateway_endpointPublic</td>
</tr>
<tr>
<td>cdn_resizeHeightMax</td>
Expand Down Expand Up @@ -1289,9 +1289,9 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
</tr>
<tr>
<td>api_endpointPublic</td>
<td>"/api"</td>
<td>null</td>
<td>string</td>
<td>See gateway_endpointPublic</td>
<td>Endpoint the API is available at, usually <code>&lt;Base URL&gt;/api</code></td>
</tr>
<tr>
<td>general_instanceName</td>
Expand Down Expand Up @@ -1326,8 +1326,8 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
<tr>
<td>general_correspondenceUserID</td>
<td>null</td>
<td>string</td>
<td>Announced instance correspondence ID (from this instance)</td>
<td>Snowflake</td>
<td>Announced instance correspondence user ID (from this instance)</td>
</tr>
<tr>
<td>general_image</td>
Expand All @@ -1339,7 +1339,13 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
<td>general_instanceId</td>
<td>Snowflake of instance creation date</td>
<td>Snowflake</td>
<td>Announced instance ID</td>
<td>Announced instance ID. Deprecated.</td>
</tr>
<tr>
<td>general_autoCreateBotUsers</td>
<td>false</td>
<td>boolean</td>
<td>Whether to automatically create a bot when creating an application</td>
</tr>
<tr>
<td>limits_user_maxGuilds</td>
Expand All @@ -1349,7 +1355,7 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
</tr>
<tr>
<td>limits_user_maxUsername</td>
<td>127</td>
<td>32</td>
<td>number</td>
<td>Maximum username length</td>
</tr>
Expand Down Expand Up @@ -1445,7 +1451,7 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
</tr>
<tr>
<td>limits_rate_enabled</td>
<td>true</td>
<td>false</td>
<td>boolean</td>
<td>Whether rate limits are enabled</td>
</tr>
Expand Down Expand Up @@ -1555,7 +1561,7 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
<td>limits_absoluteRate_register_window</td>
<td>3600000</td>
<td>number</td>
<td>Global /register rate limit window, in seconds</td>
<td>Global /register rate limit window, in milliseconds</td>
</tr>
<tr>
<td>limits_absoluteRate_register_enabled</td>
Expand All @@ -1573,7 +1579,7 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
<td>limits_absoluteRate_sendMessage_window</td>
<td>60000</td>
<td>number</td>
<td>Global sendMessage window, in seconds</td>
<td>Global sendMessage window, in milliseconds</td>
</tr>
<tr>
<td>limits_absoluteRate_sendMessage_enabled</td>
Expand All @@ -1582,6 +1588,12 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
<td>Whether absolute message sending rate limits are enabled</td>
</tr>
<tr>
<td>metrics_timeout</td>
<td>30000</td>
<td>number</td>
<td>Currently unused</td>
</tr>
<tr>
<td><a href="../security/captcha/">security_captcha_enabled</a></td>
<td>false</td>
<td>boolean</td>
Expand All @@ -1590,7 +1602,7 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
<tr>
<td>security_captcha_service</td>
<td>null</td>
<td>"recaptcha"/"hcaptcha"</td>
<td>"recaptcha", "hcaptcha"</td>
<td>Which captcha service to use</td>
</tr>
<tr>
Expand All @@ -1612,6 +1624,12 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
<td>Whether to generate backup codes for MFA users</td>
</tr>
<tr>
<td>security_autoUpdate</td>
<td>true</td>
<td>boolean</td>
<td>Automatically updates NPM packages daily. Currently unused</td>
</tr>
<tr>
<td>security_requestSignature</td>
<td>Secret secret</td>
<td>string</td>
Expand All @@ -1627,7 +1645,7 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
<td><a href="../reverseProxy/">security_forwardedFor</a></td>
<td>null</td>
<td>string</td>
<td>HTTP header for user's real IP.</td>
<td>HTTP header for user's real IP</td>
</tr>
<tr>
<td>security_ipdataApiKey</td>
Expand All @@ -1651,7 +1669,7 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
<td>security_defaultRegistrationTokenExpiration</td>
<td>604800000</td>
<td>number</td>
<td>Seconds for <a href="../security/regTokens/">registration tokens</a> to expire</td>
<td><a href="../security/regTokens/">Registration token</a> expiry in milliseconds</td>
</tr>
<tr>
<td>login_requireCaptcha</td>
Expand Down Expand Up @@ -1756,6 +1774,12 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
<td>Whether guests accounts require a guild invite</td>
</tr>
<tr>
<td>register_allowNewRegistration</td>
<td>true</td>
<td>boolean</td>
<td>Whether registration is enabled. Deprecated, use <code>register_disabled</code>.</td>
</tr>
<tr>
<td>register_allowMultipleAccounts</td>
<td>true</td>
<td>boolean</td>
Expand Down Expand Up @@ -1831,7 +1855,19 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
<td>guild_discovery_showAllGuilds</td>
<td>false</td>
<td>boolean</td>
<td>Whether guild discovery should show all guilds</td>
<td>Whether guild discovery shows guilds without the DISCOVERABLE feature</td>
</tr>
<tr>
<td>guild_discovery_useRecommendation</td>
<td>false</td>
<td>boolean</td>
<td>Currently unused</td>
</tr>
<tr>
<td>guild_discovery_offset</td>
<td>0</td>
<td>number</td>
<td>Default offset when returning discoverable guilds. Currently unused</td>
</tr>
<tr>
<td>guild_discovery_limit</td>
Expand Down Expand Up @@ -1871,7 +1907,7 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
</tr>
<tr>
<td>gif_apiKey</td>
<td>LIVDSRZULELA</td>
<td>Spacebar tenor API key</td>
<td>string</td>
<td>GIF service API key</td>
</tr>
Expand Down Expand Up @@ -1931,12 +1967,12 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
</tr>
<tr>
<td>defaults_user_premium</td>
<td>false</td>
<td>true</td>
<td>boolean</td>
<td>Whether users are given premium upon registration</td>
</tr>
<tr>
<td>defaults_user_premium_type</td>
<td>defaults_user_premiumType</td>
<td>2</td>
<td>number</td>
<td>The premium type given to users upon registration</td>
Expand All @@ -1948,6 +1984,36 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
<td>Whether users get verified email upon registration</td>
</tr>
<tr>
<td>defaults_guild_maxPresences</td>
<td>250000</td>
<td>number</td>
<td>Maximum number of presences in a guild upon guild creation</td>
</tr>
<tr>
<td>defaults_guild_maxVideoChannelUsers</td>
<td>200</td>
<td>number</td>
<td>Maximum default number of users in a voice channel with video enabled</td>
</tr>
<tr>
<td>defaults_guild_afkTimeout</td>
<td>300</td>
<td>number</td>
<td>AFK timeout in seconds upon guild creation</td>
</tr>
<tr>
<td>defaults_guild_defaultMessageNotifications</td>
<td>1</td>
<td>number</td>
<td>Message notification level upon guild creation</td>
</tr>
<tr>
<td>defaults_guild_explicitContentFilter</td>
<td>0</td>
<td>number</td>
<td>Explicit content filter level upon guild creation</td>
</tr>
<tr>
<td><a href="embeds/">external_twitter</a></td>
<td>null</td>
<td>string</td>
Expand All @@ -1960,10 +2026,16 @@ <h2 id="available-configuration-options">Available Configuration Options</h2>
<td>Which email transport to use</td>
</tr>
<tr>
<td>email_senderAddress</td>
<td>null</td>
<td>string</td>
<td>Sender email address. Defaults to <code>general_correspondenceEmail</code></td>
</tr>
<tr>
<td>email_smtp_host</td>
<td>null</td>
<td>string</td>
<td>SMTP Host for sending email</td>
<td>SMTP host for sending email</td>
</tr>
<tr>
<td>email_smtp_port</td>
Expand Down
3 changes: 1 addition & 2 deletions setup/server/email/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1254,8 +1254,7 @@ <h1 id="email">Email</h1>
<ul>
<li>The <code>general_frontPage</code> <a href="../configuration/">config</a> value, used to generate verification/password reset links.
Be sure to set it to the Spacebar web app URL. For example, <code>https://staging.spacebar.chat</code></li>
<li>The <code>general_correspondenceEmail</code> config value, used as the 'from' email address.
If unset, <code>noreply@localhost</code> is used, which will most likely throw an error with your email service.</li>
<li>The <code>email_senderAddress</code> config value, used as the 'from' email address. If it's not set, <code>general_correspondenceEmail</code> is used.</li>
</ul>
<p>Optionally:</p>
<ul>
Expand Down
Binary file modified sitemap.xml.gz
View file
Binary file not shown.

0 comments on commit eff3979

Please sign in to comment.