blade/simplex-chat
1
0
Fork 0
mirror of https://github.com/simplex-chat/simplex-chat.git synced 2024-12-17 17:20:21 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

deploy: ed3365bb6d

Browse Source
This commit is contained in:
epoberezkin
2024-05-16 17:17:36 +00:00
parent c27a8be2b2
commit dd6586fe9e
59 changed files with 998 additions and 231 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/guide/app-settings.html
+4 -4
View File
@@ -747,10 +747,10 @@ window.addEventListener('scroll',changeHeaderBg);
<p>This section is labelled <strong>&quot;You&quot;</strong> in the app settings.</p>
<h3 id="your-active-profile" tabindex="-1">Your active profile</h3>
<p>Tap on your avatar/name to update your current profile names and avatar.</p>
<p>Display name cannot have any spaces and it is recommended to use latin characters and numbers to make it easier to type these names to the users who use <a href="cli.html">SimpleX Chat for the terminal</a> (CLI).</p>
<p>Display name cannot have any spaces and it is recommended to use latin characters and numbers to make it easier to type these names to the users who use <a href="/docs/cli.html">SimpleX Chat for the terminal</a> (CLI).</p>
<p><strong>Please note</strong>: When you save your profile, the update will be sent to all your contacts (excluding the contacts with whom your incognito profiles were shared). If you have a large number of contacts it can take several seconds.</p>
<h3 id="your-chat-profiles" tabindex="-1">Your chat profiles</h3>
<p>This page allows adding and configuring your chat profiles. Please see <a href="chat-profiles.html">Your chat profiles</a> for more details.</p>
<p>This page allows adding and configuring your chat profiles. Please see <a href="/docs/guide/chat-profiles.html">Your chat profiles</a> for more details.</p>
<h3 id="incognito" tabindex="-1">Incognito</h3>
<p>This feature is unique to SimpleX Chat – it is independent from chat profiles.</p>
<p>When &quot;Incognito” is turned on, your current profile name and image are NOT shared with your new contacts. It allows connections with other people without any shared data – when you make new connections or join groups via a link a new random profile name will be generated for each contact or group.</p>
@@ -760,7 +760,7 @@ window.addEventListener('scroll',changeHeaderBg);
<p>This page allows you to create a long term address that can be used by other people to connect with you. Unlike 1-time invitation links, these addresses can be used many times, that makes them good to share online, e.g. on other social media platforms.</p>
<p>When people connect to you via this address, you will receive a connection request that you can accept or reject. You can configure an automatic acceptance of connection request and an automatic welcome message that will be sent to the new contacts.</p>
<p>If you start receiving too many requests via this address it is always safe to remove it – all the connections you created via this address will remain active, as this address is not used to deliver the messages.</p>
<p>See the comparison with <a href="making-connections.html#comparison-of-1-time-invitation-links-and-simplex-contact-addresses">1-time invitation links</a>.</p>
<p>See the comparison with <a href="/docs/guide/making-connections.html#comparison-of-1-time-invitation-links-and-simplex-contact-addresses">1-time invitation links</a>.</p>
<p>Read more in <a href="/blog/20221108-simplex-chat-v4.2-security-audit-new-website.html#auto-accept-contact-requests">this post</a>.</p>
<h3 id="chat-preferences" tabindex="-1">Chat preferences</h3>
<p>This page allows to configure the chat preferences that would apply to all contacts - they can be changed separately for each contact:</p>
@@ -858,7 +858,7 @@ window.addEventListener('scroll',changeHeaderBg);
</ul>
<h3 id="database-passphrase-and-export" tabindex="-1">Database passphrase &amp; export</h3>
<p>This page allows to change the database passphrase, export and import the database and configure the message retention period.</p>
<p>Read more in <a href="managing-data.html">Managing Your Data</a> page.</p>
<p>Read more in <a href="/docs/guide/managing-data.html">Managing Your Data</a> page.</p>
<h2 id="help-and-feedback" tabindex="-1">Help &amp; feedback</h2>
<p>This section has information on how to use the app and the links to connect to the team. Please use <a href="https://simplex.chat/contact#/?v=1&amp;smp=smp%3A%2F%2FPQUV2eL0t7OStZOoAsPEV2QYWt4-xilbakvGUGOItUo%3D%40smp6.simplex.im%2FK1rslx-m5bpXVIdMZg9NLUZ_8JBm8xTt%23%2F%3Fv%3D1%26dh%3DMCowBQYDK2VuAyEALDeVe-sG8mRY22LsXlPgiwTNs9dbiLrNuA7f3ZMAJ2w%253D%26srv%3Dbylepyau3ty4czmn77q4fglvperknl4bi2eb2fdy2bh4jxtf32kf73yd.onion">Send questions and ideas</a> to connect to us via the chat to ask any questions, make any suggestions and report any issues.</p>
<h2 id="support-simplex-chat" tabindex="-1">Support SimpleX Chat</h2>
docs/guide/chat-profiles.html
+6 -6
View File
@@ -741,7 +741,7 @@ window.addEventListener('scroll',changeHeaderBg);
<img src="../../blog/images/20230204-profiles2.png" width="288">
<p>To create an additional SimpleX Chat profile:</p>
<ul>
<li><a href="app-settings.html#opening-the-app-settings">Open the app settings</a>.</li>
<li><a href="/docs/guide/app-settings.html#opening-the-app-settings">Open the app settings</a>.</li>
<li>Select &quot;Your chat profiles&quot;.</li>
<li>Unlock option via fingerprint or PIN.</li>
<li>Tap on &quot;+ Add profile”.</li>
@@ -766,14 +766,14 @@ window.addEventListener('scroll',changeHeaderBg);
<p>When &quot;Incognito Mode” is turned on, your currently chosen profile name and image are hidden from your new contacts. It allows anonymous connections with other people without any shared data – when you make new connections or join groups via a link a new random profile name will be generated for each connection.</p>
<p>To toggle the incognito mode on/off:</p>
<ul>
<li><a href="app-settings.html#opening-the-app-settings">Open the app settings</a>.</li>
<li><a href="/docs/guide/app-settings.html#opening-the-app-settings">Open the app settings</a>.</li>
<li>Turn on/off incognito mode by tapping on the switch on &quot;Incognito&quot;.</li>
</ul>
<p>Please read more in <a href="/blog/20220901-simplex-chat-v3.2-incognito-mode.html#incognito-mode">this post</a>.</p>
<h2 id="edit-your-profile" tabindex="-1">Edit your profile</h2>
<p>To edit your profile:</p>
<ul>
<li><a href="app-settings.html#opening-the-app-settings">Open the app settings</a>.</li>
<li><a href="/docs/guide/app-settings.html#opening-the-app-settings">Open the app settings</a>.</li>
<li>Select your profile.</li>
<li>Tap on &quot;Edit&quot;.</li>
<li>Input your desired profile name and/or update your full name.</li>
@@ -784,11 +784,11 @@ window.addEventListener('scroll',changeHeaderBg);
<p>SimpleX Chat stores all user data only on client devices using a portable encrypted database format that can be exported and transferred to any supported device.</p>
<p>To export your SimpleX Chat data:</p>
<ul>
<li><a href="app-settings.html#opening-the-app-settings">Open the app settings</a>.</li>
<li><a href="/docs/guide/app-settings.html#opening-the-app-settings">Open the app settings</a>.</li>
<li>Select &quot;Database passphrase &amp; export&quot;.</li>
<li>Stop chat by toggling &quot;Chat is running&quot; (tap &quot;Stop” in the confirmation dialog).</li>
<li>Confirm it with fingerprint or PIN, in case you have <a href="app-settings.html#simplex-lock">SimpleX Lock</a> enabled.</li>
<li>If you didn't set it before, <a href="managing-data.html#database-passphrase">set a passphrase</a> in &quot;Database passphrase&quot;. Initially, the database is encrypted with a random passphrase that is stored in KeyChain (iOS) or with KeyStore (Android).</li>
<li>Confirm it with fingerprint or PIN, in case you have <a href="/docs/guide/app-settings.html#simplex-lock">SimpleX Lock</a> enabled.</li>
<li>If you didn't set it before, <a href="/docs/guide/managing-data.html#database-passphrase">set a passphrase</a> in &quot;Database passphrase&quot;. Initially, the database is encrypted with a random passphrase that is stored in KeyChain (iOS) or with KeyStore (Android).</li>
<li>Tap on &quot;Export database&quot; - it won't allow exporting unless you have set a passphrase.</li>
<li>Save the file on your device or share it via any available option.</li>
</ul>
docs/guide/making-connections.html
+1 -1
View File
@@ -742,7 +742,7 @@ window.addEventListener('scroll',changeHeaderBg);
<p>Private Connection — connect using an invitation link or QR code via video or in-person.</p>
<p>Group Chat — Users have the option to create a secret group, share their contact link [which can be deleted later on], or generate a one-time invitation link.</p>
<h2 id="your-simplex-contact-address" tabindex="-1">Your SimpleX contact address</h2>
<p>You can <a href="app-settings.html#your-simplex-contact-address">create an optional long term address</a> for other people to connect with you. Unlike 1-time invitation links, these addresses can be used many times, that makes them good to share online, e.g. on social media platforms, or in email signatures. That helps more people discover SimpleX Chat, so please do it!</p>
<p>You can <a href="/docs/guide/app-settings.html#your-simplex-contact-address">create an optional long term address</a> for other people to connect with you. Unlike 1-time invitation links, these addresses can be used many times, that makes them good to share online, e.g. on social media platforms, or in email signatures. That helps more people discover SimpleX Chat, so please do it!</p>
<p>When people connect to you via this address, you will receive a connection request that you can accept or reject. You can configure an automatic acceptance of connection request and an automatic welcome message that will be sent to the new contacts. You can also share this address as part of your SimpleX profile, so group members can connect to you, and your contacts can share it with others - if this is something that you want.</p>
<p>If you start receiving too many requests via this address it is always safe to remove it – all the connections you created via this address will remain active, as this address is not used to deliver the messages.</p>
<h3 id="comparison-of-1-time-invitation-links-and-simplex-contact-addresses" tabindex="-1">Comparison of 1-time invitation links and SimpleX Contact addresses</h3>
docs/guide/managing-data.html
+1 -1
View File
@@ -742,7 +742,7 @@ window.addEventListener('scroll',changeHeaderBg);
<h2 id="chat-database" tabindex="-1">Chat Database</h2>
<p>To open your chat database settings:</p>
<ul>
<li><a href="app-settings.html#opening-the-app-settings">Open the app settings</a>.</li>
<li><a href="/docs/guide/app-settings.html#opening-the-app-settings">Open the app settings</a>.</li>
<li>Tap on &quot;Database passphrase &amp; export&quot; button.</li>
</ul>
<h3 id="database-passphrase" tabindex="-1">Database passphrase</h3>
docs/guide/privacy-security.html
+7 -7
View File
@@ -739,7 +739,7 @@ window.addEventListener('scroll',changeHeaderBg);
<p>SimpleX Chat default configuration aims to balance privacy, security and convenience. You may want to change the default options.</p>
<p>This page lists all the features and options that affect privacy and security.</p>
<h2 id="privacy-and-security-settings" tabindex="-1">Privacy and Security settings</h2>
<p>These settings are available in the <a href="app-settings.html#privacy-and-security">Privacy &amp; Security settings</a>.</p>
<p>These settings are available in the <a href="/docs/guide/app-settings.html#privacy-and-security">Privacy &amp; Security settings</a>.</p>
<h2 id="security-code-verification" tabindex="-1">Security code verification</h2>
<img src="../../blog/images/20230103-verification.png" width="288">
<p>While SimpleX Chat always establishes connection via link passed via an independent channel, so it is already more protected than other apps, there are scenarios when the invitation links can be substituted in transit (MITM attack). To protect against such attacks, you should verify the security code with your contacts:</p>
@@ -758,19 +758,19 @@ window.addEventListener('scroll',changeHeaderBg);
</ul>
<p>Read more in <a href="/blog/20230103-simplex-chat-v4.4-disappearing-messages.html#connection-security-verification">this post</a></p>
<h2 id="database-passphrase" tabindex="-1">Database passphrase</h2>
<p>When installed, the app generates a random passphrase for the chat database and stores it securely in KeyChain (iOS) or using KeyStore (Android, TPM module is used when available). You can set your own passphrase and also remove it from the device, in which case you will need to enter it every time you start the app, and notifications may be limited, in the <a href="managing-data.html#database-passphrase">Database passphrase &amp; export</a> settings.</p>
<p>When installed, the app generates a random passphrase for the chat database and stores it securely in KeyChain (iOS) or using KeyStore (Android, TPM module is used when available). You can set your own passphrase and also remove it from the device, in which case you will need to enter it every time you start the app, and notifications may be limited, in the <a href="/docs/guide/managing-data.html#database-passphrase">Database passphrase &amp; export</a> settings.</p>
<h2 id="incognito-mode" tabindex="-1">Incognito mode</h2>
<p>This feature generates a random profile name for each new contact. Read more in <a href="app-settings.html#incognito">Incognito mode</a>.</p>
<p>This feature generates a random profile name for each new contact. Read more in <a href="/docs/guide/app-settings.html#incognito">Incognito mode</a>.</p>
<h2 id="hidden-profiles" tabindex="-1">Hidden profiles</h2>
<p>This feature allows to hide some of your chat profiles with the password. Read more in <a href="chat-profiles.html#hiding-and-muting-chat-profiles">Hiding and muting chat profiles</a>.</p>
<p>This feature allows to hide some of your chat profiles with the password. Read more in <a href="/docs/guide/chat-profiles.html#hiding-and-muting-chat-profiles">Hiding and muting chat profiles</a>.</p>
<h2 id="network-settings" tabindex="-1">Network settings</h2>
<p><a href="app-settings.html#transport-isolation-beta">Transport isolation (BETA)</a> allows to isolate you traffic with each contact in a different TCP connection (and Tor circuit).</p>
<p><a href="/docs/guide/app-settings.html#transport-isolation-beta">Transport isolation (BETA)</a> allows to isolate you traffic with each contact in a different TCP connection (and Tor circuit).</p>
<h2 id="using-tor" tabindex="-1">Using Tor</h2>
<p><img src="../../blog/images/20220808-tor1.png" width="330">   <img src="../../blog/images/20220808-tor2.png" width="330"></p>
<p>To connect to SMP relays (messaging servers) via Tor you need to install Orbot app.</p>
<p>Android: use Orbot app as SOCKS proxy on port 9050 (default) and enable <a href="app-settings.html#use-socks-proxy-android-only">Use SOCKS proxy</a>.</p>
<p>Android: use Orbot app as SOCKS proxy on port 9050 (default) and enable <a href="/docs/guide/app-settings.html#use-socks-proxy-android-only">Use SOCKS proxy</a>.</p>
<p>iOS: use Orbot app as VPN provider and enable VPN.</p>
<p>You can also change which server addresses are used with <a href="app-settings.html#use-onion-hosts">Use .onion hosts option</a>.</p>
<p>You can also change which server addresses are used with <a href="/docs/guide/app-settings.html#use-onion-hosts">Use .onion hosts option</a>.</p>
</div>
</article>
</main>
docs/guide/readme.html
+11 -11
View File
@@ -740,13 +740,13 @@ window.addEventListener('scroll',changeHeaderBg);
<h2 id="contents" tabindex="-1">Contents</h2>
<ul>
<li><a href="#quick-start">Quick start</a> - scroll down this page</li>
<li><a href="send-messages.html">Sending messages</a></li>
<li><a href="secret-groups.html">Secret groups</a></li>
<li><a href="chat-profiles.html">Chat profiles</a></li>
<li><a href="managing-data.html">Managing data</a></li>
<li><a href="audio-video-calls.html">Audio &amp; video calls</a></li>
<li><a href="privacy-security.html">Privacy &amp; security</a></li>
<li><a href="app-settings.html">App settings</a></li>
<li><a href="/docs/guide/send-messages.html">Sending messages</a></li>
<li><a href="/docs/guide/secret-groups.html">Secret groups</a></li>
<li><a href="/docs/guide/chat-profiles.html">Chat profiles</a></li>
<li><a href="/docs/guide/managing-data.html">Managing data</a></li>
<li><a href="/docs/guide/audio-video-calls.html">Audio &amp; video calls</a></li>
<li><a href="/docs/guide/privacy-security.html">Privacy &amp; security</a></li>
<li><a href="/docs/guide/app-settings.html">App settings</a></li>
</ul>
<h2 id="quick-start" tabindex="-1">Quick start</h2>
<h3 id="create-your-first-chat-profile" tabindex="-1">Create your first chat profile</h3>
@@ -766,11 +766,11 @@ window.addEventListener('scroll',changeHeaderBg);
<p>When you just start using the app, you can tap &quot;chat with the developers&quot; to ask any questions or just to test the app - feel free to send any test messages.</p>
<p>This button will disappear once you make the first connection. To connect to the developers later:</p>
<ul>
<li><a href="app-settings.html#opening-the-app-settings">Open the app settings</a>.</li>
<li><a href="/docs/guide/app-settings.html#opening-the-app-settings">Open the app settings</a>.</li>
<li>Tap on &quot;Send questions and ideas&quot;.</li>
</ul>
<h3 id="join-some-user-groups" tabindex="-1">Join some user groups</h3>
<p>There are links to join several <a href="readme.html#join-user-groups">user groups</a> on our GitHub page - join them to ask any questions and discuss ideas.</p>
<p>There are links to join several <a href="https%3A//github.com/simplex-chat/simplex-chat/blob/stable/simplex-chat/README.md#join-user-groups">user groups</a> on our GitHub page - join them to ask any questions and discuss ideas.</p>
<p>You can also find some other user-managed groups via online search.</p>
<p>To join a group via a link:</p>
<ul>
@@ -789,10 +789,10 @@ window.addEventListener('scroll',changeHeaderBg);
<li>They can either scan QR code or paste the link. If they opened the link in the browser, they need to tap &quot;Open in mobile app&quot; button on the page.</li>
</ul>
<p>Watch the video on <a href="https://simplex.chat">the website</a> that shows how it works.</p>
<p>You can also create a <a href="app-settings.html#your-simplex-contact-address">long-term contact address</a>.</p>
<p>You can also create a <a href="/docs/guide/app-settings.html#your-simplex-contact-address">long-term contact address</a>.</p>
<h3 id="explore-the-app" tabindex="-1">Explore the app</h3>
<p>Most app settings are shared for all profiles, but some settings are specific to chat profile.</p>
<p>Read more in <a href="app-settings.html">App settings</a> page.</p>
<p>Read more in <a href="/docs/guide/app-settings.html">App settings</a> page.</p>
<p>Many conversation actions are available via long-press or swipe – try them!</p>
</div>
</article>