mirror of
https://github.com/simplex-chat/simplex-chat.git
synced 2026-03-31 20:36:19 +00:00
1096 lines
67 KiB
HTML
1096 lines
67 KiB
HTML
|
||
<!DOCTYPE html>
|
||
<html lang="en"
|
||
|
||
|
||
dir="ltr"
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
>
|
||
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<title>Hosting your own SMP Server</title>
|
||
<meta name="Content-Type" content="text/html;charset=utf-8"/>
|
||
|
||
<link rel="icon" type="image/png" sizes="96x96" href="/img/favicon.ico"/>
|
||
<link href="/css/tailwind.css" rel="stylesheet"/>
|
||
<link id="prism-theme" rel="stylesheet" href="/css/prism-light.min.css"/>
|
||
<link href="/css/style.css" rel="stylesheet"/>
|
||
<link rel="stylesheet" href="/css/doc.css"/>
|
||
<script async defer src="https://buttons.github.io/buttons.js"></script>
|
||
</head>
|
||
|
||
<body class="bg-[#F3F6F7] dark:bg-[#0C0B13]">
|
||
<section class="w-full bg-transparent fixed top-0 z-50">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<header class="">
|
||
<div class="flex items-center flex-row justify-end m-auto px-4 lg:px-7 h-[66px]">
|
||
<a href="/" class="h-full hidden dark:hidden lg:flex items-center ltr:mr-auto rtl:ml-auto"><img class="w-auto max-h-[50px] pr-10" src="/img/new/logo-light.png" alt="logo" /></a>
|
||
<a href="/" class="h-full hidden dark:lg:flex items-center ltr:mr-auto rtl:ml-auto"><img class="w-auto max-h-[50px] pr-10" src="/img/new/logo-dark.png" alt="logo" /></a>
|
||
<a href="/" class="dark:hidden lg:hidden ltr:mr-auto rtl:ml-auto"><img class="h-[32px]" src="/img/new/logo-symbol-light.svg" alt="" srcset=""></a>
|
||
<a href="/" class="hidden dark:inline-block dark:lg:hidden lg:hidden ltr:mr-auto rtl:ml-auto"><img class="h-[32px]" src="/img/new/logo-symbol-dark.svg" alt="" srcset=""></a>
|
||
|
||
<nav class="bg-[#F0F1F2] dark:bg-gradient-radial-mobile dark:lg:bg-none lg:bg-transparent fixed top-[66px] left-0 right-0 bottom-0 lg:top-0 lg:relative" id="menu">
|
||
<div class="flex flex-col lg:flex-row justify-between lg:items-center gap-5 xl:gap-10 px-4 lg:px-0 h-full">
|
||
<ul class="flex flex-col lg:flex-row lg:items-center gap-3 py-4 lg:py-0 lg:gap-5 xl:gap-8">
|
||
|
||
<li class="nav-link relative ">
|
||
<a href="/" class="flex items-center justify-between gap-2 lg:py-5 whitespace-nowrap">
|
||
<span class="text-[16px] leading-[26px] tracking-[0.01em] nav-link-text text-black dark:text-white before:bg-black dark:before:bg-white">Home</span>
|
||
</a>
|
||
</li>
|
||
|
||
<hr class="dark:opacity-[0.1]" >
|
||
|
||
<li class="nav-link relative">
|
||
<a href="javascript:void(0);" class="flex items-center justify-between gap-2 lg:py-5">
|
||
<span class="text-[16px] leading-[26px] tracking-[0.01em] text-black dark:text-white before:bg-black dark:before:bg-white">Guide</span>
|
||
<span href="" id="btn-mobile" class="flex items-center justify-center h-[36px] w-[36px] lg:h-auto lg:w-auto mt-1">
|
||
<svg class="fill-black dark:fill-white" width="10" height="6" viewBox="0 0 10 6" xmlns="http://www.w3.org/2000/svg">
|
||
<path fill-rule="evenodd" clip-rule="evenodd" d="M1.50447 0.902966C1.21571 0.627397 0.747525 0.627397 0.458761 0.902966C0.169996 1.17853 0.169996 1.62532 0.458761 1.90089L4.21933 5.48961C4.25543 5.52406 4.29433 5.5542 4.33533 5.58003C4.62234 5.76088 5.01237 5.73074 5.26504 5.48961L9.02561 1.90089C9.31438 1.62532 9.31438 1.17853 9.02561 0.902966C8.73685 0.627397 8.26867 0.627397 7.97991 0.902966L4.74219 3.99273L1.50447 0.902966Z"/>
|
||
</svg>
|
||
</span>
|
||
</a>
|
||
|
||
<ul class="flex flex-col items-start gap-2 lg:h-fit lg:absolute lg:bg-white dark:lg:bg-black top-full lg:mt-[10px] lg:py-4 min-w-[180px] rounded-md lg:shadow-[0_0_3px_rgb(60_72_88_/_15%)] sub-menu">
|
||
|
||
<li><a href="/docs/guide/readme.html" class=" lg:px-[20px] inline-block whitespace-nowrap">Quick start</a></li>
|
||
|
||
<li><a href="/docs/guide/send-messages.html" class=" lg:px-[20px] inline-block whitespace-nowrap">Sending messages</a></li>
|
||
|
||
<li><a href="/docs/guide/secret-groups.html" class=" lg:px-[20px] inline-block whitespace-nowrap">Secret groups</a></li>
|
||
|
||
<li><a href="/docs/guide/chat-profiles.html" class=" lg:px-[20px] inline-block whitespace-nowrap">Chat profiles</a></li>
|
||
|
||
<li><a href="/docs/guide/managing-data.html" class=" lg:px-[20px] inline-block whitespace-nowrap">Managing data</a></li>
|
||
|
||
<li><a href="/docs/guide/audio-video-calls.html" class=" lg:px-[20px] inline-block whitespace-nowrap">Audio & video Calls</a></li>
|
||
|
||
<li><a href="/docs/guide/privacy-security.html" class=" lg:px-[20px] inline-block whitespace-nowrap">Privacy & security</a></li>
|
||
|
||
<li><a href="/docs/guide/app-settings.html" class=" lg:px-[20px] inline-block whitespace-nowrap">App settings</a></li>
|
||
|
||
<li><a href="/docs/guide/making-connections.html" class=" lg:px-[20px] inline-block whitespace-nowrap">Making connections</a></li>
|
||
|
||
</ul>
|
||
</li>
|
||
|
||
<hr class="dark:opacity-[0.1]" >
|
||
|
||
<li class="nav-link relative">
|
||
<a href="javascript:void(0);" class="flex items-center justify-between gap-2 lg:py-5">
|
||
<span class="text-[16px] leading-[26px] tracking-[0.01em] text-black dark:text-white before:bg-black dark:before:bg-white">Reference</span>
|
||
<span href="" id="btn-mobile" class="flex items-center justify-center h-[36px] w-[36px] lg:h-auto lg:w-auto mt-1">
|
||
<svg class="fill-black dark:fill-white" width="10" height="6" viewBox="0 0 10 6" xmlns="http://www.w3.org/2000/svg">
|
||
<path fill-rule="evenodd" clip-rule="evenodd" d="M1.50447 0.902966C1.21571 0.627397 0.747525 0.627397 0.458761 0.902966C0.169996 1.17853 0.169996 1.62532 0.458761 1.90089L4.21933 5.48961C4.25543 5.52406 4.29433 5.5542 4.33533 5.58003C4.62234 5.76088 5.01237 5.73074 5.26504 5.48961L9.02561 1.90089C9.31438 1.62532 9.31438 1.17853 9.02561 0.902966C8.73685 0.627397 8.26867 0.627397 7.97991 0.902966L4.74219 3.99273L1.50447 0.902966Z"/>
|
||
</svg>
|
||
</span>
|
||
</a>
|
||
|
||
<ul class="flex flex-col items-start gap-2 lg:h-fit lg:absolute lg:bg-white dark:lg:bg-black top-full lg:mt-[10px] lg:py-4 min-w-[180px] rounded-md lg:shadow-[0_0_3px_rgb(60_72_88_/_15%)] sub-menu">
|
||
<li><a href="https://github.com/simplex-chat/simplexmq/blob/stable/protocol/overview-tjr.md"
|
||
target="_blank" class="lg:px-[20px] flex items-center gap-1"
|
||
>Whitepaper
|
||
<svg class="float-right" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg>
|
||
</a></li>
|
||
<li><a href="https://github.com/simplex-chat/simplexmq/blob/stable/protocol/simplex-messaging.md"
|
||
target="_blank" class="lg:px-[20px] flex items-center gap-1"
|
||
>SMP protocol
|
||
<svg class="float-right" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg>
|
||
</a></li>
|
||
<li><a href="/docs/protocol/simplex-chat.html" class="lg:px-[20px] inline-block"
|
||
>Chat protocol</a></li>
|
||
|
||
<hr class=" h-[1px] w-full dark:opacity-[0.1]">
|
||
|
||
|
||
<li><a href="/docs/simplex.html" class=" lg:px-[20px] inline-block whitespace-nowrap">SimpleX platform</a></li>
|
||
|
||
<li><a href="/docs/android.html" class=" lg:px-[20px] inline-block whitespace-nowrap">Accessing Android files</a></li>
|
||
|
||
<li><a href="/docs/sql.html" class=" lg:px-[20px] inline-block whitespace-nowrap">Accessing chat database</a></li>
|
||
|
||
<li><a href="/docs/server.html" class="active lg:px-[20px] inline-block whitespace-nowrap">Host SMP Server</a></li>
|
||
|
||
<li><a href="/docs/xftp-server.html" class=" lg:px-[20px] inline-block whitespace-nowrap">Host XFTP Server</a></li>
|
||
|
||
<li><a href="/docs/webrtc.html" class=" lg:px-[20px] inline-block whitespace-nowrap">WebRTC servers</a></li>
|
||
|
||
<li><a href="/docs/translations.html" class=" lg:px-[20px] inline-block whitespace-nowrap">Translate SimpleX Chat</a></li>
|
||
|
||
|
||
<hr class=" h-[1px] w-full dark:opacity-[0.1]">
|
||
|
||
<li><a href="https://github.com/simplex-chat/simplex-chat/blob/stable/apps/simplex-bot-advanced/Main.hs"
|
||
target="_blank" class="lg:px-[20px] flex items-center gap-1"
|
||
>Chat bot example
|
||
<svg class="float-right" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg>
|
||
</a></li>
|
||
<li><a href="https://github.com/simplex-chat/simplex-chat/tree/stable/packages/simplex-chat-client/typescript"
|
||
target="_blank" class="lg:px-[20px] flex items-center gap-1"
|
||
>TypeScript SDK
|
||
<svg class="float-right" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg>
|
||
</a></li>
|
||
<li><a href="/docs/cli.html" class="lg:px-[20px] inline-block"
|
||
>Terminal CLI</a></li>
|
||
<li><a href="https://github.com/simplex-chat/simplexmq"
|
||
target="_blank" class="lg:px-[20px] flex items-center gap-1"
|
||
>SimpleXMQ
|
||
<svg class="float-right" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg>
|
||
</a></li>
|
||
</ul>
|
||
</li>
|
||
|
||
<hr class="dark:opacity-[0.1]" >
|
||
|
||
<li class="nav-link relative ">
|
||
<a href="/blog" class="flex items-center justify-between gap-2 lg:py-5">
|
||
<span class="text-[16px] leading-[26px] tracking-[0.01em] nav-link-text text-black dark:text-white before:bg-black dark:before:bg-white">Blog</span>
|
||
</a>
|
||
</li>
|
||
</ul>
|
||
|
||
<a href="https://github.com/simplex-chat/simplex-chat#help-us-with-donations"
|
||
target="_blank" class="whitespace-nowrap flex items-center gap-1 self-center text-white dark:text-black text-[16px] font-medium tracking-[0.02em] rounded-[34px] bg-primary-light dark:bg-primary-dark py-3 lg:py-2 px-20 lg:px-5 mb-16 lg:mb-0"
|
||
>Donate
|
||
</a>
|
||
|
||
<div class="inline-block dark:hidden self-center mt-[8px]">
|
||
<a class="github-button" href="https://github.com/simplex-chat/simplex-chat" data-size="large"
|
||
data-show-count="true" aria-label="Star simplex-chat on GitHub">Star</a>
|
||
</div>
|
||
|
||
<div class="hidden dark:inline-block self-center mt-[8px]">
|
||
<a class="github-button" href="https://github.com/simplex-chat/simplex-chat" data-size="large"
|
||
data-color-scheme="no-preference: dark; light: dark; dark: dark;"
|
||
data-show-count="true" aria-label="Star simplex-chat on GitHub">Star</a>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
|
||
<div class="nav-link relative flag-container">
|
||
<a href="javascript:void(0);" class="flex items-center justify-end ltr:ml-8 ltr:lg:ml-5 ltr:xl:ml-10 rtl:mr-8 rtl:lg:mr-5 rtl:xl:mr-10 h-6 w-8 whitespace-nowrap">
|
||
|
||
|
||
|
||
<img src="/img/flags/en.svg" alt="" srcset="">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</a>
|
||
|
||
<ul class="flex flex-col items-start gap-2 h-fit absolute top-11 -left-10 bg-white dark:bg-black mt-[10px] py-4 min-w-[170px] rounded-md shadow-[0_0_3px_rgb(60_72_88_/_15%)] sub-menu overflow-auto">
|
||
|
||
|
||
|
||
|
||
<li>
|
||
|
||
<a href="/docs/server.html" class="px-[20px] flex items-center gap-4 flag-anchor whitespace-nowrap">
|
||
<img class="h-4" src="/img/flags/en.svg" alt="" srcset="">
|
||
<p>English</p>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li>
|
||
|
||
<a href="/docs/lang/cs/server.html" class="px-[20px] flex items-center gap-4 flag-anchor whitespace-nowrap">
|
||
<img class="h-4" src="/img/flags/cs.svg" alt="" srcset="">
|
||
<p>Čeština</p>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li>
|
||
|
||
<a href="/docs/lang/fr/server.html" class="px-[20px] flex items-center gap-4 flag-anchor whitespace-nowrap">
|
||
<img class="h-4" src="/img/flags/fr.svg" alt="" srcset="">
|
||
<p>Français</p>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
<button href="#" class="flex items-center justify-center h-[36px] w-[36px] ltr:ml-8 ltr:lg:ml-4 ltr:xl:ml-8 rtl:mr-8 rtl:lg:mr-4 rtl:xl:mr-8 theme-switch-btn">
|
||
<img src="/img/new/sun.svg" alt="" srcset="" class="sun">
|
||
<img src="/img/new/moon.svg" alt="" srcset="" class="moon">
|
||
</button>
|
||
|
||
<button href="" id="btn-mobile" class="flex lg:hidden items-center justify-center h-[36px] w-[36px] ltr:ml-8 ltr:lg:ml-5 ltr:xl:ml-10 rtl:mr-8 rtl:lg:mr-5 rtl:xl:mr-10 nav-toggle-btn">
|
||
<img src="/img/new/hamburger.svg" id="hamburger" alt="" srcset="">
|
||
<svg class="fill-black dark:fill-white hidden" id="cross" width="13" height="13" viewBox="0 0 13 13" xmlns="http://www.w3.org/2000/svg">
|
||
<path d="M12.7973 11.5525L7.59762 6.49833L12.7947 1.44675C13.055 1.19371 13.0658 0.771991 12.8188 0.505331C12.5718 0.238674 12.1602 0.227644 11.8999 0.480681L6.65343 5.58028L1.09979 0.182228C0.839522 -0.070157 0.427909 -0.059127 0.18094 0.207531C-0.0660305 0.474191 -0.0552645 0.895911 0.205003 1.14894L5.70862 6.49833L0.20247 11.851C-0.0577975 12.104 -0.0685635 12.5257 0.178407 12.7924C0.306324 12.9306 0.477936 13 0.650181 13C0.811033 13 0.971873 12.9397 1.09726 12.817L6.65343 7.41639L11.9025 12.5186C12.0285 12.6406 12.1893 12.7015 12.3495 12.7015C12.5218 12.7015 12.6934 12.6321 12.8213 12.4939C13.0689 12.2273 13.0582 11.8062 12.7973 11.5525Z" />
|
||
</svg>
|
||
</button>
|
||
</div>
|
||
</header>
|
||
|
||
|
||
<SCript>
|
||
// switch theme
|
||
const sunIcon = document.querySelector('.sun');
|
||
const moonIcon = document.querySelector('.moon');
|
||
|
||
const userTheme = localStorage.getItem('theme');
|
||
const systemTheme = window.matchMedia('(prefers-color-scheme: dark)').matches;
|
||
const prismThemeLink = document.getElementById('prism-theme')
|
||
|
||
const iconToggle = () => {
|
||
sunIcon.classList.toggle('hidden');
|
||
moonIcon.classList.toggle('hidden');
|
||
}
|
||
|
||
const themeCheck = () => {
|
||
if(userTheme === 'dark' || (!userTheme && systemTheme)){
|
||
document.documentElement.classList.add('dark');
|
||
moonIcon.classList.add('hidden');
|
||
if(prismThemeLink){
|
||
prismThemeLink.setAttribute('href','/css/prism-dark.min.css')
|
||
}
|
||
}
|
||
else{
|
||
sunIcon.classList.add('hidden');
|
||
if(prismThemeLink){
|
||
prismThemeLink.setAttribute('href','/css/prism-light.min.css')
|
||
}
|
||
}
|
||
}
|
||
|
||
const themeSwitch = () => {
|
||
if(document.documentElement.classList.contains('dark')){
|
||
document.documentElement.classList.remove('dark');
|
||
localStorage.setItem('theme','light');
|
||
if(prismThemeLink){
|
||
prismThemeLink.setAttribute('href','/css/prism-light.min.css')
|
||
}
|
||
iconToggle();
|
||
}
|
||
else{
|
||
document.documentElement.classList.add('dark');
|
||
localStorage.setItem('theme','dark');
|
||
if(prismThemeLink){
|
||
prismThemeLink.setAttribute('href','/css/prism-dark.min.css')
|
||
}
|
||
iconToggle();
|
||
}
|
||
}
|
||
|
||
const nav = document.querySelector('header nav');
|
||
window.addEventListener('click',(e)=>{
|
||
if(e.target.closest('.nav-link')){
|
||
if(e.target.closest('.nav-link').classList.contains('active')){
|
||
e.target.closest('.nav-link').classList.remove('active');
|
||
}
|
||
else{
|
||
document.querySelectorAll('.nav-link').forEach(el => el.classList.remove('active'))
|
||
e.target.closest('.nav-link').classList.add('active');
|
||
}
|
||
}
|
||
else if(e.target.closest('.nav-toggle-btn')){
|
||
document.body.classList.toggle('lock-scroll');
|
||
if(nav.classList.contains('open')){
|
||
nav.classList.remove('open');
|
||
document.getElementById('hamburger').classList.remove('hidden');
|
||
document.getElementById('cross').classList.add('hidden');
|
||
}
|
||
else{
|
||
nav.classList.add('open');
|
||
document.getElementById('hamburger').classList.add('hidden');
|
||
document.getElementById('cross').classList.remove('hidden');
|
||
}
|
||
}
|
||
else if(e.target.closest('.theme-switch-btn')){
|
||
themeSwitch();
|
||
}
|
||
})
|
||
|
||
themeCheck();
|
||
|
||
const changeHeaderBg = ()=>{
|
||
const header = document.querySelector('header')
|
||
const scrollValue = window.scrollY
|
||
if(scrollValue > 5){
|
||
header.classList.add('bg-primary-bg-light');
|
||
header.classList.add('dark:bg-primary-bg-dark');
|
||
}
|
||
else{
|
||
header.classList.remove('bg-primary-bg-light');
|
||
header.classList.remove('dark:bg-primary-bg-dark');
|
||
}
|
||
}
|
||
|
||
window.addEventListener('scroll',changeHeaderBg);
|
||
</SCript>
|
||
</section>
|
||
|
||
<section id="doc" class="bg-white dark:bg-[#17203D] mt-[66px]">
|
||
<div>
|
||
<main>
|
||
<aside class="sidebar px-4 lg:px-7">
|
||
<div class="h-[66px] lg:h-0">
|
||
<a href="/" class="h-full flex dark:hidden lg:hidden items-center ltr:mr-auto rtl:ml-auto"><img class="w-auto max-h-[50px] pr-10" src="/img/new/logo-light.png" alt="logo"/></a>
|
||
<a href="/" class="h-full hidden dark:flex dark:lg:hidden items-center ltr:mr-auto rtl:ml-auto"><img class="w-auto max-h-[50px] pr-10" src="/img/new/logo-dark.png" alt="logo"/></a>
|
||
</div>
|
||
<ul class="!my-4">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="">Guide</p>
|
||
<ul>
|
||
|
||
<li>
|
||
<a class="" href="/docs/guide/readme.html">Quick start</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/guide/send-messages.html">Sending messages</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/guide/secret-groups.html">Secret groups</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/guide/chat-profiles.html">Chat profiles</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/guide/managing-data.html">Managing data</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/guide/audio-video-calls.html">Audio & video Calls</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/guide/privacy-security.html">Privacy & security</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/guide/app-settings.html">App settings</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/guide/making-connections.html">Making connections</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="">Reference</p>
|
||
<ul>
|
||
|
||
<li>
|
||
<a class="" href="/docs/simplex.html">SimpleX platform</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/android.html">Accessing files in Android app</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/cli.html">Terminal CLI</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/sql.html">Accessing messages in the database</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/contributing.html">Contributing guide</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="active" href="/docs/server.html">Hosting your own SMP Server</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/xftp-server.html">Hosting your own XFTP Server</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/translations.html">Contributing translations to SimpleX Chat</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/webrtc.html">Using custom WebRTC ICE servers in SimpleX Chat</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a class="" href="/docs/xftp-server.html">Hosting your own XFTP Server</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="">Protocol</p>
|
||
<ul>
|
||
|
||
<li>
|
||
<a class="" href="/docs/protocol/simplex-chat.html">SimpleX Chat Protocol</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
|
||
</ul>
|
||
</aside>
|
||
<article class="content px-4 lg:px-7">
|
||
|
||
|
||
|
||
<div class="sticky top-[66px] bg-white dark:bg-[#17203D] z-[49] !py-2 lg:hidden">
|
||
<div class="relative flex items-center justify-between">
|
||
<button class="menu flex items-center gap-2">
|
||
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewBox="0 0 24 24" class="menu-icon h-4 w-4 fill-[rgb(60,60,60)] dark:fill-white">
|
||
<path d="M17,11H3c-0.6,0-1-0.4-1-1s0.4-1,1-1h14c0.6,0,1,0.4,1,1S17.6,11,17,11z"></path>
|
||
<path d="M21,7H3C2.4,7,2,6.6,2,6s0.4-1,1-1h18c0.6,0,1,0.4,1,1S21.6,7,21,7z"></path>
|
||
<path d="M21,15H3c-0.6,0-1-0.4-1-1s0.4-1,1-1h18c0.6,0,1,0.4,1,1S21.6,15,21,15z"></path>
|
||
<path d="M17,19H3c-0.6,0-1-0.4-1-1s0.4-1,1-1h14c0.6,0,1,0.4,1,1S17.6,19,17,19z"></path>
|
||
</svg>
|
||
<span class="!text-[rgb(60,60,60)] dark:!text-white">Menu</span>
|
||
</button>
|
||
|
||
<div class="nav-link">
|
||
<a href="javascript:void(0);" class="flex items-center gap-2 !no-underline !text-[rgb(60,60,60)] dark:!text-white">
|
||
<span class="">On this page</span>
|
||
<span href="" id="btn-mobile" class="flex items-center justify-center h-auto w-auto mt-1">
|
||
<svg class="fill-black dark:fill-white" width="10" height="6" viewBox="0 0 10 6" xmlns="http://www.w3.org/2000/svg">
|
||
<path fill-rule="evenodd" clip-rule="evenodd" d="M1.50447 0.902966C1.21571 0.627397 0.747525 0.627397 0.458761 0.902966C0.169996 1.17853 0.169996 1.62532 0.458761 1.90089L4.21933 5.48961C4.25543 5.52406 4.29433 5.5542 4.33533 5.58003C4.62234 5.76088 5.01237 5.73074 5.26504 5.48961L9.02561 1.90089C9.31438 1.62532 9.31438 1.17853 9.02561 0.902966C8.73685 0.627397 8.26867 0.627397 7.97991 0.902966L4.74219 3.99273L1.50447 0.902966Z"/>
|
||
</svg>
|
||
</span>
|
||
</a>
|
||
|
||
<ul class="flex flex-col items-start gap-2 absolute bg-white dark:bg-black top-full left-0 right-0 mt-[10px] w-full h-auto rounded-md shadow-[0_0_3px_rgb(60_72_88_/_15%)] sub-menu hash-list">
|
||
<li class="mb-5">
|
||
<a href="#" id="back-to-top">Back to top</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div><p>| Updated 31.01.2023 | Languages: EN, <a href="/docs/lang/fr/SERVER.html">FR</a>, <a href="/docs/lang/cs/SERVER.html">CZ</a> |</p>
|
||
<h1 id="hosting-your-own-smp-server" tabindex="-1">Hosting your own SMP Server</h1>
|
||
<h2 id="overview" tabindex="-1">Overview</h2>
|
||
<p>SMP server is the relay server used to pass messages in SimpleX network. SimpleX Chat apps have preset servers (for mobile apps these are smp8, smp9 and <a href="http://smp10.simplex.im">smp10.simplex.im</a>), but you can easily change app configuration to use other servers.</p>
|
||
<p>SimpleX clients only determine which server is used to receive the messages, separately for each contact (or group connection with a group member), and these servers are only temporary, as the delivery address can change.</p>
|
||
<p><em>Please note</em>: when you change the servers in the app configuration, it only affects which server will be used for the new contacts, the existing contacts will not automatically move to the new servers, but you can move them manually using <a href="blog/20221108-simplex-chat-v4.2-security-audit-new-website.html#change-your-delivery-address-beta">"Change receiving address"</a> button in contact/member information pages – it will be automated soon.</p>
|
||
<h2 id="installation" tabindex="-1">Installation</h2>
|
||
<ol start="0">
|
||
<li>
|
||
<p>First, install <code>smp-server</code>:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Manual deployment:</p>
|
||
<ul>
|
||
<li><a href="https://github.com/simplex-chat/simplexmq#using-your-distribution">Compiling from source</a></li>
|
||
<li><a href="https://github.com/simplex-chat/simplexmq#install-binaries">Using pre-compiled binaries</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Alternatively, you can deploy <code>smp-server</code> using:</p>
|
||
<ul>
|
||
<li><a href="https://github.com/simplex-chat/simplexmq#using-docker-1">Docker container</a></li>
|
||
<li><a href="https://github.com/simplex-chat/simplexmq#deploy-smp-server-on-linode">Linode StackScript</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ol>
|
||
<p>Manual installation requires some preliminary actions:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Create user and group for <code>smp-server</code>:</p>
|
||
<pre><code class="language-sh">sudo useradd -m smp
|
||
</code></pre>
|
||
</li>
|
||
<li>
|
||
<p>Create necessary directories and assign permissions:</p>
|
||
<pre><code class="language-sh">sudo mkdir -p /var/opt/simplex /etc/opt/simplex
|
||
sudo chown smp:smp /var/opt/simplex /etc/opt/simplex
|
||
</code></pre>
|
||
</li>
|
||
<li>
|
||
<p>Allow <code>smp-server</code> port in firewall:</p>
|
||
<pre><code class="language-sh"># For Ubuntu
|
||
ufw allow 5223
|
||
</code></pre>
|
||
</li>
|
||
<li>
|
||
<p><strong>Optional</strong> — If you're using distribution with <code>systemd</code>, create <code>/etc/systemd/system/smp-server.service</code> file with the following content:</p>
|
||
<pre><code class="language-sh">[Unit]
|
||
Description=SMP server
|
||
[Service]
|
||
User=smp
|
||
Group=smp
|
||
Type=simple
|
||
ExecStart=smp-server start
|
||
ExecStopPost=/usr/bin/env sh -c '[ -e "/var/opt/simplex/smp-server-store.log" ] && cp "/var/opt/simplex/smp-server-store.log" "/var/opt/simplex/smp-server-store.log.bak"'
|
||
KillSignal=SIGINT
|
||
TimeoutStopSec=infinity
|
||
Restart=always
|
||
RestartSec=10
|
||
LimitNOFILE=65535
|
||
[Install]
|
||
WantedBy=multi-user.target
|
||
</code></pre>
|
||
<p>And execute <code>sudo systemctl daemon-reload</code>.</p>
|
||
</li>
|
||
</ol>
|
||
<h2 id="configuration" tabindex="-1">Configuration</h2>
|
||
<p>To see which options are available, execute <code>smp-server</code> without flags:</p>
|
||
<pre><code class="language-sh">sudo su smp -c smp-server
|
||
|
||
...
|
||
Available commands:
|
||
init Initialize server - creates /etc/opt/simplex and
|
||
/var/opt/simplex directories and configuration files
|
||
start Start server (configuration:
|
||
/etc/opt/simplex/smp-server.ini)
|
||
delete Delete configuration and log files
|
||
</code></pre>
|
||
<p>You can get further help by executing <code>sudo su smp -c "smp-server <command> -h"</code></p>
|
||
<p>After that, we need to configure <code>smp-server</code>:</p>
|
||
<h3 id="interactively" tabindex="-1">Interactively</h3>
|
||
<p>Execute the following command:</p>
|
||
<pre><code class="language-sh">sudo su smp -c "smp-server init"
|
||
</code></pre>
|
||
<p>There are several options to consider:</p>
|
||
<ul>
|
||
<li>
|
||
<p><code>Enable store log to restore queues and messages on server restart (Yn):</code></p>
|
||
<p>Enter <code>y</code> to enable saving and restoring connections and messages when the server is restarted.</p>
|
||
<p><em>Please note</em>: it is important to use SIGINT to restart the server, as otherwise the undelivered messages will not be restored. The connections will be restored irrespective of how the server is restarted, as unlike messages they are added to append-only log on every change.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>Enable logging daily statistics (yN):</code></p>
|
||
<p>Enter <code>y</code> to enable logging statistics in CSV format, e.g. they can be used to show aggregate usage charts in <code>Grafana</code>.</p>
|
||
</li>
|
||
</ul>
|
||
<p>These statistics include daily counts of created, secured and deleted queues, sent and received messages, and also daily, weekly, and monthly counts of active queues (that is, the queues that were used for any messages). We believe that this information does not include anything that would allow correlating different queues as belonging to the same users, but please let us know, confidentially, if you believe that this can be exploited in any way.</p>
|
||
<ul>
|
||
<li>
|
||
<p><code>Require a password to create new messaging queues?</code></p>
|
||
<p>Enter <code>r</code> or your arbitrary password to password-protect <code>smp-server</code>, or <code>n</code> to disable password protection.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>Enter server FQDN or IP address for certificate (127.0.0.1):</code></p>
|
||
<p>Enter your domain or ip address that your smp-server is running on - it will be included in server certificates and also printed as part of server address.</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id="via-command-line-options" tabindex="-1">Via command line options</h3>
|
||
<p>Execute the following command:</p>
|
||
<pre><code class="language-sh">sudo su smp -c "smp-server init -h"
|
||
|
||
...
|
||
Available options:
|
||
-l,--store-log Enable store log for persistence
|
||
-s,--daily-stats Enable logging daily server statistics
|
||
-a,--sign-algorithm ALG Signature algorithm used for TLS certificates:
|
||
ED25519, ED448 (default: ED448)
|
||
--ip IP Server IP address, used as Common Name for TLS online
|
||
certificate if FQDN is not supplied
|
||
(default: "127.0.0.1")
|
||
-n,--fqdn FQDN Server FQDN used as Common Name for TLS online
|
||
certificate
|
||
--no-password Allow creating new queues without password
|
||
--password PASSWORD Set password to create new messaging queues
|
||
-y,--yes Non-interactive initialization using command-line
|
||
options
|
||
-h,--help Show this help text
|
||
</code></pre>
|
||
<p>You should determine which flags are needed for your use-case and then execute <code>smp-server init</code> with <code>-y</code> flag for non-interactive initialization:</p>
|
||
<pre><code class="language-sh">sudo su smp -c "smp-server init -y -<your flag> <your option>"
|
||
</code></pre>
|
||
<p>For example, run:</p>
|
||
<pre><code class="language-sh">sudo su smp -c "smp-server init -y -l --ip 192.168.1.5 --password test"
|
||
</code></pre>
|
||
<p>to initialize your <code>smp-server</code> configuration with:</p>
|
||
<ul>
|
||
<li>restoring connections and messages when the server is restarted (<code>-l</code> flag),</li>
|
||
<li>IP address <code>192.168.1.5</code>,</li>
|
||
<li>protect <code>smp-server</code> with a password <code>test</code>.</li>
|
||
</ul>
|
||
<hr>
|
||
<p>After that, your installation is complete and you should see in your teminal output something like this:</p>
|
||
<pre><code class="language-sh">Certificate request self-signature ok
|
||
subject=CN = 127.0.0.1
|
||
Server initialized, you can modify configuration in /etc/opt/simplex/smp-server.ini.
|
||
Run `smp-server start` to start server.
|
||
----------
|
||
You should store CA private key securely and delete it from the server.
|
||
If server TLS credential is compromised this key can be used to sign a new one, keeping the same server identity and established connections.
|
||
CA private key location: /etc/opt/simplex/ca.key
|
||
----------
|
||
SMP server v3.4.0
|
||
Fingerprint: d5fcsc7hhtPpexYUbI2XPxDbyU2d3WsVmROimcL90ss=
|
||
Server address: smp://d5fcsc7hhtPpexYUbI2XPxDbyU2d3WsVmROimcL90ss=:V8ONoJ6ICwnrZnTC_QuSHfCEYq53uLaJKQ_oIC6-ve8=@<hostnames>
|
||
</code></pre>
|
||
<p>The server address above should be used in your client configuration and if you added server password it should only be shared with the other people when you want to allow them to use your server to receive the messages (all your contacts will be able to send messages, as it does not require a password). If you passed IP address or hostnames during the initialisation, they will be printed as part of server address, otherwise replace <code><hostnames></code> with the actual server addresses.</p>
|
||
<h2 id="documentation" tabindex="-1">Documentation</h2>
|
||
<p>All necessary files for <code>smp-server</code> are located in <code>/etc/opt/simplex/</code> folder.</p>
|
||
<p>Stored messages, connections, statistics and server log are located in <code>/var/opt/simplex/</code> folder.</p>
|
||
<h3 id="smp-server-address" tabindex="-1">SMP server address</h3>
|
||
<p>SMP server address has the following format:</p>
|
||
<pre><code>smp://<fingerprint>[:<password>]@<public_hostname>[,<onion_hostname>]
|
||
</code></pre>
|
||
<ul>
|
||
<li>
|
||
<p><code><fingerprint></code></p>
|
||
<p>Your <code>smp-server</code> fingerprint of certificate. You can check your certificate fingerprint in <code>/etc/opt/simplex/fingerprint</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>optional</strong> <code><password></code></p>
|
||
<p>Your configured password of <code>smp-server</code>. You can check your configured pasword in <code>/etc/opt/simplex/smp-server.ini</code>, under <code>[AUTH]</code> section in <code>create_password:</code> field.</p>
|
||
</li>
|
||
<li>
|
||
<p><code><public_hostname></code>, <strong>optional</strong> <code><onion_hostname></code></p>
|
||
<p>Your configured hostname(s) of <code>smp-server</code>. You can check your configured hosts in <code>/etc/opt/simplex/smp-server.ini</code>, under <code>[TRANSPORT]</code> section in <code>host:</code> field.</p>
|
||
</li>
|
||
</ul>
|
||
<h3 id="systemd-commands" tabindex="-1">Systemd commands</h3>
|
||
<p>To start <code>smp-server</code> on host boot, run:</p>
|
||
<pre><code class="language-sh">sudo systemctl enable smp-server.service
|
||
|
||
Created symlink /etc/systemd/system/multi-user.target.wants/smp-server.service → /etc/systemd/system/smp-server.service.
|
||
</code></pre>
|
||
<p>To start <code>smp-server</code>, run:</p>
|
||
<pre><code class="language-sh">sudo systemctl start smp-server.service
|
||
</code></pre>
|
||
<p>To check status of <code>smp-server</code>, run:</p>
|
||
<pre><code class="language-sh">sudo systemctl status smp-server.service
|
||
|
||
● smp-server.service - SMP server
|
||
Loaded: loaded (/etc/systemd/system/smp-server.service; enabled; vendor preset: enabled)
|
||
Active: active (running) since Sat 2022-11-23 19:23:21 UTC; 1min 48s ago
|
||
Main PID: 30878 (smp-server)
|
||
CGroup: /docker/5588ab759e80546b4296a7c50ffebbb1fb7b55b8401300e9201313b720989aa8/system.slice/smp-server.service
|
||
└─30878 smp-server start
|
||
|
||
Nov 23 19:23:21 5588ab759e80 systemd[1]: Started SMP server.
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: SMP server v3.4.0
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: Fingerprint: d5fcsc7hhtPpexYUbI2XPxDbyU2d3WsVmROimcL90ss=
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: Server address: smp://d5fcsc7hhtPpexYUbI2XPxDbyU2d3WsVmROimcL90ss=:V8ONoJ6ICwnrZnTC_QuSHfCEYq53uLaJKQ_oIC6-ve8=@<hostnames>
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: Store log: /var/opt/simplex/smp-server-store.log
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: Listening on port 5223 (TLS)...
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: not expiring inactive clients
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: creating new queues requires password
|
||
</code></pre>
|
||
<p>To stop <code>smp-server</code>, run:</p>
|
||
<pre><code class="language-sh">sudo systemctl stop smp-server.service
|
||
</code></pre>
|
||
<p>To check tail of <code>smp-server</code> log, run:</p>
|
||
<pre><code class="language-sh">sudo journalctl -fu smp-server.service
|
||
|
||
Nov 23 19:23:21 5588ab759e80 systemd[1]: Started SMP server.
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: SMP server v3.4.0
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: Fingerprint: d5fcsc7hhtPpexYUbI2XPxDbyU2d3WsVmROimcL90ss=
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: Server address: smp://d5fcsc7hhtPpexYUbI2XPxDbyU2d3WsVmROimcL90ss=:V8ONoJ6ICwnrZnTC_QuSHfCEYq53uLaJKQ_oIC6-ve8=@<hostnames>
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: Store log: /var/opt/simplex/smp-server-store.log
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: Listening on port 5223 (TLS)...
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: not expiring inactive clients
|
||
Nov 23 19:23:21 5588ab759e80 smp-server[30878]: creating new queues requires password
|
||
</code></pre>
|
||
<h3 id="monitoring" tabindex="-1">Monitoring</h3>
|
||
<p>You can enable <code>smp-server</code> statistics for <code>Grafana</code> dashboard by setting value <code>on</code> in <code>/etc/opt/simplex/smp-server.ini</code>, under <code>[STORE_LOG]</code> section in <code>log_stats:</code> field.</p>
|
||
<p>Logs will be stored as <code>csv</code> file in <code>/var/opt/simplex/smp-server-stats.daily.log</code>. Fields for the <code>csv</code> file are:</p>
|
||
<pre><code class="language-sh">fromTime,qCreated,qSecured,qDeleted,msgSent,msgRecv,dayMsgQueues,weekMsgQueues,monthMsgQueues
|
||
</code></pre>
|
||
<ul>
|
||
<li>
|
||
<p><code>fromTime</code> - timestamp; date and time of event</p>
|
||
</li>
|
||
<li>
|
||
<p><code>qCreated</code> - int; created queues</p>
|
||
</li>
|
||
<li>
|
||
<p><code>qSecured</code> - int; established queues</p>
|
||
</li>
|
||
<li>
|
||
<p><code>qDeleted</code> - int; deleted queues</p>
|
||
</li>
|
||
<li>
|
||
<p><code>msgSent</code> - int; sent messages</p>
|
||
</li>
|
||
<li>
|
||
<p><code>msgRecv</code> - int; received messages</p>
|
||
</li>
|
||
<li>
|
||
<p><code>dayMsgQueues</code> - int; active queues in a day</p>
|
||
</li>
|
||
<li>
|
||
<p><code>weekMsgQueues</code> - int; active queues in a week</p>
|
||
</li>
|
||
<li>
|
||
<p><code>monthMsgQueues</code> - int; active queues in a month</p>
|
||
</li>
|
||
</ul>
|
||
<p>To import <code>csv</code> to <code>Grafana</code> one should:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Install Grafana plugin: <a href="https://grafana.com/grafana/plugins/marcusolsson-csv-datasource/">Grafana - CSV datasource</a></p>
|
||
</li>
|
||
<li>
|
||
<p>Allow local mode by appending following:</p>
|
||
<pre><code class="language-sh">[plugin.marcusolsson-csv-datasource]
|
||
allow_local_mode = true
|
||
</code></pre>
|
||
<p>... to <code>/etc/grafana/grafana.ini</code></p>
|
||
</li>
|
||
<li>
|
||
<p>Add a CSV data source:</p>
|
||
<ul>
|
||
<li>In the side menu, click the Configuration tab (cog icon)</li>
|
||
<li>Click Add data source in the top-right corner of the Data Sources tab</li>
|
||
<li>Enter "CSV" in the search box to find the CSV data source</li>
|
||
<li>Click the search result that says "CSV"</li>
|
||
<li>In URL, enter a file that points to CSV content</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>You're done! You should be able to create your own dashboard with statistics.</p>
|
||
</li>
|
||
</ol>
|
||
<p>For further documentation, see: <a href="https://grafana.github.io/grafana-csv-datasource/">CSV Data Source for Grafana - Documentation</a></p>
|
||
<h3 id="configuring-the-app-to-use-the-server" tabindex="-1">Configuring the app to use the server</h3>
|
||
<p>To configure the app to use your messaging server copy it's full address, including password, and add it to the app. You have an option to use your server together with preset servers or without them - you can remove or disable them.</p>
|
||
<p>It is also possible to share the address of your server with your friends by letting them scan QR code from server settings - it will include server password, so they will be able to receive messages via your server as well.</p>
|
||
<p><em>Please note</em>: you need SMP server version 4.0 to have password support. If you already have a deployed server, you can add password by adding it to server INI file.</p>
|
||
<p><img src="./server_config_1.png" width="288"> <img src="./server_config_2.png" width="288"> <img src="./server_config_3.png" width="288"></p>
|
||
</div>
|
||
</article>
|
||
</main>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<section class="bg-[#D9E7ED] dark:bg-[#0E2B57] py-[50px]">
|
||
<div class="container">
|
||
<div class="flex flex-col lg:flex-row justify-between">
|
||
<div class="flex flex-col items-center lg:items-start">
|
||
<a href="/" class="h-full mb-14 dark:hidden"><img class="w-auto h-[32px]" src="/img/new/logo-light.png" alt="logo" /></a>
|
||
<a href="/" class="h-full mb-14 hidden dark:inline-block"><img class="w-auto h-[32px]" src="/img/new/logo-dark.png" alt="logo" /></a>
|
||
|
||
<div class="flex flex-col items-center lg:items-start lg:flex-row gap-[150px] lg:gap-[350px]">
|
||
<div class="flex flex-col items-center lg:items-start">
|
||
<a href="https://github.com/simplex-chat/simplexmq/blob/stable/protocol/overview-tjr.md"
|
||
target="_blank"
|
||
class="text-grey-black dark:text-white text-[14px] font-medium leading-[28px] tracking-[0.01em] mb-3 flex items-center gap-1">
|
||
SimpleX Whitepaper
|
||
<svg class="float-right" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg>
|
||
</a>
|
||
<a href="https://github.com/simplex-chat/simplex-chat/blob/stable/docs/protocol/simplex-chat.md"
|
||
target="_blank"
|
||
class="text-grey-black dark:text-white text-[14px] font-medium leading-[28px] tracking-[0.01em] mb-3 flex items-center gap-1">
|
||
SimpleX Chat protocol
|
||
<svg class="float-right" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg>
|
||
</a>
|
||
<a href="https://github.com/simplex-chat/simplex-chat/blob/stable/PRIVACY.md"
|
||
target="_blank"
|
||
class="text-grey-black dark:text-white text-[14px] font-medium leading-[28px] tracking-[0.01em] mb-3 flex items-center gap-1">
|
||
Terms & Privacy Policy
|
||
<svg class="float-right" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg>
|
||
</a>
|
||
<a href="https://github.com/simplex-chat/simplex-chat#help-us-with-donations"
|
||
target="_blank"
|
||
class="text-grey-black dark:text-white text-[14px] font-medium leading-[28px] tracking-[0.01em] mb-3 flex items-center gap-1">
|
||
Donate
|
||
<svg class="float-right" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg>
|
||
</a>
|
||
</div>
|
||
<div class="flex flex-col items-center lg:items-start">
|
||
<a href="https://github.com/simplex-chat/simplex-chat/blob/stable/docs/CLI.md"
|
||
target="_blank"
|
||
class="text-grey-black dark:text-white text-[14px] font-medium leading-[28px] tracking-[0.01em] mb-3 flex items-center gap-1">
|
||
Terminal CLI
|
||
<svg class="float-right" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg>
|
||
</a>
|
||
<a href="https://github.com/simplex-chat/simplex-chat/tree/stable/packages/simplex-chat-client/typescript"
|
||
target="_blank"
|
||
class="text-grey-black dark:text-white text-[14px] font-medium leading-[28px] tracking-[0.01em] mb-3 flex items-center gap-1">
|
||
TypeScript SDK
|
||
<svg class="float-right" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg>
|
||
</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<article class="mt-10 lg:mt-0">
|
||
<div class="h-[40px] flex gap-4 justify-center">
|
||
<a href="https://simplex.chat/contact#/?v=1&smp=smp%3A%2F%2FPQUV2eL0t7OStZOoAsPEV2QYWt4-xilbakvGUGOItUo%3D%40smp6.simplex.im%2FK1rslx-m5bpXVIdMZg9NLUZ_8JBm8xTt%23%2F%3Fv%3D1%26dh%3DMCowBQYDK2VuAyEALDeVe-sG8mRY22LsXlPgiwTNs9dbiLrNuA7f3ZMAJ2w%253D%26srv%3Dbylepyau3ty4czmn77q4fglvperknl4bi2eb2fdy2bh4jxtf32kf73yd.onion">
|
||
<svg class="fill-primary-light dark:fill-primary-dark" width="40" height="40" viewBox="0 0 54 54" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||
<path fill-rule="evenodd" clip-rule="evenodd" d="M26.585 0C11.9025 0 0 11.9025 0 26.585C0 41.2674 11.9025 53.1699 26.585 53.1699C41.2674 53.1699 53.1699 41.2674 53.1699 26.585C53.1699 11.9025 41.2674 0 26.585 0ZM11.3862 17.3518L17.6366 23.4373L23.9313 17.3088L17.6787 11.2209L20.866 8.1179L27.1187 14.2061L33.4932 8L36.6199 11.044L30.2448 17.25L36.4982 23.3379L42.8733 17.1321L46 20.1761L39.6249 26.3818L45.8789 32.4702L42.6916 35.5732L36.4376 29.4848L30.0631 35.6906L36.3171 41.7791L33.1299 44.8821L26.8759 38.7936L20.5026 45L17.3759 41.956L23.8003 35.693L17.5493 29.6073L11.1255 35.8621L8 32.8194L14.4244 26.5646L8.17397 20.4792L11.3862 17.3518ZM27.0125 32.5656L33.311 26.4408L27.0576 20.3535L27.0568 20.3516L20.7615 26.4799L27.0125 32.5656Z" fill="#0053D0"/>
|
||
</svg>
|
||
</a>
|
||
<a href="https://github.com/simplex-chat" target="_blank">
|
||
<svg class="fill-primary-light dark:fill-primary-dark" width="40" height="40" viewBox="0 0 41 41" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||
<path d="M20.2907 0.926758C9.24635 0.926758 0.290527 10.1075 0.290527 21.4331C0.290527 30.4933 6.02118 38.18 13.9679 40.8915C14.9674 41.0813 15.3344 40.4467 15.3344 39.905C15.3344 39.4161 15.3158 37.8007 15.3072 36.0872C9.74314 37.3277 8.56906 33.6677 8.56906 33.6677C7.65927 31.2975 6.3484 30.6672 6.3484 30.6672C4.53379 29.3945 6.48519 29.4206 6.48519 29.4206C8.49355 29.5653 9.55105 31.5338 9.55105 31.5338C11.3349 34.6688 14.2298 33.7624 15.3711 33.2385C15.5506 31.9131 16.069 31.0085 16.6409 30.4964C12.1986 29.9779 7.52878 28.2195 7.52878 20.3621C7.52878 18.1232 8.31007 16.294 9.58947 14.8579C9.38181 14.3414 8.69723 12.2557 9.78322 9.43111C9.78322 9.43111 11.4627 8.87998 15.2847 11.5331C16.8801 11.0787 18.591 10.8509 20.2907 10.8431C21.9904 10.8509 23.7027 11.0787 25.301 11.5331C29.1183 8.87998 30.7955 9.43111 30.7955 9.43111C31.8842 12.2557 31.1992 14.3414 30.9916 14.8579C32.274 16.294 33.05 18.1232 33.05 20.3621C33.05 28.2382 28.3712 29.9724 23.9176
|
||
30.4801C24.635 31.1165 25.2742 32.3644 25.2742 34.2776C25.2742 37.0214 25.251 39.2296 25.251 39.905C25.251 40.4507 25.611 41.0902 26.6248 40.8888C34.5672 38.1742 40.2905 30.4903 40.2905 21.4331C40.2905 10.1075 31.336 0.926758 20.2907 0.926758Z" />
|
||
</svg>
|
||
</a>
|
||
<a href="https://www.reddit.com/r/SimpleXChat/" target="_blank">
|
||
<svg class="fill-primary-light dark:fill-primary-dark" width="40" height="40" viewBox="0 0 41 41" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||
<path fill-rule="evenodd" clip-rule="evenodd" d="M20.874 40.9268C31.9197 40.9268 40.874 31.9724 40.874 20.9268C40.874 9.88108 31.9197 0.926758 20.874 0.926758C9.82834 0.926758 0.874023 9.88108 0.874023 20.9268C0.874023 31.9724 9.82834 40.9268 20.874 40.9268ZM30.4091 16.615C31.9031 16.615 33.1157 17.8276 33.1157 19.3216C33.1157 20.426 32.4445 21.3787 31.5567 21.8118C31.6 22.0716 31.6217 22.3315 31.6217 22.613C31.6217 26.7705 26.7929 30.1268 20.8165 30.1268C14.8402 30.1268 10.0114 26.7705 10.0114 22.613C10.0114 22.3315 10.0331 22.05 10.0764 21.7902C9.12362 21.3571 8.47402 20.426 8.47402 19.3216C8.47402 17.8276 9.68662 16.615 11.1807 16.615C11.8953 16.615 12.5665 16.9181 13.0429 17.3728C14.9051 16.0086 17.4819 15.1642 20.3618 15.0776L21.726 8.6248C21.7693 8.49488 21.8343 8.3866 21.9425 8.32164C22.0508 8.25668 22.1807 8.23504 22.3106 8.25668L26.7929 9.20944C27.0961 8.55984 27.7457 8.12676 28.5035 8.12676C29.5646 8.12676 30.4307 8.99292 30.4307
|
||
10.0539C30.4307 11.115 29.5646 11.9811 28.5035 11.9811C27.4642 11.9811 26.6197 11.1582 26.5764 10.1406L22.5705 9.29604L21.3362 15.0776C24.1512 15.1858 26.7063 16.052 28.5469 17.3728C29.0232 16.8964 29.6728 16.615 30.4091 16.615ZM16.5291 19.3216C15.4681 19.3216 14.602 20.1878 14.602 21.2488C14.602 22.3098 15.4681 23.176 16.5291 23.176C17.5902 23.176 18.4563 22.3098 18.4563 21.2488C18.4563 20.1878 17.5902 19.3216 16.5291 19.3216ZM20.7949 27.7449C21.5311 27.7449 24.0429 27.6582 25.3638 26.3374C25.5587 26.1425 25.5587 25.8394 25.4071 25.6228C25.2122 25.428 24.8874 25.428 24.6925 25.6228C23.848 26.4456 22.0941 26.7488 20.8165 26.7488C19.539 26.7488 17.7634 26.4456 16.9405 25.6228C16.7457 25.428 16.4209 25.428 16.226 25.6228C16.0311 25.8177 16.0311 26.1425 16.226 26.3374C17.5252 27.6366 20.0587 27.7449 20.7949 27.7449ZM23.0902 21.2488C23.0902 22.3098 23.9563 23.176 25.0173 23.176C26.0783 23.176 26.9445 22.3098 26.9445 21.2488C26.9445 20.1878 26.0783
|
||
19.3216 25.0173 19.3216C23.9563 19.3216 23.0902 20.1878 23.0902 21.2488Z" />
|
||
</svg>
|
||
</a>
|
||
<a href="https://twitter.com/simplexchat" target="_blank">
|
||
<svg class="fill-primary-light dark:fill-primary-dark" width="40" height="40" viewBox="0 0 41 41" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||
<path fill-rule="evenodd" clip-rule="evenodd" d="M20.4575 40.9268C31.5032 40.9268 40.4575 31.9725 40.4575 20.9268C40.4575 9.88106 31.5032 0.926758 20.4575 0.926758C9.41182 0.926758 0.45752 9.88106 0.45752 20.9268C0.45752 31.9725 9.41182 40.9268 20.4575 40.9268ZM29.916 16.7766C29.916 23.1157 25.014 30.4265 16.0519 30.4265V30.423C13.4038 30.4265 10.8115 29.6795 8.58252 28.2719C8.96846 28.3174 9.35558 28.3397 9.74271 28.3409C11.9372 28.3432 14.0688 27.6182 15.7942 26.283C13.7101 26.2444 11.8802 24.9055 11.2425 22.9507C11.9716 23.0898 12.7245 23.0619 13.4418 22.869C11.1689 22.4165 9.53371 20.4504 9.53252 18.1671V18.1062C10.2106 18.478 10.9694 18.6835 11.7448 18.7057C9.60377 17.2981 8.94233 14.4948 10.2355 12.3026C12.7103 15.2992 16.3606 17.1207 20.2782 17.3147C19.8851 15.6487 20.4231 13.902 21.6878 12.7306C23.6507 10.9137 26.737 11.0073 28.5824 12.9387C29.6737 12.7271 30.7199 12.3327 31.677 11.7738C31.3125 12.8857 30.5513 13.828 29.5348 14.4277C30.5002
|
||
14.3155 31.4443 14.0609 32.3325 13.6728C31.6782 14.6362 30.8553 15.4781 29.9017 16.1562C29.916 16.362 29.916 16.5685 29.916 16.7766Z" />
|
||
</svg>
|
||
</a>
|
||
<a href="https://www.linkedin.com/company/simplex-chat/" target="_blank">
|
||
<svg class="fill-primary-light dark:fill-primary-dark" width="40" height="40" viewBox="0 0 41 41" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||
<path fill-rule="evenodd" clip-rule="evenodd" d="M20.0408 0.926758C8.9951 0.926758 0.0407715 9.88109 0.0407715 20.9268C0.0407715 31.9724 8.9951 40.9268 20.0408 40.9268C31.0864 40.9268 40.0408 31.9724 40.0408 20.9268C40.0408 9.88109 31.0864 0.926758 20.0408 0.926758ZM9.6421 17.4916H14.1745V31.1098H9.6421V17.4916ZM14.4731 13.279C14.4437 11.9438 13.4889 10.9268 11.9383 10.9268C10.3878 10.9268 9.3741 11.9438 9.3741 13.279C9.3741 14.5866 10.3579 15.6328 11.8794 15.6328H11.9084C13.4889 15.6328 14.4731 14.5866 14.4731 13.279ZM25.3017 17.1718C28.2843 17.1718 30.5203 19.1187 30.5203 23.3015L30.5201 31.1098H25.9879V23.824C25.9879 21.994 25.3319 20.7453 23.6912 20.7453C22.439 20.7453 21.6932 21.5871 21.3656 22.4003C21.2458 22.6916 21.2164 23.0976 21.2164 23.5046V31.1101H16.6834C16.6834 31.1101 16.7431 18.7698 16.6834 17.492H21.2164V19.4208C21.8179 18.4936 22.8953 17.1718 25.3017 17.1718Z" />
|
||
</svg>
|
||
</a>
|
||
</div>
|
||
</article>
|
||
</div>
|
||
<a href="#" class="text-grey-black dark:text-white text-[16px] text-center lg:ltr:text-left lg:rtl:text-right font-medium leading-[28px] tracking-[0.01em] block mt-[60px]">© 2020-2023 SimpleX | Open-Source Project</a>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<script src="/js/docs.js"></script>
|
||
<script src="/js/prism.min.js"></script>
|
||
</body>
|
||
|
||
</html> |