mirror of
https://gitverse.ru/kpa39l/icq.git
synced 2026-09-29 09:55:11 +00:00
Telegram bridge: slidgram + SOCKS5 proxy, mod_privilege (XEP-0356), XEP audit
- docker-compose: сервис slidgram (Slidge->Telegram, внешний компонент XEP-0114) - кастомный образ slidgram-proxy: SOCKS5-патч (SLIDGRAM_PROXY -> Pyrogram) для маршрутизации через VPS01 - prosody: component telegram.nixg.ru (5347), component_secret в секции Component (0.11!), mod_privilege + privileged_entities (roster sync мостов), mod_pubsub включён - modules/mod_privilege.lua (community, hg.prosody.im) - docs/slidgram/: офлайн-копия документации slidgram (slidge.im) - README: секции 'Функциональность (XEP)' и 'Мост Telegram'; XEP-AUDIT.md (полный аудит XEP) - STATUS.md: мост ПОДКЛЮЧЁН, privilege, аудит
This commit is contained in:
@@ -0,0 +1,475 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../genindex.html"><link rel="search" title="Search" href="../search.html"><link rel="next" title="Privileges" href="privileges.html"><link rel="prev" title="Quick start" href="quickstart.html">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>Attachments - slidgram documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d111a655" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=7bdb33bb" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=8dab3a3b" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f2f2f2;
|
||||
--color-code-foreground: #1e1e1e;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
||||
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
||||
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
||||
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
||||
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
||||
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
||||
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
||||
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
||||
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
||||
<circle cx="14.5" cy="9.55" r="3.6"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
||||
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
||||
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
||||
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
||||
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
||||
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
||||
<path d="M13.5 6.5l4 4" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-eye" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
||||
<path
|
||||
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
||||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../index.html"><div class="brand">slidgram documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||||
|
||||
<span class="sidebar-brand-text">slidgram documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">For admins</a><input aria-label="Toggle navigation of For admins" checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="install.html">Installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Quick start</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Attachments</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="privileges.html">Privileges</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="config.html">Configuration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples/index.html">XMPP server configs examples</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../user/index.html">For users</a><input aria-label="Toggle navigation of For users" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/registration.html">Registration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/usage.html">Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/features.html">Features</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
<div class="view-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/src/branch/main/docs/source/admin/attachments.rst" title="View this page">
|
||||
<svg><use href="#svg-eye"></use></svg>
|
||||
<span class="visually-hidden">View this page</span>
|
||||
</a>
|
||||
</div><div class="edit-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/_edit/main/docs/source/admin/attachments.rst" rel="edit" title="Edit this page">
|
||||
<svg><use href="#svg-pencil"></use></svg>
|
||||
<span class="visually-hidden">Edit this page</span>
|
||||
</a>
|
||||
</div><div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<section id="attachments">
|
||||
<span id="id1"></span><h1>Attachments<a class="headerlink" href="#attachments" title="Link to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Attachments from XMPP to Telegram require no special configuration.</p>
|
||||
</div>
|
||||
<p>For slidgram to bridge attachments from Telegram to XMPP, you have two options:</p>
|
||||
<ul class="simple">
|
||||
<li><p><strong>HTTP Upload</strong>: slidgram will use your XMPP server’s upload component (<a class="extlink-xep reference external" href="https://xmpp.org/extensions/xep-0363.html">XEP-0363</a>).</p></li>
|
||||
<li><p><strong>No upload</strong>: slidgram will copy attachments to a path it can write to. You then need to serve these files from via an HTTP server (eg nginx,
|
||||
prosody’s <a class="reference external" href="https://prosody.im/doc/modules/mod_http_files">http_files</a>, etc.).</p></li>
|
||||
</ul>
|
||||
<section id="http-upload">
|
||||
<span id="upload"></span><h2>HTTP Upload<a class="headerlink" href="#http-upload" title="Link to this heading">¶</a></h2>
|
||||
<p>slidgram can use the HTTP Upload component (<a class="extlink-xep reference external" href="https://xmpp.org/extensions/xep-0363.html">XEP-0363</a>) of your XMPP server,
|
||||
if you configure it with <code class="docutils literal notranslate"><span class="pre">upload-service=upload.example.org</span></code> (see <a class="reference internal" href="config.html#generic-config"><span class="std std-ref">Generic slidge config</span></a>).
|
||||
In this setting, slidgram will upload files just like any normal user of your server.</p>
|
||||
<section id="example-1-prosody-s-mod-http-file-share">
|
||||
<h3>Example 1: prosody’s mod_http_file_share<a class="headerlink" href="#example-1-prosody-s-mod-http-file-share" title="Link to this heading">¶</a></h3>
|
||||
<p>In slidgram’s <a class="reference internal" href="config.html#config-file"><span class="std std-ref">configuration file</span></a>, use <code class="docutils literal notranslate"><span class="pre">upload-service=upload.example.org</span></code></p>
|
||||
<div class="highlight-lua notranslate"><div class="highlight"><pre><span></span><span class="nv">modules_enabled</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="c1">-- make sure http_file_share is listed here</span>
|
||||
<span class="w"> </span><span class="s2">"http_file_share"</span><span class="p">;</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="nv">Component</span><span class="w"> </span><span class="s2">"upload.example.org"</span><span class="w"> </span><span class="s2">"http_file_share"</span>
|
||||
<span class="w"> </span><span class="c1">-- allow slidgram to use the upload component</span>
|
||||
<span class="w"> </span><span class="nv">http_file_share_access</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">"telegram.example.org"</span><span class="w"> </span><span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>More info: <a class="reference external" href="https://prosody.im/doc/modules/mod_http_file_share">mod_http_file_share</a>.</p>
|
||||
</section>
|
||||
<section id="example-2-ejabberd-mod-http-upload">
|
||||
<h3>Example 2: ejabberd mod_http_upload<a class="headerlink" href="#example-2-ejabberd-mod-http-upload" title="Link to this heading">¶</a></h3>
|
||||
<p>In slidgram’s <a class="reference internal" href="config.html#config-file"><span class="std std-ref">configuration file</span></a>, use <code class="docutils literal notranslate"><span class="pre">upload-service=example.org</span></code></p>
|
||||
<p>The subdomain’s FQDN (example.org) should be listed under the top level ‘hosts’.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">hosts</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"example.org"</span>
|
||||
|
||||
<span class="nt">acl</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">slidge_acl</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">server</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"telegram.example.org"</span>
|
||||
|
||||
<span class="nt">listen</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span>
|
||||
<span class="w"> </span><span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5443</span>
|
||||
<span class="w"> </span><span class="nt">module</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ejabberd_http</span>
|
||||
<span class="w"> </span><span class="nt">tls</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="w"> </span><span class="nt">request_handlers</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">/upload</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mod_http_upload</span>
|
||||
|
||||
<span class="nt">modules</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">mod_http_upload</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="c1"># Any path that ejabberd has read and write access to</span>
|
||||
<span class="w"> </span><span class="nt">docroot</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/ejabberd/upload</span>
|
||||
<span class="w"> </span><span class="nt">put_url</span><span class="p">:</span><span class="w"> </span><span class="s">"https://@HOST@:5443/upload"</span>
|
||||
<span class="w"> </span><span class="nt">access</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">allow</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">local</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">allow</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_acl</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>To get more information about component configuration, see <a class="reference external" href="https://docs.ejabberd.im/admin/configuration/modules/#mod-http-upload">ejabberd’s docs</a>.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="no-upload">
|
||||
<span id="id2"></span><h2>No upload<a class="headerlink" href="#no-upload" title="Link to this heading">¶</a></h2>
|
||||
<p>You need to set up <code class="docutils literal notranslate"><span class="pre">no-upload-path</span></code> to point to a directory, and <code class="docutils literal notranslate"><span class="pre">no-upload-url-prefix</span></code> to an URL prefix pointing to files in that directory (see <a class="reference internal" href="config.html#generic-config"><span class="std std-ref">Generic slidge config</span></a> for more detail).
|
||||
Example: <code class="docutils literal notranslate"><span class="pre">no-upload-path=/var/www/slidgram-attachments/</span></code> and <code class="docutils literal notranslate"><span class="pre">no-upload-url-prefix=https://example.org/slidgram/</span></code> means that <code class="docutils literal notranslate"><span class="pre">/var/www/slidgram-attachments/some-image.jpg</span></code> is accessible at <code class="docutils literal notranslate"><span class="pre">https://example.org/slidgram/some-image.jpg</span></code></p>
|
||||
<p>Make sure that <code class="docutils literal notranslate"><span class="pre">no-upload-path</span></code> is writeable by slidgram and readable by
|
||||
your HTTP server. You may use <code class="docutils literal notranslate"><span class="pre">no-upload-file-read-others=true</span></code> to do that easily,
|
||||
but you might want to restrict which users can read this directory.</p>
|
||||
<div class="admonition warning">
|
||||
<p class="admonition-title">Warning</p>
|
||||
<p>slidgram will not take care of removing old files, so you should set up a cronjob,
|
||||
a systemd timer, or something similar, to regularly delete files, eg.
|
||||
<code class="docutils literal notranslate"><span class="pre">find</span> <span class="pre">.</span> <span class="pre">-mtime</span> <span class="pre">+7</span> <span class="pre">-delete</span> <span class="pre">&&</span> <span class="pre">find</span> <span class="pre">.</span> <span class="pre">-depth</span> <span class="pre">-type</span> <span class="pre">d</span> <span class="pre">-empty</span> <span class="pre">-delete</span></code>
|
||||
to clean up files older than a week.</p>
|
||||
</div>
|
||||
<p>For the following examples, in slidgram’s config,
|
||||
you would have <code class="docutils literal notranslate"><span class="pre">no-upload-path=/var/lib/slidgram/attachments</span></code>.</p>
|
||||
<section id="example-1-prosody-s-http-files">
|
||||
<h3>Example 1: prosody’s http_files<a class="headerlink" href="#example-1-prosody-s-http-files" title="Link to this heading">¶</a></h3>
|
||||
<p>Here, <code class="docutils literal notranslate"><span class="pre">no-upload-url-prefix</span></code> would be <code class="docutils literal notranslate"><span class="pre">https://example.org:5281/files/</span></code>,
|
||||
as per the <a class="reference external" href="https://prosody.im/doc/modules/mod_http_files">mod_http_files documentation</a>.</p>
|
||||
<div class="highlight-lua notranslate"><div class="highlight"><pre><span></span><span class="nv">modules_enabled</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="c1">-- make sure http_files is listed here</span>
|
||||
<span class="w"> </span><span class="s2">"http_files"</span><span class="p">;</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="c1">-- Must be the same value as slidgram's no-upload-path</span>
|
||||
<span class="nv">http_files_dir</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"/var/lib/slidgram/attachments"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="example-2-nginx">
|
||||
<span id="nginx-no-upload"></span><h3>Example 2: nginx<a class="headerlink" href="#example-2-nginx" title="Link to this heading">¶</a></h3>
|
||||
<p>Here, <code class="docutils literal notranslate"><span class="pre">no-upload-url-prefix</span></code> would be <code class="docutils literal notranslate"><span class="pre">https://example.org/slidgram/</span></code>.</p>
|
||||
<div class="highlight-nginx notranslate"><div class="highlight"><pre><span></span><span class="k">server</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="kn">listen</span><span class="w"> </span><span class="mi">80</span><span class="p">;</span>
|
||||
<span class="w"> </span><span class="kn">server_name</span><span class="w"> </span><span class="s">example.org</span><span class="p">;</span>
|
||||
<span class="w"> </span><span class="kn">root</span><span class="w"> </span><span class="s">/var/www/html</span><span class="p">;</span><span class="w"> </span><span class="c1"># if you already have nginx serving files…</span>
|
||||
|
||||
<span class="w"> </span><span class="c1"># the section below is for slidgram</span>
|
||||
<span class="w"> </span><span class="kn">location</span><span class="w"> </span><span class="s">/slidgram</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="c1"># Must be the same value as slidgram's no-upload-path</span>
|
||||
<span class="w"> </span><span class="kn">alias</span><span class="w"> </span><span class="s">/var/lib/slidgram/attachments/</span><span class="p">;</span>
|
||||
<span class="w"> </span><span class="p">}</span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See the <a class="reference external" href="https://docs.nginx.com/nginx/admin-guide/web-server/serving-static-content/">nginx docs</a> for more info.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="next-steps">
|
||||
<h2>Next steps<a class="headerlink" href="#next-steps" title="Link to this heading">¶</a></h2>
|
||||
<p>To make your slidgram install top notch, set up its <a class="reference internal" href="privileges.html#privileges"><span class="std std-ref">privileges</span></a>.</p>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="privileges.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Privileges</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="quickstart.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Quick start</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2026, the slidgram contributors
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
<div class="icons">
|
||||
<a class="muted-link " href="https://codeberg.org/slidge/slidgram" aria-label="Codeberg"><svg xmlns="http://www.w3.org/2000/svg"
|
||||
aria-label="Codeberg" role="img"
|
||||
viewBox="55 65 400 390">
|
||||
<defs>
|
||||
<linearGradient id="A" x1="259.804" x2="383.132" y1="161.4" y2="407.835" gradientUnits="userSpaceOnUse">
|
||||
<stop offset="0" stop-color="#ffffff" stop-opacity="0"/>
|
||||
<stop offset=".5" stop-color="#71c2ff"/>
|
||||
<stop offset="1" stop-color="#39aaff"/>
|
||||
</linearGradient>
|
||||
</defs>
|
||||
<path fill="url(#A)"
|
||||
d="M259.804 161.4c-.44 0-1.1 0-1.32.44l-.44 1.1L332.04 440.21a192.039 192.039 0 0 0 86.77-74.437L261.125 162.06a1.762 1.762 0 0 0-1.321-.661z"
|
||||
opacity=".5" paint-order="stroke markers fill"/>
|
||||
<path fill="#2185d0"
|
||||
d="M255.3 71.8a192 192 0 0 0-162 294l160.1-207c.5-.6 1.5-1 2.6-1s2 .4 2.6 1l160 207a192 192 0 0 0 29.4-102c0-106-86-192-192-192a192 192 0 0 0-.7 0z"
|
||||
paint-order="stroke markers fill"/>
|
||||
</svg>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Attachments</a><ul>
|
||||
<li><a class="reference internal" href="#http-upload">HTTP Upload</a><ul>
|
||||
<li><a class="reference internal" href="#example-1-prosody-s-mod-http-file-share">Example 1: prosody’s mod_http_file_share</a></li>
|
||||
<li><a class="reference internal" href="#example-2-ejabberd-mod-http-upload">Example 2: ejabberd mod_http_upload</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#no-upload">No upload</a><ul>
|
||||
<li><a class="reference internal" href="#example-1-prosody-s-http-files">Example 1: prosody’s http_files</a></li>
|
||||
<li><a class="reference internal" href="#example-2-nginx">Example 2: nginx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#next-steps">Next steps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../_static/scripts/furo.js?v=46bd48cc"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,677 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../genindex.html"><link rel="search" title="Search" href="../search.html"><link rel="next" title="XMPP server configs examples" href="examples/index.html"><link rel="prev" title="Privileges" href="privileges.html">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>Configuration - slidgram documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d111a655" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=7bdb33bb" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=8dab3a3b" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f2f2f2;
|
||||
--color-code-foreground: #1e1e1e;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
||||
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
||||
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
||||
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
||||
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
||||
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
||||
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
||||
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
||||
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
||||
<circle cx="14.5" cy="9.55" r="3.6"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
||||
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
||||
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
||||
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
||||
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
||||
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
||||
<path d="M13.5 6.5l4 4" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-eye" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
||||
<path
|
||||
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
||||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../index.html"><div class="brand">slidgram documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||||
|
||||
<span class="sidebar-brand-text">slidgram documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">For admins</a><input aria-label="Toggle navigation of For admins" checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="install.html">Installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Quick start</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="attachments.html">Attachments</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="privileges.html">Privileges</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Configuration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples/index.html">XMPP server configs examples</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../user/index.html">For users</a><input aria-label="Toggle navigation of For users" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/registration.html">Registration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/usage.html">Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/features.html">Features</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
<div class="view-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/src/branch/main/docs/source/admin/config.rst" title="View this page">
|
||||
<svg><use href="#svg-eye"></use></svg>
|
||||
<span class="visually-hidden">View this page</span>
|
||||
</a>
|
||||
</div><div class="edit-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/_edit/main/docs/source/admin/config.rst" rel="edit" title="Edit this page">
|
||||
<svg><use href="#svg-pencil"></use></svg>
|
||||
<span class="visually-hidden">Edit this page</span>
|
||||
</a>
|
||||
</div><div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<section id="configuration">
|
||||
<span id="config"></span><h1>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h1>
|
||||
<p>Both
|
||||
<a class="reference internal" href="#config-slidgram"><span class="std std-ref">slidgram-specific options</span></a> and
|
||||
<a class="reference internal" href="#generic-config"><span class="std std-ref">slidge generic options</span></a>
|
||||
can be set using
|
||||
<a class="reference internal" href="#config-file"><span class="std std-ref">config text file(s)</span></a>,
|
||||
<a class="reference internal" href="#config-cli"><span class="std std-ref">command-line arguments</span></a>,
|
||||
or <a class="reference internal" href="#config-env"><span class="std std-ref">environment variables</span></a>.</p>
|
||||
<section id="config-files">
|
||||
<span id="config-file"></span><h2>Config files<a class="headerlink" href="#config-files" title="Link to this heading">¶</a></h2>
|
||||
<section id="location">
|
||||
<h3>Location<a class="headerlink" href="#location" title="Link to this heading">¶</a></h3>
|
||||
<p>By default, slidgram uses all config files found in <code class="docutils literal notranslate"><span class="pre">/etc/slidge/conf.d/*.conf</span></code>.
|
||||
You can change this using the <code class="docutils literal notranslate"><span class="pre">SLIDGE_CONF_DIR</span></code> env var, eg
|
||||
<code class="docutils literal notranslate"><span class="pre">SLIDGE_CONF_DIR=/path/dir1:/path/dir2:/path/dir3</span></code>.</p>
|
||||
<p>We recommend using <code class="docutils literal notranslate"><span class="pre">/etc/slidge/conf.d/common.conf</span></code> file to set
|
||||
the options common to several slidge-based gateways
|
||||
(eg, attachment handling, logging options, etc.),
|
||||
then use a slidgram-specific dedicated config file, eg
|
||||
<code class="docutils literal notranslate"><span class="pre">/etc/slidge/slidgram.conf</span></code>.</p>
|
||||
<p>Point to this specific file using the <code class="docutils literal notranslate"><span class="pre">-c</span></code> command line argument when
|
||||
launching slidgram.</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>slidgram<span class="w"> </span>-c<span class="w"> </span>/etc/slidge/slidgram.conf
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="syntax">
|
||||
<h3>Syntax<a class="headerlink" href="#syntax" title="Link to this heading">¶</a></h3>
|
||||
<p>Config files are simple text files with <code class="docutils literal notranslate"><span class="pre">key=value</span></code> entries.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">some</span><span class="o">-</span><span class="n">option</span><span class="o">=</span><span class="n">some</span><span class="o">-</span><span class="n">value</span>
|
||||
<span class="n">some</span><span class="o">-</span><span class="n">other</span><span class="o">-</span><span class="n">option</span><span class="o">=</span><span class="n">some</span><span class="o">-</span><span class="n">other</span><span class="o">-</span><span class="n">value</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="command-line-arguments">
|
||||
<span id="config-cli"></span><h2>Command-line arguments<a class="headerlink" href="#command-line-arguments" title="Link to this heading">¶</a></h2>
|
||||
<p>To pass options as command-line arguments, prepend their name with <code class="docutils literal notranslate"><span class="pre">--</span></code>.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">slidgram</span> <span class="o">--</span><span class="n">some</span><span class="o">-</span><span class="n">option</span><span class="o">=</span><span class="n">some</span><span class="o">-</span><span class="n">value</span> <span class="o">--</span><span class="n">some</span><span class="o">-</span><span class="n">other</span><span class="o">-</span><span class="n">option</span><span class="o">=</span><span class="n">some</span><span class="o">-</span><span class="n">other</span><span class="o">-</span><span class="n">value</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="environment-variables">
|
||||
<span id="config-env"></span><h2>Environment variables<a class="headerlink" href="#environment-variables" title="Link to this heading">¶</a></h2>
|
||||
<p>To pass options as environment variables:</p>
|
||||
<ul class="simple">
|
||||
<li><p>uppercase their name;</p></li>
|
||||
<li><p>substitue dashed for underscores;</p></li>
|
||||
<li><p>prepend with <code class="docutils literal notranslate"><span class="pre">SLIDGE_</span></code> for <a class="reference internal" href="#generic-config"><span class="std std-ref">generic slidge options</span></a>,
|
||||
or <code class="docutils literal notranslate"><span class="pre">SLIDGRAM_</span></code> for
|
||||
<a class="reference internal" href="#config-slidgram"><span class="std std-ref">slidgram-specific options</span></a>.</p></li>
|
||||
</ul>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">SLIDGE_SOME_GENERIC_OPTION</span><span class="o">=</span><span class="n">some</span><span class="o">-</span><span class="n">value</span>
|
||||
<span class="n">SLIDGRAM_SOME_SPECIFIC_OPTION</span><span class="o">=</span><span class="n">some</span><span class="o">-</span><span class="n">other</span><span class="o">-</span><span class="n">value</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="slidgram-specific-config">
|
||||
<span id="config-slidgram"></span><h2>slidgram-specific config<a class="headerlink" href="#slidgram-specific-config" title="Link to this heading">¶</a></h2>
|
||||
<p>slidgram provides the instance-wide options displayed in the table below.</p>
|
||||
<p></p>
|
||||
<div class="table-wrapper docutils container">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head">name</th>
|
||||
<th class="head">default</th>
|
||||
<th class="head"><p>help </p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td>api-hash</td>
|
||||
<td>None</td>
|
||||
<td><p>Telegram app api_hash, obtained at <a class="reference external" href="https://my.telegram.org/apps">https://my.telegram.org/apps </a>If you dont set it, users will have to enter their own on registration. </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>api-id</td>
|
||||
<td>None</td>
|
||||
<td><p>Telegram app api_id, obtained at <a class="reference external" href="https://my.telegram.org/apps">https://my.telegram.org/apps </a>If you dont set it, users will have to enter their own on registration. </p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>attachment-max-size</td>
|
||||
<td>10485760</td>
|
||||
<td><p>Maximum file size (in bytes) to download from telegram automatically/ </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>big-avatars</td>
|
||||
<td>False</td>
|
||||
<td><p>Fetch contact avatars in high-resolution (640x640) instead of the default 160x160. NB: slidge core main config AVATAR_SIZE still applies. </p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>group-history-maximum-messages</td>
|
||||
<td>50</td>
|
||||
<td><p>The number of messages to fetch from a group history. These messages and their attachments will be fetched on slidge startup. </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>registration-auth-code-timeout</td>
|
||||
<td>60</td>
|
||||
<td><p>On registration, users will be prompted for a 2FA code they receive on other telegram clients. </p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
<section id="generic-slidge-config">
|
||||
<span id="generic-config"></span><h2>Generic slidge config<a class="headerlink" href="#generic-slidge-config" title="Link to this heading">¶</a></h2>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>The following options are for slidge version 0.5.0a2.dev2+g8ca420ef0.
|
||||
Depending on how you installed slidgram, you might have a different version of slidge.
|
||||
Use <code class="docutils literal notranslate"><span class="pre">slidgram</span> <span class="pre">--help</span></code> for the exact list of options you can use.</p>
|
||||
</div>
|
||||
<p>Slidge provides the generic instance-wide options displayed in the table below.
|
||||
They may not all have an effect on slidgram’s behaviour.</p>
|
||||
<section id="mandatory-settings">
|
||||
<h3>Mandatory settings<a class="headerlink" href="#mandatory-settings" title="Link to this heading">¶</a></h3>
|
||||
<div class="table-wrapper docutils container">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head">name</th>
|
||||
<th class="head">default</th>
|
||||
<th class="head"><p>help </p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td>secret</td>
|
||||
<td>unset</td>
|
||||
<td><p>The gateway component’s secret (required to connect to the XMPP server) </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>jid</td>
|
||||
<td>unset</td>
|
||||
<td><p>The gateway component’s JID </p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
<section id="basic-configuration">
|
||||
<h3>Basic configuration<a class="headerlink" href="#basic-configuration" title="Link to this heading">¶</a></h3>
|
||||
<div class="table-wrapper docutils container">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head">name</th>
|
||||
<th class="head">default</th>
|
||||
<th class="head"><p>help </p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td>admins</td>
|
||||
<td>()</td>
|
||||
<td><p>JIDs of the gateway admins </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>mam-max-days</td>
|
||||
<td>7</td>
|
||||
<td><p>Maximum number of days for group archive retention. </p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>port</td>
|
||||
<td>5347</td>
|
||||
<td><p>The XMPP server’s port for incoming component connections </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>server</td>
|
||||
<td>localhost</td>
|
||||
<td><p>The XMPP server’s host name. Defaults to localhost, which is the standard way of running slidge, on the same host as the XMPP server. The ‘Jabber Component Protocol’ (XEP-0114) does not mention encryption, so you *should* provide encryption another way, eg via port forwarding, if you change this. </p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>legacy-module</td>
|
||||
<td>unset</td>
|
||||
<td><p>Importable python module containing (at least) a BaseGateway and a LegacySession subclass. NB: this is not needed if you use a gateway-specific entrypoint, e.g., `slidgram` or `python -m slidgram`. </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>home-dir</td>
|
||||
<td>inferred</td>
|
||||
<td><p>Directory where slidge will writes it persistent data and cache. Defaults to /var/lib/slidge/${SLIDGE_JID}. </p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>user-jid-validator</td>
|
||||
<td>inferred</td>
|
||||
<td><p>Regular expression to restrict users that can register to the gateway, by JID. Defaults to .*@${INFERRED_SERVER}. INFERRED_SERVER is derived for the gateway JID, by removing whatever is before the first encountered dot in it. Example: if slidge’s JID=slidge.example.org, INFERRED_SERVER=example.org. </p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
<section id="attachments">
|
||||
<h3>Attachments<a class="headerlink" href="#attachments" title="Link to this heading">¶</a></h3>
|
||||
<div class="table-wrapper docutils container">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head">name</th>
|
||||
<th class="head">default</th>
|
||||
<th class="head"><p>help </p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td>attachment-maximum-file-name-length</td>
|
||||
<td>200</td>
|
||||
<td><p>Some legacy network provide ridiculously long filenames, strip above this limit, preserving suffix. </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>convert-stickers</td>
|
||||
<td>False</td>
|
||||
<td><p>Convert lottie vector stickers (from the legacy side) to webp animations. </p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>fix-filename-suffix-mime-type</td>
|
||||
<td>False</td>
|
||||
<td><p>Fix the Filename suffix based on the Mime Type of the file. Some clients (eg Conversations) may not inline files that have a wrong suffix for the MIME Type. Therefore the MIME Type of the file is checked, if the suffix is not valid for that MIME Type, a valid one will be picked. </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>no-upload-file-read-others</td>
|
||||
<td>False</td>
|
||||
<td><p>After writing a file in NO_UPLOAD_PATH, change its permission so that ‘others’ can read it. </p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>no-upload-path</td>
|
||||
<td>None</td>
|
||||
<td><p>Instead of using the XMPP server’s HTTP upload component, copy files to this dir. You need to set NO_UPLOAD_URL_PREFIX too if you use this option, and configure an web server to serve files in this dir. </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>no-upload-url-prefix</td>
|
||||
<td>None</td>
|
||||
<td><p>Base URL that servers files in the dir set in the no-upload-path option, eg <a class="reference external" href="https://example.com:666/slidge-attachments/">https://example.com:666/slidge-attachments/ </a></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>upload-requester</td>
|
||||
<td>None</td>
|
||||
<td><p>Set which JID should request the upload slots. Defaults to the user’s JID if IQ/get privileges granted for the ‘urn:xmpp:http:upload:0’ namespace; the component JID otherwise. </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>upload-service</td>
|
||||
<td>None</td>
|
||||
<td><p>JID of an HTTP upload service the gateway can use. This is optional, as it should be automatically determined via servicediscovery. </p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>upload-url-prefix</td>
|
||||
<td>None</td>
|
||||
<td><p>This is an optional setting to make sure the URL of your upload service is never leaked to the legacy network in bodies of messages. This can happen under rare circumstances and/or bugs,when replying to an attachment. Set this to the common prefix of the public URL your attachments get, eg <a class="reference external" href="https://upload.example.org:5281/">https://upload.example.org:5281/ </a></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>use-attachment-original-urls</td>
|
||||
<td>False</td>
|
||||
<td><p>For legacy plugins in which attachments are publicly downloadable URLs, let XMPP clients directly download them from this URL. Note that this will probably leak your client IP to the legacy network. </p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
<section id="logging">
|
||||
<h3>Logging<a class="headerlink" href="#logging" title="Link to this heading">¶</a></h3>
|
||||
<div class="table-wrapper docutils container">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head">name</th>
|
||||
<th class="head">default</th>
|
||||
<th class="head"><p>help </p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td>log-file</td>
|
||||
<td>None</td>
|
||||
<td><p>Log to a file instead of stdout/err </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>log-format</td>
|
||||
<td>%(levelname)s:%(name)s:%(message)s</td>
|
||||
<td><p>Optionally, a format string for logging messages. Refer to <a class="reference external" href="https://docs.python.org/3/library/logging.html#logrecord-attributes">https://docs.python.org/3/library/logging.html#logrecord-attributes </a>for available options. </p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
<section id="advanced-settings">
|
||||
<h3>Advanced settings<a class="headerlink" href="#advanced-settings" title="Link to this heading">¶</a></h3>
|
||||
<div class="table-wrapper docutils container">
|
||||
<table class="docutils align-default">
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head">name</th>
|
||||
<th class="head">default</th>
|
||||
<th class="head"><p>help </p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td>avatar-resampling-threads</td>
|
||||
<td>2</td>
|
||||
<td><p>Number of additional threads to use for avatar resampling. Even in a single-core context, this makes avatar resampling non-blocking. </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>avatar-size</td>
|
||||
<td>200</td>
|
||||
<td><p>Maximum image size (width and height), image ratio will be preserved </p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>component-name</td>
|
||||
<td>None</td>
|
||||
<td><p>Overrides the default component name with a custom one. This is seen in service discovery and as the nickname of the component in chat windows. </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>dev-mode</td>
|
||||
<td>False</td>
|
||||
<td><p>Enables an interactive python shell via chat commands, for admins.Not safe to use in prod, but great during dev. </p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>ignore-delay-threshold</td>
|
||||
<td>300</td>
|
||||
<td><p>Threshold, in seconds, below which the <delay> information is stripped out of emitted stanzas. </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>partial-registration-timeout</td>
|
||||
<td>3600</td>
|
||||
<td><p>Timeout before registration and login. Only useful for legacy networks where a single step registration process is not enough. </p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>qr-timeout</td>
|
||||
<td>60</td>
|
||||
<td><p>Timeout for QR code flashing confirmation. </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>strip-leading-emoji-adhoc</td>
|
||||
<td>False</td>
|
||||
<td><p>Strip the leading emoji in ad-hoc command names, if present, in case you are a emoji-hater. </p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>welcome-message</td>
|
||||
<td>None</td>
|
||||
<td><p>Overrides the default welcome message received by newly registered users. </p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>db-url</td>
|
||||
<td>inferred</td>
|
||||
<td><p>Database URL, see <a class="reference external" href="https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls"><https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls>. </a>Defaults to `sqlite:///${HOME_DIR}/slidge.sqlite`. SQLite is *highly recommended*, other backends such as postgresql may work by chance but are much less tested. </p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="advanced-logging-configuration">
|
||||
<h2>Advanced logging configuration<a class="headerlink" href="#advanced-logging-configuration" title="Link to this heading">¶</a></h2>
|
||||
<p>To customize the output of the slidge, you can use the command line argument <code class="docutils literal notranslate"><span class="pre">--log-config</span></code>
|
||||
to specify a <a class="reference external" href="https://docs.python.org/3/library/logging.config.html#configuration-file-format">logging configuration file</a>.</p>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="examples/index.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">XMPP server configs examples</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="privileges.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Privileges</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2026, the slidgram contributors
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
<div class="icons">
|
||||
<a class="muted-link " href="https://codeberg.org/slidge/slidgram" aria-label="Codeberg"><svg xmlns="http://www.w3.org/2000/svg"
|
||||
aria-label="Codeberg" role="img"
|
||||
viewBox="55 65 400 390">
|
||||
<defs>
|
||||
<linearGradient id="A" x1="259.804" x2="383.132" y1="161.4" y2="407.835" gradientUnits="userSpaceOnUse">
|
||||
<stop offset="0" stop-color="#ffffff" stop-opacity="0"/>
|
||||
<stop offset=".5" stop-color="#71c2ff"/>
|
||||
<stop offset="1" stop-color="#39aaff"/>
|
||||
</linearGradient>
|
||||
</defs>
|
||||
<path fill="url(#A)"
|
||||
d="M259.804 161.4c-.44 0-1.1 0-1.32.44l-.44 1.1L332.04 440.21a192.039 192.039 0 0 0 86.77-74.437L261.125 162.06a1.762 1.762 0 0 0-1.321-.661z"
|
||||
opacity=".5" paint-order="stroke markers fill"/>
|
||||
<path fill="#2185d0"
|
||||
d="M255.3 71.8a192 192 0 0 0-162 294l160.1-207c.5-.6 1.5-1 2.6-1s2 .4 2.6 1l160 207a192 192 0 0 0 29.4-102c0-106-86-192-192-192a192 192 0 0 0-.7 0z"
|
||||
paint-order="stroke markers fill"/>
|
||||
</svg>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Configuration</a><ul>
|
||||
<li><a class="reference internal" href="#config-files">Config files</a><ul>
|
||||
<li><a class="reference internal" href="#location">Location</a></li>
|
||||
<li><a class="reference internal" href="#syntax">Syntax</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#command-line-arguments">Command-line arguments</a></li>
|
||||
<li><a class="reference internal" href="#environment-variables">Environment variables</a></li>
|
||||
<li><a class="reference internal" href="#slidgram-specific-config">slidgram-specific config</a></li>
|
||||
<li><a class="reference internal" href="#generic-slidge-config">Generic slidge config</a><ul>
|
||||
<li><a class="reference internal" href="#mandatory-settings">Mandatory settings</a></li>
|
||||
<li><a class="reference internal" href="#basic-configuration">Basic configuration</a></li>
|
||||
<li><a class="reference internal" href="#attachments">Attachments</a></li>
|
||||
<li><a class="reference internal" href="#logging">Logging</a></li>
|
||||
<li><a class="reference internal" href="#advanced-settings">Advanced settings</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#advanced-logging-configuration">Advanced logging configuration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../_static/scripts/furo.js?v=46bd48cc"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,506 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../../">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../../genindex.html"><link rel="search" title="Search" href="../../search.html"><link rel="next" title="For users" href="../../user/index.html"><link rel="prev" title="Configuration" href="../config.html">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>XMPP server configs examples - slidgram documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=d111a655" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=7bdb33bb" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=8dab3a3b" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f2f2f2;
|
||||
--color-code-foreground: #1e1e1e;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
||||
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
||||
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
||||
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
||||
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
||||
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
||||
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
||||
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
||||
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
||||
<circle cx="14.5" cy="9.55" r="3.6"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
||||
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
||||
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
||||
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
||||
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
||||
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
||||
<path d="M13.5 6.5l4 4" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-eye" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
||||
<path
|
||||
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
||||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../../index.html"><div class="brand">slidgram documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">
|
||||
|
||||
<span class="sidebar-brand-text">slidgram documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../index.html">For admins</a><input aria-label="Toggle navigation of For admins" checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="../install.html">Installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../quickstart.html">Quick start</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../attachments.html">Attachments</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../privileges.html">Privileges</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../config.html">Configuration</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">XMPP server configs examples</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../user/index.html">For users</a><input aria-label="Toggle navigation of For users" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user/registration.html">Registration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user/usage.html">Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user/features.html">Features</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
<div class="view-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/src/branch/main/docs/source/admin/examples/index.rst" title="View this page">
|
||||
<svg><use href="#svg-eye"></use></svg>
|
||||
<span class="visually-hidden">View this page</span>
|
||||
</a>
|
||||
</div><div class="edit-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/_edit/main/docs/source/admin/examples/index.rst" rel="edit" title="Edit this page">
|
||||
<svg><use href="#svg-pencil"></use></svg>
|
||||
<span class="visually-hidden">Edit this page</span>
|
||||
</a>
|
||||
</div><div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<section id="xmpp-server-configs-examples">
|
||||
<h1>XMPP server configs examples<a class="headerlink" href="#xmpp-server-configs-examples" title="Link to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>These examples are not meant to be complete, but rather show the relevant
|
||||
parts for slidge.</p>
|
||||
</div>
|
||||
<section id="prosody-upload">
|
||||
<h2>prosody/upload<a class="headerlink" href="#prosody-upload" title="Link to this heading">¶</a></h2>
|
||||
<div class="highlight-lua notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="nv">modules_enabled</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="linenos"> 2</span><span class="w"> </span><span class="c1">-- [...]</span>
|
||||
<span class="linenos"> 3</span><span class="w"> </span><span class="s2">"http_file_share"</span><span class="p">;</span><span class="w"> </span><span class="c1">-- for attachments with the "upload" option</span>
|
||||
<span class="linenos"> 4</span><span class="w"> </span><span class="s2">"privilege"</span><span class="p">;</span><span class="w"> </span><span class="c1">-- for roster sync and 'legacy carbons'</span>
|
||||
<span class="linenos"> 5</span><span class="p">}</span>
|
||||
<span class="linenos"> 6</span>
|
||||
<span class="linenos"> 7</span><span class="kd">local</span><span class="w"> </span><span class="nv">_privileges</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="linenos"> 8</span><span class="w"> </span><span class="nv">roster</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"both"</span><span class="p">;</span>
|
||||
<span class="linenos"> 9</span><span class="w"> </span><span class="nv">message</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"outgoing"</span><span class="p">;</span>
|
||||
<span class="linenos">10</span><span class="w"> </span><span class="nv">iq</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="linenos">11</span><span class="w"> </span><span class="p">[</span><span class="s2">"http://jabber.org/protocol/pubsub"</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"both"</span><span class="p">;</span>
|
||||
<span class="linenos">12</span><span class="w"> </span><span class="p">[</span><span class="s2">"http://jabber.org/protocol/pubsub#owner"</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"set"</span><span class="p">;</span>
|
||||
<span class="linenos">13</span><span class="w"> </span><span class="p">[</span><span class="s2">"urn:xmpp:http:upload:0"</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"get"</span><span class="p">;</span>
|
||||
<span class="linenos">14</span><span class="w"> </span><span class="p">};</span>
|
||||
<span class="linenos">15</span><span class="p">}</span>
|
||||
<span class="linenos">16</span>
|
||||
<span class="linenos">17</span><span class="nv">VirtualHost</span><span class="w"> </span><span class="s2">"example.org"</span>
|
||||
<span class="linenos">18</span><span class="w"> </span><span class="c1">-- for roster sync and 'legacy carbons'</span>
|
||||
<span class="linenos">19</span><span class="w"> </span><span class="nv">privileged_entities</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="linenos">20</span><span class="w"> </span><span class="p">[</span><span class="s2">"telegram.example.org"</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="nv">_privileges</span><span class="p">,</span>
|
||||
<span class="linenos">21</span><span class="w"> </span><span class="p">[</span><span class="s2">"other-walled-garden.example.org"</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nv">_privileges</span><span class="p">,</span>
|
||||
<span class="linenos">22</span><span class="w"> </span><span class="c1">-- repeat for other slidge plugins…</span>
|
||||
<span class="linenos">23</span><span class="w"> </span><span class="p">}</span>
|
||||
<span class="linenos">24</span>
|
||||
<span class="linenos">25</span><span class="nv">Component</span><span class="w"> </span><span class="s2">"telegram.example.org"</span>
|
||||
<span class="linenos">26</span><span class="w"> </span><span class="nv">component_secret</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"secret"</span>
|
||||
<span class="linenos">27</span><span class="w"> </span><span class="nv">modules_enabled</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="s2">"privilege"</span><span class="p">}</span>
|
||||
<span class="linenos">28</span>
|
||||
<span class="linenos">29</span><span class="nv">Component</span><span class="w"> </span><span class="s2">"other-walled-garden.example.org"</span>
|
||||
<span class="linenos">30</span><span class="w"> </span><span class="nv">component_secret</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"some-other-secret"</span>
|
||||
<span class="linenos">31</span><span class="w"> </span><span class="nv">modules_enabled</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="s2">"privilege"</span><span class="p">}</span>
|
||||
<span class="linenos">32</span>
|
||||
<span class="linenos">33</span><span class="c1">-- for attachments with the "upload" option</span>
|
||||
<span class="linenos">34</span><span class="c1">-- in telegram's config: upload-service=upload.example.org</span>
|
||||
<span class="linenos">35</span><span class="nv">Component</span><span class="w"> </span><span class="s2">"upload.example.org"</span><span class="w"> </span><span class="s2">"http_file_share"</span>
|
||||
<span class="linenos">36</span><span class="w"> </span><span class="nv">server_user_role</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"prosody:registered"</span>
|
||||
<span class="linenos">37</span><span class="w"> </span><span class="c1">-- alternatively, you can be more specific with:</span>
|
||||
<span class="linenos">38</span><span class="w"> </span><span class="c1">-- http_file_share_access = { "telegram.example.org", "other-walled-garden.example.org" }</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="prosody-no-upload">
|
||||
<h2>prosody/no-upload<a class="headerlink" href="#prosody-no-upload" title="Link to this heading">¶</a></h2>
|
||||
<div class="highlight-lua notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="nv">modules_enabled</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="linenos"> 2</span><span class="w"> </span><span class="c1">-- [...]</span>
|
||||
<span class="linenos"> 3</span><span class="w"> </span><span class="s2">"http_files"</span><span class="p">;</span><span class="w"> </span><span class="c1">-- to serve "no upload" attachments</span>
|
||||
<span class="linenos"> 4</span><span class="w"> </span><span class="s2">"privilege"</span><span class="p">;</span><span class="w"> </span><span class="c1">-- for roster sync and 'legacy carbons'</span>
|
||||
<span class="linenos"> 5</span><span class="p">}</span>
|
||||
<span class="linenos"> 6</span>
|
||||
<span class="linenos"> 7</span><span class="c1">-- in slidge's config: no-upload-path=/var/lib/slidge/attachments</span>
|
||||
<span class="linenos"> 8</span><span class="nv">http_files_dir</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"/var/lib/slidge/attachments"</span>
|
||||
<span class="linenos"> 9</span>
|
||||
<span class="linenos">10</span><span class="kd">local</span><span class="w"> </span><span class="nv">_privileges</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="linenos">11</span><span class="w"> </span><span class="nv">roster</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"both"</span><span class="p">;</span>
|
||||
<span class="linenos">12</span><span class="w"> </span><span class="nv">message</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"outgoing"</span><span class="p">;</span>
|
||||
<span class="linenos">13</span><span class="w"> </span><span class="nv">iq</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="linenos">14</span><span class="w"> </span><span class="p">[</span><span class="s2">"http://jabber.org/protocol/pubsub"</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"both"</span><span class="p">;</span>
|
||||
<span class="linenos">15</span><span class="w"> </span><span class="p">[</span><span class="s2">"http://jabber.org/protocol/pubsub#owner"</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"set"</span><span class="p">;</span>
|
||||
<span class="linenos">16</span><span class="w"> </span><span class="p">};</span>
|
||||
<span class="linenos">17</span><span class="p">}</span>
|
||||
<span class="linenos">18</span>
|
||||
<span class="linenos">19</span><span class="nv">VirtualHost</span><span class="w"> </span><span class="s2">"example.org"</span>
|
||||
<span class="linenos">20</span><span class="w"> </span><span class="c1">-- for roster sync and 'legacy carbons'</span>
|
||||
<span class="linenos">21</span><span class="w"> </span><span class="nv">privileged_entities</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="linenos">22</span><span class="w"> </span><span class="p">[</span><span class="s2">"telegram.example.org"</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="nv">_privileges</span><span class="p">,</span>
|
||||
<span class="linenos">23</span><span class="w"> </span><span class="p">[</span><span class="s2">"other-walled-garden.example.org"</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nv">_privileges</span><span class="p">,</span>
|
||||
<span class="linenos">24</span><span class="w"> </span><span class="c1">-- repeat for other slidge plugins…</span>
|
||||
<span class="linenos">25</span><span class="w"> </span><span class="p">}</span>
|
||||
<span class="linenos">26</span>
|
||||
<span class="linenos">27</span><span class="nv">Component</span><span class="w"> </span><span class="s2">"telegram.example.org"</span>
|
||||
<span class="linenos">28</span><span class="w"> </span><span class="nv">component_secret</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"secret"</span>
|
||||
<span class="linenos">29</span><span class="w"> </span><span class="nv">modules_enabled</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="s2">"privilege"</span><span class="p">}</span>
|
||||
<span class="linenos">30</span>
|
||||
<span class="linenos">31</span><span class="nv">Component</span><span class="w"> </span><span class="s2">"other-walled-garden.example.org"</span>
|
||||
<span class="linenos">32</span><span class="w"> </span><span class="nv">component_secret</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"some-other-secret"</span>
|
||||
<span class="linenos">33</span><span class="w"> </span><span class="nv">modules_enabled</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="s2">"privilege"</span><span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="ejabberd-upload">
|
||||
<h2>ejabberd/upload<a class="headerlink" href="#ejabberd-upload" title="Link to this heading">¶</a></h2>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This example does not cover the <cite>No upload</cite> option for attachments (see <a class="reference internal" href="../config.html#config"><span class="std std-ref">Configuration</span></a>).
|
||||
For ‘no upload’ with ejabberd, you need an external HTTP server, eg
|
||||
<a class="reference internal" href="../attachments.html#nginx-no-upload"><span class="std std-ref">Example 2: nginx</span></a>.</p>
|
||||
</div>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="nt">listen</span><span class="p">:</span>
|
||||
<span class="linenos"> 2</span><span class="w"> </span><span class="p p-Indicator">-</span>
|
||||
<span class="linenos"> 3</span><span class="w"> </span><span class="nt">ip</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">127.0.0.1</span>
|
||||
<span class="linenos"> 4</span><span class="w"> </span><span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5347</span>
|
||||
<span class="linenos"> 5</span><span class="w"> </span><span class="nt">module</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ejabberd_service</span>
|
||||
<span class="linenos"> 6</span><span class="w"> </span><span class="c1"># The next line is required if you're settings up multiple bridges</span>
|
||||
<span class="linenos"> 7</span><span class="w"> </span><span class="nt">global_routes</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
|
||||
<span class="linenos"> 8</span><span class="w"> </span><span class="nt">hosts</span><span class="p">:</span>
|
||||
<span class="linenos"> 9</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"superduper.example.org"</span><span class="p p-Indicator">:</span>
|
||||
<span class="linenos">10</span><span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret</span>
|
||||
<span class="linenos">11</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"other-walled-garden.example.org"</span><span class="p p-Indicator">:</span>
|
||||
<span class="linenos">12</span><span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">some-other-secret</span>
|
||||
<span class="linenos">13</span><span class="w"> </span><span class="c1"># repeat for other slidge plugins…</span>
|
||||
<span class="linenos">14</span>
|
||||
<span class="linenos">15</span><span class="w"> </span><span class="c1"># HTTP upload service (XEP-0363)</span>
|
||||
<span class="linenos">16</span><span class="w"> </span><span class="p p-Indicator">-</span>
|
||||
<span class="linenos">17</span><span class="w"> </span><span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5443</span>
|
||||
<span class="linenos">18</span><span class="w"> </span><span class="nt">module</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ejabberd_http</span>
|
||||
<span class="linenos">19</span><span class="w"> </span><span class="nt">tls</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="linenos">20</span><span class="w"> </span><span class="nt">request_handlers</span><span class="p">:</span>
|
||||
<span class="linenos">21</span><span class="w"> </span><span class="nt">/upload</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mod_http_upload</span>
|
||||
<span class="linenos">22</span>
|
||||
<span class="linenos">23</span><span class="nt">acl</span><span class="p">:</span>
|
||||
<span class="linenos">24</span><span class="w"> </span><span class="nt">slidge_acl</span><span class="p">:</span>
|
||||
<span class="linenos">25</span><span class="w"> </span><span class="nt">server</span><span class="p">:</span>
|
||||
<span class="linenos">26</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"superduper.example.org"</span>
|
||||
<span class="linenos">27</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"other-walled-garden.example.org"</span>
|
||||
<span class="linenos">28</span><span class="w"> </span><span class="c1"># repeat for other slidge plugins you added in the listen section above</span>
|
||||
<span class="linenos">29</span>
|
||||
<span class="linenos">30</span><span class="nt">access_rules</span><span class="p">:</span>
|
||||
<span class="linenos">31</span><span class="w"> </span><span class="nt">slidge_rule</span><span class="p">:</span>
|
||||
<span class="linenos">32</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">allow</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_acl</span>
|
||||
<span class="linenos">33</span>
|
||||
<span class="linenos">34</span><span class="nt">modules</span><span class="p">:</span>
|
||||
<span class="linenos">35</span><span class="w"> </span><span class="nt">mod_http_upload</span><span class="p">:</span>
|
||||
<span class="linenos">36</span><span class="w"> </span><span class="c1"># A path that ejabberd has Read and Write access to</span>
|
||||
<span class="linenos">37</span><span class="w"> </span><span class="nt">docroot</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/ejabberd/upload</span>
|
||||
<span class="linenos">38</span><span class="w"> </span><span class="nt">put_url</span><span class="p">:</span><span class="w"> </span><span class="s">"https://@HOST@:5443/upload"</span>
|
||||
<span class="linenos">39</span><span class="w"> </span><span class="nt">access</span><span class="p">:</span>
|
||||
<span class="linenos">40</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">allow</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">local</span>
|
||||
<span class="linenos">41</span><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">allow</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_acl</span>
|
||||
<span class="linenos">42</span>
|
||||
<span class="linenos">43</span><span class="w"> </span><span class="c1"># for roster auto-fill and "carbons from legacy apps"</span>
|
||||
<span class="linenos">44</span><span class="w"> </span><span class="c1"># (broken in ejabberd when this was written, hopefully fixed since)</span>
|
||||
<span class="linenos">45</span><span class="w"> </span><span class="nt">mod_privilege</span><span class="p">:</span>
|
||||
<span class="linenos">46</span><span class="w"> </span><span class="nt">roster</span><span class="p">:</span>
|
||||
<span class="linenos">47</span><span class="w"> </span><span class="nt">both</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_rule</span>
|
||||
<span class="linenos">48</span><span class="w"> </span><span class="nt">message</span><span class="p">:</span>
|
||||
<span class="linenos">49</span><span class="w"> </span><span class="nt">outgoing</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_rule</span>
|
||||
<span class="linenos">50</span><span class="w"> </span><span class="nt">iq</span><span class="p">:</span>
|
||||
<span class="linenos">51</span><span class="w"> </span><span class="s">"http://jabber.org/protocol/pubsub"</span><span class="p p-Indicator">:</span>
|
||||
<span class="linenos">52</span><span class="w"> </span><span class="nt">both</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_rule</span>
|
||||
<span class="linenos">53</span><span class="w"> </span><span class="s">"http://jabber.org/protocol/pubsub#owner"</span><span class="p p-Indicator">:</span>
|
||||
<span class="linenos">54</span><span class="w"> </span><span class="nt">set</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_rule</span>
|
||||
<span class="linenos">55</span><span class="w"> </span><span class="s">"urn:xmpp:http:upload:0"</span><span class="p p-Indicator">:</span>
|
||||
<span class="linenos">56</span><span class="w"> </span><span class="nt">get</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_rule</span>
|
||||
<span class="linenos">57</span><span class="w"> </span><span class="nt">mod_roster</span><span class="p">:</span>
|
||||
<span class="linenos">58</span><span class="w"> </span><span class="nt">versioning</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="../../user/index.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">For users</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="../config.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Configuration</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2026, the slidgram contributors
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
<div class="icons">
|
||||
<a class="muted-link " href="https://codeberg.org/slidge/slidgram" aria-label="Codeberg"><svg xmlns="http://www.w3.org/2000/svg"
|
||||
aria-label="Codeberg" role="img"
|
||||
viewBox="55 65 400 390">
|
||||
<defs>
|
||||
<linearGradient id="A" x1="259.804" x2="383.132" y1="161.4" y2="407.835" gradientUnits="userSpaceOnUse">
|
||||
<stop offset="0" stop-color="#ffffff" stop-opacity="0"/>
|
||||
<stop offset=".5" stop-color="#71c2ff"/>
|
||||
<stop offset="1" stop-color="#39aaff"/>
|
||||
</linearGradient>
|
||||
</defs>
|
||||
<path fill="url(#A)"
|
||||
d="M259.804 161.4c-.44 0-1.1 0-1.32.44l-.44 1.1L332.04 440.21a192.039 192.039 0 0 0 86.77-74.437L261.125 162.06a1.762 1.762 0 0 0-1.321-.661z"
|
||||
opacity=".5" paint-order="stroke markers fill"/>
|
||||
<path fill="#2185d0"
|
||||
d="M255.3 71.8a192 192 0 0 0-162 294l160.1-207c.5-.6 1.5-1 2.6-1s2 .4 2.6 1l160 207a192 192 0 0 0 29.4-102c0-106-86-192-192-192a192 192 0 0 0-.7 0z"
|
||||
paint-order="stroke markers fill"/>
|
||||
</svg>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">XMPP server configs examples</a><ul>
|
||||
<li><a class="reference internal" href="#prosody-upload">prosody/upload</a></li>
|
||||
<li><a class="reference internal" href="#prosody-no-upload">prosody/no-upload</a></li>
|
||||
<li><a class="reference internal" href="#ejabberd-upload">ejabberd/upload</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../../_static/scripts/furo.js?v=46bd48cc"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,404 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../genindex.html"><link rel="search" title="Search" href="../search.html"><link rel="next" title="Installation" href="install.html"><link rel="prev" title="slidgram" href="../index.html">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>For admins - slidgram documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d111a655" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=7bdb33bb" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=8dab3a3b" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f2f2f2;
|
||||
--color-code-foreground: #1e1e1e;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
||||
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
||||
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
||||
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
||||
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
||||
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
||||
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
||||
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
||||
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
||||
<circle cx="14.5" cy="9.55" r="3.6"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
||||
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
||||
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
||||
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
||||
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
||||
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
||||
<path d="M13.5 6.5l4 4" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-eye" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
||||
<path
|
||||
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
||||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../index.html"><div class="brand">slidgram documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||||
|
||||
<span class="sidebar-brand-text">slidgram documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">For admins</a><input aria-label="Toggle navigation of For admins" checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="install.html">Installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Quick start</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="attachments.html">Attachments</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="privileges.html">Privileges</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="config.html">Configuration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples/index.html">XMPP server configs examples</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../user/index.html">For users</a><input aria-label="Toggle navigation of For users" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/registration.html">Registration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/usage.html">Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/features.html">Features</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
<div class="view-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/src/branch/main/docs/source/admin/index.rst" title="View this page">
|
||||
<svg><use href="#svg-eye"></use></svg>
|
||||
<span class="visually-hidden">View this page</span>
|
||||
</a>
|
||||
</div><div class="edit-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/_edit/main/docs/source/admin/index.rst" rel="edit" title="Edit this page">
|
||||
<svg><use href="#svg-pencil"></use></svg>
|
||||
<span class="visually-hidden">Edit this page</span>
|
||||
</a>
|
||||
</div><div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<section id="for-admins">
|
||||
<h1>For admins<a class="headerlink" href="#for-admins" title="Link to this heading">¶</a></h1>
|
||||
<p>If you are the administrator of an XMPP server and want to set up slidgram,
|
||||
this part of the documentation is made for you.</p>
|
||||
<p>Once the gateway is set up, multiple users can use after registering themselves, through
|
||||
an XMPP client.</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="install.html#containers">Containers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="install.html#python-packages">Python packages</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="install.html#unofficial-debian-package">Unofficial debian package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="install.html#netbsd-specific-instructions">NetBSD-specific instructions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick start</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#setup-an-xmpp-server-component">Setup an XMPP server component</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#id1">Prosŏdy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="quickstart.html#id2">ejabberd</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#launch-the-daemon">Launch the daemon</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#next-steps">Next steps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="attachments.html">Attachments</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="attachments.html#http-upload">HTTP Upload</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="attachments.html#example-1-prosody-s-mod-http-file-share">Example 1: prosody’s mod_http_file_share</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="attachments.html#example-2-ejabberd-mod-http-upload">Example 2: ejabberd mod_http_upload</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="attachments.html#no-upload">No upload</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="attachments.html#example-1-prosody-s-http-files">Example 1: prosody’s http_files</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="attachments.html#example-2-nginx">Example 2: nginx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="attachments.html#next-steps">Next steps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="privileges.html">Privileges</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="privileges.html#server-specific-instructions">Server-specific instructions</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="privileges.html#prosody">Prosŏdy</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="privileges.html#ejabberd">ejabberd</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="privileges.html#next-step">Next step</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="config.html">Configuration</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="config.html#config-files">Config files</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="config.html#location">Location</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="config.html#syntax">Syntax</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="config.html#command-line-arguments">Command-line arguments</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="config.html#environment-variables">Environment variables</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="config.html#slidgram-specific-config">slidgram-specific config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="config.html#generic-slidge-config">Generic slidge config</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="config.html#mandatory-settings">Mandatory settings</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="config.html#basic-configuration">Basic configuration</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="config.html#attachments">Attachments</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="config.html#logging">Logging</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="config.html#advanced-settings">Advanced settings</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="config.html#advanced-logging-configuration">Advanced logging configuration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="examples/index.html">XMPP server configs examples</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples/index.html#prosody-upload">prosody/upload</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples/index.html#prosody-no-upload">prosody/no-upload</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples/index.html#ejabberd-upload">ejabberd/upload</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="install.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Installation</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="../index.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Home</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2026, the slidgram contributors
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
<div class="icons">
|
||||
<a class="muted-link " href="https://codeberg.org/slidge/slidgram" aria-label="Codeberg"><svg xmlns="http://www.w3.org/2000/svg"
|
||||
aria-label="Codeberg" role="img"
|
||||
viewBox="55 65 400 390">
|
||||
<defs>
|
||||
<linearGradient id="A" x1="259.804" x2="383.132" y1="161.4" y2="407.835" gradientUnits="userSpaceOnUse">
|
||||
<stop offset="0" stop-color="#ffffff" stop-opacity="0"/>
|
||||
<stop offset=".5" stop-color="#71c2ff"/>
|
||||
<stop offset="1" stop-color="#39aaff"/>
|
||||
</linearGradient>
|
||||
</defs>
|
||||
<path fill="url(#A)"
|
||||
d="M259.804 161.4c-.44 0-1.1 0-1.32.44l-.44 1.1L332.04 440.21a192.039 192.039 0 0 0 86.77-74.437L261.125 162.06a1.762 1.762 0 0 0-1.321-.661z"
|
||||
opacity=".5" paint-order="stroke markers fill"/>
|
||||
<path fill="#2185d0"
|
||||
d="M255.3 71.8a192 192 0 0 0-162 294l160.1-207c.5-.6 1.5-1 2.6-1s2 .4 2.6 1l160 207a192 192 0 0 0 29.4-102c0-106-86-192-192-192a192 192 0 0 0-.7 0z"
|
||||
paint-order="stroke markers fill"/>
|
||||
</svg>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer no-toc">
|
||||
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../_static/scripts/furo.js?v=46bd48cc"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,416 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../genindex.html"><link rel="search" title="Search" href="../search.html"><link rel="next" title="Quick start" href="quickstart.html"><link rel="prev" title="For admins" href="index.html">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>Installation - slidgram documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d111a655" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=7bdb33bb" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=8dab3a3b" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f2f2f2;
|
||||
--color-code-foreground: #1e1e1e;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
||||
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
||||
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
||||
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
||||
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
||||
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
||||
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
||||
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
||||
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
||||
<circle cx="14.5" cy="9.55" r="3.6"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
||||
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
||||
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
||||
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
||||
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
||||
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
||||
<path d="M13.5 6.5l4 4" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-eye" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
||||
<path
|
||||
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
||||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../index.html"><div class="brand">slidgram documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||||
|
||||
<span class="sidebar-brand-text">slidgram documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">For admins</a><input aria-label="Toggle navigation of For admins" checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul class="current">
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Quick start</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="attachments.html">Attachments</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="privileges.html">Privileges</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="config.html">Configuration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples/index.html">XMPP server configs examples</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../user/index.html">For users</a><input aria-label="Toggle navigation of For users" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/registration.html">Registration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/usage.html">Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/features.html">Features</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
<div class="view-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/src/branch/main/docs/source/admin/install.rst" title="View this page">
|
||||
<svg><use href="#svg-eye"></use></svg>
|
||||
<span class="visually-hidden">View this page</span>
|
||||
</a>
|
||||
</div><div class="edit-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/_edit/main/docs/source/admin/install.rst" rel="edit" title="Edit this page">
|
||||
<svg><use href="#svg-pencil"></use></svg>
|
||||
<span class="visually-hidden">Edit this page</span>
|
||||
</a>
|
||||
</div><div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<section id="installation">
|
||||
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h1>
|
||||
<section id="containers">
|
||||
<h2>Containers<a class="headerlink" href="#containers" title="Link to this heading">¶</a></h2>
|
||||
<p>A container is built on every push to the git repository and uploaded to <a class="reference external" href="https://codeberg.org/slidge/-/packages/container/slidgram/latest">the codeberg package
|
||||
registry</a>.</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>docker<span class="w"> </span>run<span class="w"> </span>codeberg.org/slidge/slidgram:latest<span class="w"> </span><span class="c1"># works with podman too</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Use the <code class="docutils literal notranslate"><span class="pre">:latest</span></code> tag for the latest release, <code class="docutils literal notranslate"><span class="pre">:vX.X.X</span></code> for release
|
||||
X.X.X, and <code class="docutils literal notranslate"><span class="pre">:main</span></code> for the bleeding edge.</p>
|
||||
<p>For data persistence, mount a writeable directory into <code class="docutils literal notranslate"><span class="pre">/var/lib/slidge</span></code>. Inside the container,
|
||||
slidgram runs as the <code class="docutils literal notranslate"><span class="pre">slidge</span></code> user with UID/GID 10000/10000.</p>
|
||||
<p>slidgram must be able to <a class="reference internal" href="quickstart.html#setup-component"><span class="std std-ref">reach your XMPP server</span></a>, so set up networking accordingly.</p>
|
||||
</section>
|
||||
<section id="python-packages">
|
||||
<h2>Python packages<a class="headerlink" href="#python-packages" title="Link to this heading">¶</a></h2>
|
||||
<a class="reference external image-reference" href="https://pypi.org/project/slidgram/"><img alt="PyPI package version" src="https://badge.fury.io/py/slidgram.svg" />
|
||||
</a>
|
||||
<p>slidgram is available on the <a class="reference external" href="https://pypi.org/project/slidgram/">python package index (PyPI)</a>.</p>
|
||||
<p>If you are not familiar with python packaging, we recommend using <a class="reference external" href="https://pypa.github.io/pipx/">pipx</a> to
|
||||
set up slidgram and its dependencies, isolated from the rest of your system.</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># for the latest stable release published to PyPI, if any</span>
|
||||
pipx<span class="w"> </span>install<span class="w"> </span>slidgram
|
||||
|
||||
slidgram<span class="w"> </span>--help
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Bleeding edge versions are also available on <a class="reference external" href="https://codeberg/slidge/-/packages/pypi/slidgram">codeberg’s python index</a>.</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># for the bleeding edge</span>
|
||||
pipx<span class="w"> </span>install<span class="w"> </span>slidgram<span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>--pip-args<span class="o">=</span><span class="s1">'--extra-index-url https://codeberg.org/api/packages/slidge/pypi/simple/ --pre'</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="unofficial-debian-package">
|
||||
<h2>Unofficial debian package<a class="headerlink" href="#unofficial-debian-package" title="Link to this heading">¶</a></h2>
|
||||
<p>If you are using debian you might be interested in installing the
|
||||
<a class="reference external" href="https://codeberg.org/slidge/debian">slidge (unofficial) debian
|
||||
package</a> which bundles slidgram
|
||||
along with other slidge-based XMPP gateways.</p>
|
||||
<p>Follow the instructions in the repository <a class="reference external" href="https://codeberg.org/slidge/debian/src/branch/main/README.md">README</a>. In short:</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="quickstart.html#setup-component"><span class="std std-ref">Configure</span></a> your XMPP ;</p></li>
|
||||
<li><p>edit <code class="docutils literal notranslate"><span class="pre">/etc/slidge/conf.d/common.conf</span></code>;</p></li>
|
||||
<li><p>edit <code class="docutils literal notranslate"><span class="pre">/etc/slidge/telegram.conf</span></code>;</p></li>
|
||||
<li><p>run <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">systemctl</span> <span class="pre">start</span> <span class="pre">slidge@telegram</span></code>;</p></li>
|
||||
<li><p>watch the logs with <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">journalctl</span> <span class="pre">-u</span> <span class="pre">slidge@telegram</span> <span class="pre">-f</span></code>.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="netbsd-specific-instructions">
|
||||
<h2>NetBSD-specific instructions<a class="headerlink" href="#netbsd-specific-instructions" title="Link to this heading">¶</a></h2>
|
||||
<p>It is possible to install slidgram on bare metal or in a sandbox.</p>
|
||||
<p>First, install the necessary build dependencies:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pkgin<span class="w"> </span>install<span class="w"> </span>py313-pip<span class="w"> </span>py313-setuptools<span class="w"> </span>py313-setuptools-rust<span class="w"> </span>py313-wheel<span class="w"> </span>rust<span class="w"> </span>rust-bin<span class="w"> </span>gcc14
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Then, optionally, install the dependencies available with pkgin:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pkgin<span class="w"> </span>install<span class="w"> </span>py313-uvloop<span class="w"> </span>py313-aiohttp<span class="w"> </span>py313-alembic<span class="w"> </span>py313-Pillow<span class="w"> </span>py313-configargparse<span class="w"> </span>py313-defusedxml<span class="w"> </span>py313-qrcode<span class="w"> </span>py313-sqlalchemy<span class="w"> </span>py313-aiohappyeyeballs<span class="w"> </span>py313-aiosignal<span class="w"> </span>py313-attrs<span class="w"> </span>py313-frozenlist<span class="w"> </span>py313-multidict<span class="w"> </span>py313-propcache<span class="w"> </span>py313-yarl<span class="w"> </span>py313-aiodns<span class="w"> </span>py313-brotli<span class="w"> </span>py313-mako<span class="w"> </span>py313-greenlet<span class="w"> </span>py313-idna<span class="w"> </span>py313-cffi
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>After this, install with <code class="docutils literal notranslate"><span class="pre">pip</span></code>:</p>
|
||||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">PATH</span><span class="o">=</span><span class="s2">"</span><span class="nv">$PATH</span><span class="s2">:/usr/pkg/gcc14/bin"</span><span class="w"> </span>pip3.13<span class="w"> </span>install<span class="w"> </span>slidgram
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="quickstart.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Quick start</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="index.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">For admins</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2026, the slidgram contributors
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
<div class="icons">
|
||||
<a class="muted-link " href="https://codeberg.org/slidge/slidgram" aria-label="Codeberg"><svg xmlns="http://www.w3.org/2000/svg"
|
||||
aria-label="Codeberg" role="img"
|
||||
viewBox="55 65 400 390">
|
||||
<defs>
|
||||
<linearGradient id="A" x1="259.804" x2="383.132" y1="161.4" y2="407.835" gradientUnits="userSpaceOnUse">
|
||||
<stop offset="0" stop-color="#ffffff" stop-opacity="0"/>
|
||||
<stop offset=".5" stop-color="#71c2ff"/>
|
||||
<stop offset="1" stop-color="#39aaff"/>
|
||||
</linearGradient>
|
||||
</defs>
|
||||
<path fill="url(#A)"
|
||||
d="M259.804 161.4c-.44 0-1.1 0-1.32.44l-.44 1.1L332.04 440.21a192.039 192.039 0 0 0 86.77-74.437L261.125 162.06a1.762 1.762 0 0 0-1.321-.661z"
|
||||
opacity=".5" paint-order="stroke markers fill"/>
|
||||
<path fill="#2185d0"
|
||||
d="M255.3 71.8a192 192 0 0 0-162 294l160.1-207c.5-.6 1.5-1 2.6-1s2 .4 2.6 1l160 207a192 192 0 0 0 29.4-102c0-106-86-192-192-192a192 192 0 0 0-.7 0z"
|
||||
paint-order="stroke markers fill"/>
|
||||
</svg>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Installation</a><ul>
|
||||
<li><a class="reference internal" href="#containers">Containers</a></li>
|
||||
<li><a class="reference internal" href="#python-packages">Python packages</a></li>
|
||||
<li><a class="reference internal" href="#unofficial-debian-package">Unofficial debian package</a></li>
|
||||
<li><a class="reference internal" href="#netbsd-specific-instructions">NetBSD-specific instructions</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../_static/scripts/furo.js?v=46bd48cc"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,441 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../genindex.html"><link rel="search" title="Search" href="../search.html"><link rel="next" title="Configuration" href="config.html"><link rel="prev" title="Attachments" href="attachments.html">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>Privileges - slidgram documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d111a655" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=7bdb33bb" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=8dab3a3b" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f2f2f2;
|
||||
--color-code-foreground: #1e1e1e;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
||||
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
||||
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
||||
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
||||
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
||||
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
||||
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
||||
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
||||
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
||||
<circle cx="14.5" cy="9.55" r="3.6"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
||||
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
||||
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
||||
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
||||
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
||||
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
||||
<path d="M13.5 6.5l4 4" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-eye" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
||||
<path
|
||||
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
||||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../index.html"><div class="brand">slidgram documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||||
|
||||
<span class="sidebar-brand-text">slidgram documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">For admins</a><input aria-label="Toggle navigation of For admins" checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="install.html">Installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="quickstart.html">Quick start</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="attachments.html">Attachments</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Privileges</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="config.html">Configuration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples/index.html">XMPP server configs examples</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../user/index.html">For users</a><input aria-label="Toggle navigation of For users" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/registration.html">Registration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/usage.html">Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/features.html">Features</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
<div class="view-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/src/branch/main/docs/source/admin/privileges.rst" title="View this page">
|
||||
<svg><use href="#svg-eye"></use></svg>
|
||||
<span class="visually-hidden">View this page</span>
|
||||
</a>
|
||||
</div><div class="edit-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/_edit/main/docs/source/admin/privileges.rst" rel="edit" title="Edit this page">
|
||||
<svg><use href="#svg-pencil"></use></svg>
|
||||
<span class="visually-hidden">Edit this page</span>
|
||||
</a>
|
||||
</div><div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<section id="privileges">
|
||||
<span id="id1"></span><h1>Privileges<a class="headerlink" href="#privileges" title="Link to this heading">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>“<a class="extlink-xep reference external" href="https://xmpp.org/extensions/xep-0356.html">XEP-0356</a>: Privileged Entity” only works for XMPP users using the same server as slidgram, e.g., <code class="docutils literal notranslate"><span class="pre">eve@example.org</span></code> on <code class="docutils literal notranslate"><span class="pre">telegram.example.org</span></code>.</p>
|
||||
</div>
|
||||
<p>Setting up slidgram as a privileged entity (<a class="extlink-xep reference external" href="https://xmpp.org/extensions/xep-0356.html">XEP-0356</a>) is optional, but nice to have.
|
||||
It improves user experience with a few “cherry on top” features.
|
||||
By configuring your XMPP server such that slidgram is a privileged entity, slidgram can:</p>
|
||||
<ul class="simple">
|
||||
<li><p>automatically add/remove “puppet contacts” from the XMPP roster of slidgram users,</p></li>
|
||||
<li><p>reflect on the XMPP side messages sent by users via official Telegram apps,</p></li>
|
||||
<li><p>(if using <a class="reference internal" href="attachments.html#upload"><span class="std std-ref">HTTP Upload</span></a> for attachments from Telegram to XMPP) request upload slots on behalf of slidgram users,
|
||||
respecting any quota, retention, permission, or other policy set at the upload component level,</p></li>
|
||||
<li><p>synchronize other actions done via official Telegram apps, such as marking messages as read, using emoji reactions,
|
||||
retracting messages, sending files…</p></li>
|
||||
<li><p>automatically add XMPP bookmarks (<a class="extlink-xep reference external" href="https://xmpp.org/extensions/xep-0402.html">XEP-0402</a>) for MUCs (<a class="extlink-xep reference external" href="https://xmpp.org/extensions/xep-0045.html">XEP-0045</a>).</p></li>
|
||||
</ul>
|
||||
<section id="server-specific-instructions">
|
||||
<h2>Server-specific instructions<a class="headerlink" href="#server-specific-instructions" title="Link to this heading">¶</a></h2>
|
||||
<section id="prosody">
|
||||
<h3>Prosŏdy<a class="headerlink" href="#prosody" title="Link to this heading">¶</a></h3>
|
||||
<p>Install the <a class="reference external" href="https://modules.prosody.im/mod_privilege.html">mod_privilege</a>
|
||||
community module with:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>prosodyctl<span class="w"> </span>install<span class="w"> </span>--server<span class="o">=</span>https://modules.prosody.im/rocks/<span class="w"> </span>mod_privilege
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>In <code class="docutils literal notranslate"><span class="pre">prosody.cfg.lua</span></code>, add <code class="docutils literal notranslate"><span class="pre">mod_privilege</span></code> to the <code class="docutils literal notranslate"><span class="pre">modules_enabled</span></code> list, and
|
||||
declare slidgram privileges in the appropriate virtualhost block:</p>
|
||||
<div class="highlight-lua notranslate"><div class="highlight"><pre><span></span><span class="kd">local</span><span class="w"> </span><span class="nv">_privileges</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nv">roster</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"both"</span><span class="p">;</span><span class="w"> </span><span class="c1">-- for adding/removing contacts from the users' rosters</span>
|
||||
<span class="w"> </span><span class="nv">message</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"outgoing"</span><span class="p">;</span><span class="w"> </span><span class="c1">-- for reflecting messages sent by the user themselve from official Telegram apps</span>
|
||||
<span class="w"> </span><span class="nv">iq</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="p">[</span><span class="s2">"http://jabber.org/protocol/pubsub"</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"both"</span><span class="p">;</span><span class="w"> </span><span class="c1">-- for PEP Bookmarks</span>
|
||||
<span class="w"> </span><span class="p">[</span><span class="s2">"http://jabber.org/protocol/pubsub#owner"</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"set"</span><span class="p">;</span><span class="w"> </span><span class="c1">-- for Message Display Synchronization</span>
|
||||
<span class="w"> </span><span class="p">[</span><span class="s2">"urn:xmpp:http:upload:0"</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"get"</span><span class="p">;</span><span class="w"> </span><span class="c1">-- for HTTP Upload on behalf of users</span>
|
||||
<span class="w"> </span><span class="p">}</span>
|
||||
<span class="p">};</span>
|
||||
|
||||
<span class="nv">VirtualHost</span><span class="w"> </span><span class="s2">"example.org"</span>
|
||||
<span class="w"> </span><span class="nv">privileged_entities</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
||||
<span class="w"> </span><span class="p">[</span><span class="s2">"telegram.example.org"</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nv">_privileges</span><span class="p">;</span>
|
||||
<span class="w"> </span><span class="p">}</span>
|
||||
|
||||
<span class="nv">Component</span><span class="w"> </span><span class="s2">"telegram.example.org"</span>
|
||||
<span class="w"> </span><span class="nv">modules_enabled</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="s2">"privilege"</span><span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Then either restart the prosody server, or reload the config.
|
||||
You might need to use
|
||||
<a class="reference external" href="https://modules.prosody.im/mod_reload_components.html">mod_reload_component</a>,
|
||||
and activate/deactivate hosts
|
||||
for all changes to be taken into account
|
||||
(restarting prosody is the easiest way to go).</p>
|
||||
</section>
|
||||
<section id="ejabberd">
|
||||
<h3>ejabberd<a class="headerlink" href="#ejabberd" title="Link to this heading">¶</a></h3>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">acl</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">slidge_acl</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">server</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">"telegram.example.org"</span>
|
||||
|
||||
<span class="nt">access_rules</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">slidge_rule</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">allow</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_acl</span>
|
||||
|
||||
<span class="nt">modules</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">mod_privilege</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">roster</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">both</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_rule</span>
|
||||
<span class="w"> </span><span class="nt">message</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">outgoing</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_rule</span>
|
||||
<span class="w"> </span><span class="nt">iq</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="s">"http://jabber.org/protocol/pubsub"</span><span class="p p-Indicator">:</span>
|
||||
<span class="w"> </span><span class="nt">both</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_rule</span>
|
||||
<span class="w"> </span><span class="s">"http://jabber.org/protocol/pubsub#owner"</span><span class="p p-Indicator">:</span>
|
||||
<span class="w"> </span><span class="nt">set</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_rule</span>
|
||||
<span class="w"> </span><span class="s">"urn:xmpp:http:upload:0"</span><span class="p p-Indicator">:</span>
|
||||
<span class="w"> </span><span class="nt">get</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">slidge_rule</span>
|
||||
<span class="w"> </span><span class="nt">mod_roster</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">versioning</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="next-step">
|
||||
<h2>Next step<a class="headerlink" href="#next-step" title="Link to this heading">¶</a></h2>
|
||||
<p>Learn about about slidgram’s <a class="reference internal" href="config.html#config"><span class="std std-ref">configuration</span></a> to tune its behaviour to your liking.</p>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="config.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Configuration</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="attachments.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Attachments</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2026, the slidgram contributors
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
<div class="icons">
|
||||
<a class="muted-link " href="https://codeberg.org/slidge/slidgram" aria-label="Codeberg"><svg xmlns="http://www.w3.org/2000/svg"
|
||||
aria-label="Codeberg" role="img"
|
||||
viewBox="55 65 400 390">
|
||||
<defs>
|
||||
<linearGradient id="A" x1="259.804" x2="383.132" y1="161.4" y2="407.835" gradientUnits="userSpaceOnUse">
|
||||
<stop offset="0" stop-color="#ffffff" stop-opacity="0"/>
|
||||
<stop offset=".5" stop-color="#71c2ff"/>
|
||||
<stop offset="1" stop-color="#39aaff"/>
|
||||
</linearGradient>
|
||||
</defs>
|
||||
<path fill="url(#A)"
|
||||
d="M259.804 161.4c-.44 0-1.1 0-1.32.44l-.44 1.1L332.04 440.21a192.039 192.039 0 0 0 86.77-74.437L261.125 162.06a1.762 1.762 0 0 0-1.321-.661z"
|
||||
opacity=".5" paint-order="stroke markers fill"/>
|
||||
<path fill="#2185d0"
|
||||
d="M255.3 71.8a192 192 0 0 0-162 294l160.1-207c.5-.6 1.5-1 2.6-1s2 .4 2.6 1l160 207a192 192 0 0 0 29.4-102c0-106-86-192-192-192a192 192 0 0 0-.7 0z"
|
||||
paint-order="stroke markers fill"/>
|
||||
</svg>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Privileges</a><ul>
|
||||
<li><a class="reference internal" href="#server-specific-instructions">Server-specific instructions</a><ul>
|
||||
<li><a class="reference internal" href="#prosody">Prosŏdy</a></li>
|
||||
<li><a class="reference internal" href="#ejabberd">ejabberd</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#next-step">Next step</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../_static/scripts/furo.js?v=46bd48cc"></script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,403 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../">
|
||||
<head><meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../genindex.html"><link rel="search" title="Search" href="../search.html"><link rel="next" title="Attachments" href="attachments.html"><link rel="prev" title="Installation" href="install.html">
|
||||
|
||||
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
|
||||
<title>Quick start - slidgram documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d111a655" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=7bdb33bb" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=8dab3a3b" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f2f2f2;
|
||||
--color-code-foreground: #1e1e1e;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
|
||||
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
|
||||
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
|
||||
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
|
||||
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
|
||||
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
|
||||
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
|
||||
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
|
||||
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
|
||||
<circle cx="14.5" cy="9.55" r="3.6"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark, in dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
|
||||
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
|
||||
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
|
||||
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
|
||||
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
|
||||
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
|
||||
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
|
||||
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
|
||||
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
||||
<path d="M13.5 6.5l4 4" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-eye" viewBox="0 0 24 24">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
||||
<path
|
||||
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
|
||||
<path d="M20 21l2 -2l-2 -2" />
|
||||
<path d="M17 17l-2 2l2 2" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
|
||||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../index.html"><div class="brand">slidgram documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||||
|
||||
<span class="sidebar-brand-text">slidgram documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">For admins</a><input aria-label="Toggle navigation of For admins" checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="install.html">Installation</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Quick start</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="attachments.html">Attachments</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="privileges.html">Privileges</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="config.html">Configuration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="examples/index.html">XMPP server configs examples</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../user/index.html">For users</a><input aria-label="Toggle navigation of For users" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/registration.html">Registration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/usage.html">Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../user/features.html">Features</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
<div class="view-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/src/branch/main/docs/source/admin/quickstart.rst" title="View this page">
|
||||
<svg><use href="#svg-eye"></use></svg>
|
||||
<span class="visually-hidden">View this page</span>
|
||||
</a>
|
||||
</div><div class="edit-this-page">
|
||||
<a class="muted-link" href="https://codeberg.org/slidge/slidgram/_edit/main/docs/source/admin/quickstart.rst" rel="edit" title="Edit this page">
|
||||
<svg><use href="#svg-pencil"></use></svg>
|
||||
<span class="visually-hidden">Edit this page</span>
|
||||
</a>
|
||||
</div><div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
|
||||
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
|
||||
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main" id="furo-main-content">
|
||||
<section id="quick-start">
|
||||
<span id="quickstart"></span><h1>Quick start<a class="headerlink" href="#quick-start" title="Link to this heading">¶</a></h1>
|
||||
<section id="setup-an-xmpp-server-component">
|
||||
<span id="setup-component"></span><h2>Setup an XMPP server component<a class="headerlink" href="#setup-an-xmpp-server-component" title="Link to this heading">¶</a></h2>
|
||||
<p>slidgram uses the <a class="reference external" href="https://xmpp.org/extensions/xep-0114.html">Jabber Component Protocol</a> to
|
||||
connect to an XMPP server.
|
||||
slidgram itself needs to have a JID without a local part, such as <code class="docutils literal notranslate"><span class="pre">telegram.example.org</span></code>.
|
||||
In a typical deployment, slidgram runs on the same host as the XMPP server and connects to it via <code class="docutils literal notranslate"><span class="pre">localhost</span></code>.
|
||||
This requires adequate configuration of the XMPP server, and depends on the XMPP server software you are using.</p>
|
||||
<p>This documentation explains how to do that for
|
||||
<a class="reference external" href="https://prosody.im/doc/components">prosody</a>
|
||||
and <a class="reference external" href="https://docs.ejabberd.im/developer/hosts/">ejabberd</a>.
|
||||
It might be outdated and you may want to check the official, up-to-date documentation of the XMPP server you are using.
|
||||
If you know how to set up slidge with other XMPP servers, please contribute to the docs. ;-)</p>
|
||||
<section id="id1">
|
||||
<h3>Prosŏdy<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h3>
|
||||
<p>Add a component block below the appropriate virtualhost in <code class="docutils literal notranslate"><span class="pre">prosody.cfg.lua</span></code></p>
|
||||
<div class="highlight-lua notranslate"><div class="highlight"><pre><span></span><span class="nv">Component</span><span class="w"> </span><span class="s2">"telegram.example.org"</span>
|
||||
<span class="w"> </span><span class="nv">component_secret</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"some-secret-string"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="id2">
|
||||
<h3>ejabberd<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h3>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">listen</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span>
|
||||
<span class="w"> </span><span class="nt">ip</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">127.0.0.1</span>
|
||||
<span class="w"> </span><span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5347</span>
|
||||
<span class="w"> </span><span class="nt">module</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ejabberd_service</span>
|
||||
<span class="w"> </span><span class="nt">hosts</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">telegram.example.org</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">some-secret-string</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section id="launch-the-daemon">
|
||||
<h2>Launch the daemon<a class="headerlink" href="#launch-the-daemon" title="Link to this heading">¶</a></h2>
|
||||
<p>Start slidgram with:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>slidgram<span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>--jid<span class="w"> </span>telegram.example.org<span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>--secret<span class="w"> </span>some-secret-string<span class="w"> </span><span class="se">\</span>
|
||||
<span class="w"> </span>--home-dir<span class="w"> </span>/somewhere/writable
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="next-steps">
|
||||
<h2>Next steps<a class="headerlink" href="#next-steps" title="Link to this heading">¶</a></h2>
|
||||
<p>Next, you probably want to set up <a class="reference internal" href="attachments.html#attachments"><span class="std std-ref">attachments</span></a> to support bridging files from Telegram to XMPP.</p>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="attachments.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Attachments</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="install.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Installation</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2026, the slidgram contributors
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
<div class="icons">
|
||||
<a class="muted-link " href="https://codeberg.org/slidge/slidgram" aria-label="Codeberg"><svg xmlns="http://www.w3.org/2000/svg"
|
||||
aria-label="Codeberg" role="img"
|
||||
viewBox="55 65 400 390">
|
||||
<defs>
|
||||
<linearGradient id="A" x1="259.804" x2="383.132" y1="161.4" y2="407.835" gradientUnits="userSpaceOnUse">
|
||||
<stop offset="0" stop-color="#ffffff" stop-opacity="0"/>
|
||||
<stop offset=".5" stop-color="#71c2ff"/>
|
||||
<stop offset="1" stop-color="#39aaff"/>
|
||||
</linearGradient>
|
||||
</defs>
|
||||
<path fill="url(#A)"
|
||||
d="M259.804 161.4c-.44 0-1.1 0-1.32.44l-.44 1.1L332.04 440.21a192.039 192.039 0 0 0 86.77-74.437L261.125 162.06a1.762 1.762 0 0 0-1.321-.661z"
|
||||
opacity=".5" paint-order="stroke markers fill"/>
|
||||
<path fill="#2185d0"
|
||||
d="M255.3 71.8a192 192 0 0 0-162 294l160.1-207c.5-.6 1.5-1 2.6-1s2 .4 2.6 1l160 207a192 192 0 0 0 29.4-102c0-106-86-192-192-192a192 192 0 0 0-.7 0z"
|
||||
paint-order="stroke markers fill"/>
|
||||
</svg>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Quick start</a><ul>
|
||||
<li><a class="reference internal" href="#setup-an-xmpp-server-component">Setup an XMPP server component</a><ul>
|
||||
<li><a class="reference internal" href="#id1">Prosŏdy</a></li>
|
||||
<li><a class="reference internal" href="#id2">ejabberd</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#launch-the-daemon">Launch the daemon</a></li>
|
||||
<li><a class="reference internal" href="#next-steps">Next steps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../_static/scripts/furo.js?v=46bd48cc"></script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user