[website] Add documentation (#403)
* setup md/mdx * add test page * setup mdx provider * Add breadcrumbs * links -> routes * add information box * add more remark plugins * text InformationBox * setup contentlayer * add testing docs folder * setup docs static generation * add ssg to blog too * add Shortcut component * add SearchButton * add hook for keyboard shortcuts * update main docs page * update main learn page content * side-bar -> sidebar-menu * rename docs pages * add heading anchors, use new components * add table of contents to docs * move styling to breadcrumbs * cleanup markdown examples * change slugify fn * update getting-started.md * add highlight matches component * update learn pages * rename website InformationBox to Admonition * ?enable user-select * add static helpers to epics * simplify components structure * update insights layout * add link tree utils * add search engine * update docs import * update contenlayer * add docs indexer * support code block highlighting * search index * fix types * remove supporting files * update tree builder * make build work * update docs * update label * update toc * add config.json * update menu * search index import * learn -> help * fix md file * update toc * fix code snippets * add help index route * remove testing files * add original docs * migrate getting started * migrate messaging-and-web3-browser docs * migrate network-nodes-and-statistics docs * handle empty content * add navigation config * wip * migrate status-wallet docs * migrate to new admonitions format * migrate your-profile-and-preferences docs * migrate part of status-communities docs * mv * rm log * index * fix lint * fix warn * fix title * fix docs layout * udpate next.config * use lowercase lang * generate contentlayer types before typechecking * update docs images * update help routes --------- Co-authored-by: Felicio Mununga <felicio@users.noreply.github.com>
This commit is contained in:
Pavel
GitHub
parent
2b6ef64fdd
commit
b88f7e73da
|
|
@ -104,3 +104,6 @@ web-build/
|
|||
|
||||
# Local
|
||||
**/.data
|
||||
|
||||
# Contentlayer
|
||||
.contentlayer
|
||||
|
|
|
|||
|
|
@ -23,5 +23,14 @@
|
|||
"@vitejs/plugin-react": "^3.1.0",
|
||||
"typescript": "^5.0.3",
|
||||
"vite": "^4.2.1"
|
||||
},
|
||||
"lint-staged": {
|
||||
"*.{ts,tsx,js,jsx,mjs}": [
|
||||
"eslint",
|
||||
"prettier --write"
|
||||
],
|
||||
"*.{md,mdx,yml,yaml,json}": [
|
||||
"prettier --write"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -27,5 +27,14 @@
|
|||
"@status-im/eslint-config": "*",
|
||||
"typescript": "^5.0.3",
|
||||
"vite": "^4.2.1"
|
||||
},
|
||||
"lint-staged": {
|
||||
"*.{ts,tsx,js,jsx,mjs}": [
|
||||
"eslint",
|
||||
"prettier --write"
|
||||
],
|
||||
"*.{md,mdx,yml,yaml,json}": [
|
||||
"prettier --write"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -37,3 +37,6 @@ yarn-error.log*
|
|||
|
||||
# Tamagui
|
||||
.tamagui
|
||||
|
||||
# Contentlayer
|
||||
.contentlayer
|
||||
|
|
|
|||
|
|
@ -0,0 +1,60 @@
|
|||
{
|
||||
"nav": [
|
||||
{
|
||||
"Getting started": [
|
||||
{ "Intro to Status": "/getting-started" },
|
||||
{ "Getting started for new users": "/getting-started" },
|
||||
{ "Getting started with your community": "/getting-started" },
|
||||
{ "Download Status": "/getting-started" }
|
||||
]
|
||||
},
|
||||
{
|
||||
"Messaging": [
|
||||
{ "Direct messages": "/messaging-and-web3-browser" },
|
||||
{ "Group chats": "/messaging-and-web3-browser" },
|
||||
{ "Message features and tools": "/messaging-and-web3-browser" },
|
||||
{ "Share files and conversations": "/messaging-and-web3-browser" }
|
||||
]
|
||||
},
|
||||
{
|
||||
"Communities": [
|
||||
{ "Status Communities": "/status-communities" },
|
||||
{ "Channels": "/status-communities" },
|
||||
{ "Create your community": "/status-communities" },
|
||||
{ "Administer your community": "/status-communities" },
|
||||
{ "Administer channels": "/status-communities" },
|
||||
{ "Use tokens and set community permissions": "/status-communities" },
|
||||
{ "Status Web Communities": "/status-communities" }
|
||||
]
|
||||
},
|
||||
{
|
||||
"Wallet": [
|
||||
{ "Getting started": "/status-wallet" },
|
||||
{ "Send and receive crypto": "/status-wallet" },
|
||||
{ "Privacy and security": "/status-wallet" },
|
||||
{ "Understand crypto assets": "/status-wallet" },
|
||||
{ "Handle your crypto": "/status-wallet" }
|
||||
]
|
||||
},
|
||||
{
|
||||
"Your profile": [
|
||||
{ "Manage your profile": "/your-profile-and-preferences" },
|
||||
{
|
||||
"Change your settings and preferences": "/your-profile-and-preferences"
|
||||
},
|
||||
{ "Adjust your notifications": "/your-profile-and-preferences" },
|
||||
{
|
||||
"Your profile security and privacy": "/your-profile-and-preferences"
|
||||
},
|
||||
{ "Troubleshooting": "/your-profile-and-preferences" },
|
||||
{ "Use your Keycard": "/your-profile-and-preferences" },
|
||||
{
|
||||
"Handle your contact list and user verification": "/your-profile-and-preferences"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"Network nodes": ["network-nodes-and-statistics"]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,261 @@
|
|||
import {
|
||||
defineDocumentType,
|
||||
defineNestedType,
|
||||
makeSource,
|
||||
} from '@contentlayer/source-files'
|
||||
import remarkHeadings from '@vcarl/remark-headings'
|
||||
import { slug as slugify } from 'github-slugger'
|
||||
import { toString } from 'mdast-util-to-string'
|
||||
import * as fs from 'node:fs/promises'
|
||||
import path from 'node:path'
|
||||
import rehypePrettyCode from 'rehype-pretty-code'
|
||||
import rehypeSlug from 'rehype-slug'
|
||||
import { remark } from 'remark'
|
||||
import remarkDirective from 'remark-directive'
|
||||
import remarkGfm from 'remark-gfm'
|
||||
// import remarkMessageControl from 'remark-message-control'
|
||||
// import remarkAdmonitions from 'remark-github-beta-blockquote-admonitions'
|
||||
// import remarkBreaks from 'remark-breaks'
|
||||
import strip from 'strip-markdown'
|
||||
import { visit } from 'unist-util-visit'
|
||||
|
||||
import type { Plugin } from 'unified'
|
||||
import type { Node } from 'unist'
|
||||
|
||||
const CONTENT_DIR_PATH = 'docs'
|
||||
|
||||
export type DocHeading = {
|
||||
level: 1 | 2
|
||||
value: string
|
||||
}
|
||||
|
||||
export type DocIndex = {
|
||||
path: string
|
||||
title: string
|
||||
content: {
|
||||
[key in string]: string[]
|
||||
}
|
||||
}
|
||||
|
||||
const HeroImage = defineNestedType(() => ({
|
||||
name: 'HeroImage',
|
||||
fields: {
|
||||
src: { type: 'string', required: true },
|
||||
alt: { type: 'string', required: true },
|
||||
},
|
||||
}))
|
||||
|
||||
export const Doc = defineDocumentType(() => ({
|
||||
name: 'Doc',
|
||||
filePathPattern: '**/*.md{,x}',
|
||||
contentType: 'mdx',
|
||||
|
||||
fields: {
|
||||
id: { type: 'number', required: false },
|
||||
revision: { type: 'string', required: false },
|
||||
language: { type: 'string', required: false },
|
||||
title: { type: 'string', required: true },
|
||||
author: { type: 'string', required: false },
|
||||
image: { type: 'nested', of: HeroImage, required: false },
|
||||
},
|
||||
|
||||
computedFields: {
|
||||
slug: {
|
||||
// @ts-expect-error TODO
|
||||
type: 'string[]',
|
||||
resolve: doc => doc._raw.flattenedPath.split('/'),
|
||||
// resolve: doc => {
|
||||
// return getPathSegments(doc._raw.flattenedPath).map(
|
||||
// ({ pathName }) => pathName
|
||||
// )
|
||||
// },
|
||||
},
|
||||
url: {
|
||||
type: 'string',
|
||||
resolve: doc => `/help/${doc._raw.flattenedPath}`,
|
||||
|
||||
// resolve: doc => {
|
||||
// const slug = getPathSegments(doc._raw.flattenedPath).map(
|
||||
// ({ pathName }) => pathName
|
||||
// )
|
||||
|
||||
// return `/help/${slug.join('/')}`
|
||||
// },
|
||||
},
|
||||
pathSegments: {
|
||||
// @ts-expect-error TODO
|
||||
type: '{ order: number; pathName: string }[]',
|
||||
resolve: doc => getPathSegments(doc._raw.flattenedPath),
|
||||
},
|
||||
|
||||
titleSlug: {
|
||||
type: 'string',
|
||||
resolve: doc => slugify(doc.title),
|
||||
},
|
||||
|
||||
headings: {
|
||||
// @ts-expect-error TODO
|
||||
type: '{ level: 1 | 2; value: string, slug: string }[]',
|
||||
resolve: async doc => {
|
||||
const result = await remark().use(remarkHeadings).process(doc.body.raw)
|
||||
|
||||
return (result.data.headings as { depth: number; value: string }[])
|
||||
.filter(({ depth }) => [1, 2].includes(depth))
|
||||
.map<DocHeading>(({ depth, value }) => ({
|
||||
level: depth as 1 | 2,
|
||||
value,
|
||||
slug: slugify(value),
|
||||
}))
|
||||
},
|
||||
},
|
||||
last_edited: {
|
||||
type: 'date',
|
||||
resolve: async (doc): Promise<Date> => {
|
||||
const stats = await fs.stat(
|
||||
path.join(CONTENT_DIR_PATH, doc._raw.sourceFilePath)
|
||||
)
|
||||
return stats.mtime
|
||||
},
|
||||
},
|
||||
},
|
||||
}))
|
||||
|
||||
function getPathSegments(filePath: string) {
|
||||
return (
|
||||
filePath
|
||||
.split('/')
|
||||
// .slice(1) // skip content dir path – `/docs`
|
||||
.map(fileName => {
|
||||
const re = /^((\d+)-)?(.*)$/
|
||||
const [, , orderStr, pathName] = fileName.match(re) ?? []
|
||||
const order = orderStr ? parseInt(orderStr) : 0
|
||||
return { order, pathName }
|
||||
})
|
||||
)
|
||||
}
|
||||
|
||||
const remarkAdmonition: Plugin = () => {
|
||||
return tree => {
|
||||
visit(tree, node => {
|
||||
if (
|
||||
node.type === 'textDirective' ||
|
||||
node.type === 'leafDirective' ||
|
||||
node.type === 'containerDirective'
|
||||
) {
|
||||
// @ts-expect-error TODO
|
||||
if (!['info', 'tip', 'warn'].includes(node.name)) {
|
||||
return
|
||||
}
|
||||
|
||||
// Store node.name before overwritten with "Alert".
|
||||
// @ts-expect-error TODO
|
||||
const type = node.name
|
||||
|
||||
// const data = node.data || (node.data = {})
|
||||
// const tagName = node.type === 'textDirective' ? 'span' : 'div'
|
||||
|
||||
node.type = 'mdxJsxFlowElement'
|
||||
// @ts-expect-error TODO
|
||||
node.name = 'Admonition'
|
||||
// @ts-expect-error TODO
|
||||
node.attributes = [
|
||||
{ type: 'mdxJsxAttribute', name: 'type', value: type },
|
||||
// @ts-expect-error TODO
|
||||
{ type: 'mdxJsxAttribute', name: 'title', value: node.label },
|
||||
]
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
const remarkIndexer: Plugin = () => (root, file) => {
|
||||
file.data.index = indexer(root)
|
||||
}
|
||||
|
||||
function indexer(root: Node) {
|
||||
const index: DocIndex['content'] = {}
|
||||
|
||||
let parentHeading = ''
|
||||
visit(root, ['paragraph', 'heading'], node => {
|
||||
if (node.type === 'heading') {
|
||||
const text = toString(node, { includeImageAlt: false })
|
||||
parentHeading = text
|
||||
return
|
||||
}
|
||||
|
||||
const text = toString(node, { includeImageAlt: false })
|
||||
index[parentHeading] ??= []
|
||||
index[parentHeading].push(text)
|
||||
})
|
||||
|
||||
return index
|
||||
}
|
||||
|
||||
export default makeSource({
|
||||
contentDirPath: CONTENT_DIR_PATH,
|
||||
documentTypes: [Doc],
|
||||
mdx: {
|
||||
remarkPlugins: [
|
||||
remarkGfm,
|
||||
remarkDirective,
|
||||
remarkAdmonition,
|
||||
// [remarkMessageControl, { name: 'hello' }],
|
||||
],
|
||||
rehypePlugins: [
|
||||
rehypeSlug,
|
||||
|
||||
[
|
||||
rehypePrettyCode,
|
||||
{
|
||||
// Use one of Shiki's packaged themes
|
||||
theme: 'github-light',
|
||||
// Keep the background or use a custom background color?
|
||||
// keepBackground: true,
|
||||
// Callback hooks to add custom logic to nodes when visiting
|
||||
// them.
|
||||
onVisitLine(node: any) {
|
||||
// Prevent lines from collapsing in `display: grid` mode, and
|
||||
// allow empty lines to be copy/pasted
|
||||
if (node.children.length === 0) {
|
||||
node.children = [{ type: 'text', value: ' ' }]
|
||||
}
|
||||
},
|
||||
onVisitHighlightedLine(node: any) {
|
||||
// Each line node by default has `class="line"`.
|
||||
node.properties.className.push('highlighted')
|
||||
},
|
||||
onVisitHighlightedWord(node: any) {
|
||||
// Each word node has no className by default.
|
||||
node.properties.className = ['word']
|
||||
},
|
||||
},
|
||||
],
|
||||
],
|
||||
},
|
||||
onSuccess: async importData => {
|
||||
const { allDocs } = await importData()
|
||||
|
||||
const basePath = '/docs'
|
||||
const index: DocIndex[] = []
|
||||
|
||||
for (const doc of allDocs) {
|
||||
const result = await remark()
|
||||
.use(strip, {
|
||||
keep: ['heading'],
|
||||
})
|
||||
.use(remarkGfm)
|
||||
.use(remarkIndexer, { path: basePath + '/' + doc._raw.flattenedPath })
|
||||
.process(doc.body.raw)
|
||||
|
||||
index.push({
|
||||
title: doc.title,
|
||||
path: basePath + '/' + doc._raw.flattenedPath,
|
||||
content: result.data.index as DocIndex['content'],
|
||||
})
|
||||
}
|
||||
|
||||
const filePath = path.resolve('./.contentlayer/en.json')
|
||||
|
||||
fs.writeFile(filePath, JSON.stringify(index))
|
||||
},
|
||||
})
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 438
|
||||
revision: '0'
|
||||
language: en
|
||||
title: About the Ethereum blockchain
|
||||
---
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
id: 382
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Add a contact in Status
|
||||
---
|
||||
|
||||
To start a chat with someone, you first need to add them to your contacts.
|
||||
|
||||
After sending a contact request, wait for the other person to accept it. Once they do that, both you and them can send each other [direct messages][send-direct-messages-to-your-contacts] and invite each other to [group chats][add-members-to-a-group-chat].
|
||||
|
||||
If the person you want to chat with doesn't have a Status profile yet, you can [invite them to join Status][invite-friends-to-status].
|
||||
|
||||
To add someone to your contact list, you need their [chat key][understand-your-status-keys-and-recovery-phrase], which represents their public Status profile. They can share it with you, so ask them to [Share their Status profile with you][share-your-status-profile]. You can also use their QR code to add them to contacts.
|
||||
|
||||
:::tip
|
||||
To add someone you know from a group chat or community, simply right-click their name and select :desktop-add-user: **Send a contact request**.
|
||||
:::
|
||||
|
||||
:::tip
|
||||
To respond to contact requests, check out [Respond to a contact request][respond-to-a-contact-request].
|
||||
:::
|
||||
|
||||
## Add a contact
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. Ask the person you want to add to your contacts to share their profile.
|
||||
1. From the tab bar, tap :mobile-messages: **Messages**.
|
||||
1. Tap :mobile-add: **Plus** and select :mobile-add-user: **Add a contact**.
|
||||
1. Paste the link to that person's profile into the field or tap :mobile-qr-code: to scan the QR code.
|
||||
1. Tap :mobile-profile: **View profile** > :mobile-profile: **Send contact request**.
|
||||
1. In your introductory message, briefly explain who you are and why you want to add them to your contacts. This is the first message your contact sees from you. Once you're done, tap **Send contact request**.
|
||||
|
||||
:::tip
|
||||
To see someone's QR code, ask them to go to **Messages** > :mobile-qr-code: **Share**. Follow the steps below to add them to contacts using this code.
|
||||
:::
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. Ask the person you want to add to your contacts to share their profile.
|
||||
1. From the navigation sidebar, click :desktop-chat: **Chat**.
|
||||
1. Click :desktop-start-chat: **Start chat**.
|
||||
1. Paste the link to that person's profile into the **To** field.
|
||||
1. In your introductory message, briefly explain who you are and why you want to add them to your contacts. This is the first message your contact sees from you. Once you're done, click **Send contact request**.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 345
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Add a new device to your Status profile
|
||||
---
|
||||
|
|
@ -0,0 +1,100 @@
|
|||
---
|
||||
id: 374
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Create or restore your Status profile using a recovery phrase
|
||||
---
|
||||
|
||||
You can link your existing Ethereum address to a new Status profile. For instance, if you already have a [non-custodial Ethereum wallet][status-wallet-your-quick-start-guide] such as Metamask or Trust Wallet, you already have an Ethereum address and a [recovery phrase][understand-your-status-keys-and-recovery-phrase].
|
||||
|
||||
If you already have a Status account and used your profile in the past 30 days, you can restore it with the profile's recovery phrase.
|
||||
|
||||
:::tip
|
||||
If you already use Status on one device and want to add your profile and funds to a new device, you don't need your recovery phrase. [Sync your new device][add-a-new-device-to-your-status-profile] for the best experience.
|
||||
:::
|
||||
|
||||
## What to expect
|
||||
|
||||
- Your wallet funds are safe and recoverable as long as you know your recovery phrase and [keep it safe][back-up-and-secure-your-recovery-phrase].
|
||||
- When you import an existing Ethereum address from a wallet, you can operate with your funds using [Status Wallet][how-to-use-wallet-your-quick-start-guide].
|
||||
- If you already use Status but don't have access to your previous device, you can restore your Status profile on a new device if you have used the app within the past 30 days.
|
||||
- If you don't have access to your previous device and haven't used Status in the past 30 days, your funds are safe, but your profile is unrecoverable. You can still use your recovery phrase to create a new profile, but your previous profile configuration (contacts, profile settings and community membership) is lost.
|
||||
|
||||
This table summarizes your options when you have a recovery phrase:
|
||||
|
||||
| You have | Next step | Your Status profile | Your wallet funds |
|
||||
| :---------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------- | :------------------ | :---------------- |
|
||||
| :material-check: Recovery phrase :octicons-x-24:Status profile | [Create profile using a recovery phrase](#create-or-restore-your-profile-using-a-recovery-phrase) | New profile | :material-check: |
|
||||
| :material-check: Recovery phrase :material-check: Used your Status profile in the past 30 days | [Restore profile using a recovery phrase](#create-or-restore-your-profile-using-a-recovery-phrase) | :material-check: | :material-check: |
|
||||
| :material-check: Recovery phrase :octicons-x-24: Used your Status profile in the past 30 days :octicons-x-24: Access to your device | [Create profile using a recovery phrase](#create-or-restore-your-profile-using-a-recovery-phrase) | :octicons-x-24: | :material-check: |
|
||||
|
||||
(:material-check: available, :octicons-x-24: not available )
|
||||
|
||||
:::tip
|
||||
Creating or restoring a profile using a recovery phrase follows the same procedure.
|
||||
:::
|
||||
|
||||
## Create or restore your profile using a recovery phrase
|
||||
|
||||
When you restore your Status profile using a recovery phrase, Status tries to pull your information from the [decentralized Waku network][peer-to-peer-messaging]. Status doesn't use centralized servers and doesn't store your profile information.
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
### Step 1: Enter your recovery phrase words
|
||||
|
||||
1. Open the Status app and tap **I'm new to Status**.
|
||||
1. On the following screen, select **Use recovery phrase**.
|
||||
1. Enter the 12, 18 or 24 words in your recovery phrase, separated by a space.
|
||||
1. Status suggests matching words as you type. To speed up the recovery phrase entry, tap the right suggestion.
|
||||
1. Tap **Continue**.
|
||||
1. [Customize your Status profile](#customize-your-profile) with your preferred name, profile picture, and colour, and press **Continue**.
|
||||
|
||||
### Step 2: Create your password
|
||||
|
||||
1. Enter and confirm your password and tap **Confirm password**.
|
||||
1. Configure your device's biometrics (fingerprint, face or other) to fill in your password. If you want to enable biometrics later, tap **Maybe later**.
|
||||
1. On the **profile identifiers** screen, you can learn more about your Status profile or tap **Skip** to finish the profile setup.
|
||||
1. Tap **Start using Status**.
|
||||
|
||||
If Status finds an existing profile in the [Waku network][peer-to-peer-messaging], you can use your existing profile or the one you have just created. When you choose your existing profile, [synchronize this profile][add-a-new-device-to-your-status-profile] with your device.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
### Step 1: Enter your recovery phrase words
|
||||
|
||||
1. Open the Status app. Your operating system may ask you to set your notification preferences for Status. In the **Allow notifications** screen, click **OK, got it**.
|
||||
1. Check the box to accept the Status **Terms of Use and Privacy Policy** and click **Get Started**. You can find and read this information on the [Status website :octicons-tab-external-16:][status-website].
|
||||
1. On the welcome screen, click **I am new to Status**.
|
||||
1. Click **Import a recovery phrase** and, on the next screen, click **Import a recovery phrase** again.
|
||||
1. Enter the 12, 18 or 24 words in your recovery phrase, separated by a space.
|
||||
1. Status auto-fills and suggests matching words as you type. To speed up the recovery phrase entry, click the right suggestion.
|
||||
1. Tap **Import**.
|
||||
|
||||
### Step 2: Create your password and customize other settings
|
||||
|
||||
1. On the **Your profile** screen, [customize your Status profile](#customize-your-profile) with your preferred name, profile picture, and colour, and click **Continue**.
|
||||
1. On the **Your emojihash and identicon ring** screen, you can learn more about your Status profile. Click **Next**.
|
||||
1. Enter and confirm your password and click **Create password**.
|
||||
1. Confirm your password again and click **Finalize Status Password Creation**.
|
||||
1. Enable your device's biometrics (fingerprint, face or other) to fill in your password. Alternatively, click **I prefer to use my password**.
|
||||
|
||||
:::warn
|
||||
Status doesn't know your password and can't reset it for you. If you forget your password, you may lose access to your Status profile and wallet funds. Remember your Status password, keep it in a safe place and don't share it with anyone.
|
||||
:::
|
||||
|
||||
## Customize your profile
|
||||
|
||||
Here you only fill out basic information. You can customize your Status profile further at any time in the [Status settings][edit-your-status-profile].
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. On the **Create profile** screen, set your profile name. Don't use special characters or emojis.
|
||||
1. Tap the :mobile-camera: **Camera** in your avatar and set a profile picture. To add your profile picture, you must authorize the Status app to access your camera or photo gallery.
|
||||
1. Choose a profile colour.
|
||||
1. Tap **Continue** to complete your profile customization.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. On the **Your profile** screen, set your profile name. Don't use special characters or emojis.
|
||||
1. Click :desktop-plus: **Plus** in your avatar and set a profile picture. Adjust your picture size and click **Make this my profile picture**.
|
||||
1. Click **Next** to complete your profile customization.
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
---
|
||||
id: 32
|
||||
title: Download Status for Linux
|
||||
---
|
||||
|
||||
The Status desktop app is the best way to use Status on Linux. Take a look at the steps below to get started.
|
||||
|
||||
## Step 1: Download the Linux app
|
||||
|
||||
1. Visit [status.im/get :octicons-tab-external-16:][status-web-download]
|
||||
1. Under the **Desktop** section, click the **Linux** button.
|
||||
1. Locate the file in your Downloads folder (the download file name begins with StatusIm-Desktop).
|
||||
1. Open Terminal and change the directory to your Downloads folder. Example:
|
||||
|
||||
```shell
|
||||
cd ~/Downloads
|
||||
```
|
||||
|
||||
1. Run the following command in your terminal to extract the tarball file:
|
||||
|
||||
```shell
|
||||
tar xvf StatusIm-Desktop-*.tar.gz
|
||||
```
|
||||
|
||||
:::info
|
||||
Replace the \* with the Status app version number. For example: `StatusIm-Desktop-v1.2.tar.gz`
|
||||
:::
|
||||
|
||||
1. Optionally, [verify the Status app GPG signature](#verify-the-status-app-gpg-signature).
|
||||
1. To launch Status, go to the directory where you have the Status app and double click the AppImage file.
|
||||
|
||||
## Step 2: Run the Status app for the first time
|
||||
|
||||
If this is the first time you run Status on your computer, check [Run the Status app for the first time][run-the-status-app-for-the-first-time].
|
||||
|
||||
## Verify the Status app GPG signature
|
||||
|
||||
When you verify the GPG signature of the Status app, you confirm that the app has not been altered. To verify the GPG signature on Linux, you use Status app public key and the [GNU Privacy Guard (or GPG) :octicons-tab-external-16:][gnu-privacy-guard] software that comes with most Linux distributions.
|
||||
|
||||
1. Open Terminal and change to the directory with the Status AppImage file.
|
||||
1. Download and import the Status release public key:
|
||||
|
||||
```sh
|
||||
curl -s 'https://status.im/gpg/release.asc' | gpg --import
|
||||
|
||||
```
|
||||
|
||||
1. Update the GPG trust database to include the Status' public key:
|
||||
|
||||
```sh
|
||||
echo '1DD92FFA442D4B5C85C039231A151FD0883555FE:6:' | gpg --import-ownertrust
|
||||
|
||||
```
|
||||
|
||||
1. Validate the Status app GPG signature. For example, if you downloaded the Status app version 1.2, run this command:
|
||||
|
||||
```shell
|
||||
gpg --verify 'StatusIm-Desktop-v1.2.AppImage.asc'
|
||||
```
|
||||
|
||||
1. The GPG signature verification is sucessful when you can see the `Good signature` message. Example:
|
||||
|
||||
```shell
|
||||
gpg: Good signature from "Status.im Release Signing (GPG key for signing Status.im release builds.) <admin@status.im>" [ultimate]
|
||||
```
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
id: 104
|
||||
revision: 1#357
|
||||
language: en
|
||||
title: Download Status for Mac
|
||||
---
|
||||
|
||||
The Status desktop app is the best way to experience Status on the Mac operating system (macOS). The app works on Mac computers using either the Apple silicon processor or the Intel processor.
|
||||
|
||||
## Download the Status app
|
||||
|
||||
1. Visit [status.im/get :octicons-tab-external-16:][status-web-download].
|
||||
1. Under the **Desktop** section, click the **Mac** button.
|
||||
1. Once the download is complete, open a Finder window and select your Downloads folder.
|
||||
1. Double click the Status .dmg file.
|
||||
1. In the new window that opens, drag and drop the Status icon to the Applications folder.
|
||||
1. To launch the Status app, open the Applications folder and double-click the Status icon.
|
||||
|
||||
## Common questions
|
||||
|
||||
### I have downloaded the Status app from a different website
|
||||
|
||||
To protect yourself from malware, viruses or scams, always download the Status app from a trusted source. For the Mac version, use the [Status website :octicons-tab-external-16:](https://status.im/get).
|
||||
|
||||
### Nothing happens on my Mac when I try to open the Status app
|
||||
|
||||
Make sure that your Mac has the minimum software required to run the Status app.
|
||||
|
||||
### My Mac shows a security message when I try to install the Status app
|
||||
|
||||
Download the Status app for Mac from the [Status website :octicons-tab-external-16:](https://status.im/get/). If your Mac still shows a security message and you can't install the Status app, check the [Safely open apps on your Mac :octicons-tab-external-16:](https://support.apple.com/en-us/HT202491) Apple Support article for more information.
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
# id: ''
|
||||
revision: '0'
|
||||
title: Download Status for Windows
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 106
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Download the Status mobile app
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 98
|
||||
revision: '0'
|
||||
language: en
|
||||
title: 'How to use Status: your quick start guide'
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 615
|
||||
revision: '0'
|
||||
language: en
|
||||
title: 'If you upgrade from the old Status app'
|
||||
---
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: Getting started
|
||||
---
|
||||
|
||||
Find out what makes Status unique, run Status for the first time and discover essential app features.
|
||||
|
||||
## Intro to Status
|
||||
|
||||
- [What is **Status**][what-is-status]
|
||||
- [How to use Status: your **quick start guide**][how-to-use-status-your-quick-start-guide]
|
||||
- [Understand **your actions** in Status][understand-your-actions-in-status]
|
||||
- [About the **Ethereum blockchain**][about-the-ethereum-blockchain]
|
||||
- [**Layer-2 scaling** solutions for Ethereum][layer-2-scaling-solutions-for-ethereum]
|
||||
|
||||
## Getting started for new users
|
||||
|
||||
- [**Run** the Status app for the **first time**][run-the-status-app-for-the-first-time]
|
||||
- [**Create or restore** your Status profile using a **recovery phrase**][create-or-restore-your-status-profile-using-a-recovery-phrase]
|
||||
- [**Sign into** your Status profile on a new device][sign-into-your-status-profile-on-a-new-device]
|
||||
- [**Add a contact** in Status][add-a-contact-in-status]
|
||||
- [**Join** a Status Community][join-a-status-community]
|
||||
- [**Invite friends** to Status][invite-friends-to-status]
|
||||
- [**Status Wallet**: your quick start guide][status-wallet-your-quick-start-guide]
|
||||
- [[Secure your information and funds]]:[]
|
||||
|
||||
## Getting started with your community
|
||||
|
||||
- [**Create** a Status Community][create-a-status-community]
|
||||
- [Getting started for **community owners**][getting-started-for-community-owners]
|
||||
- [About Status **Web Communities**][about-status-web-communities]
|
||||
|
||||
## Download Status
|
||||
|
||||
- [Download Status for **Windows**][download-status-for-windows]
|
||||
- [Download Status for **Mac**][download-status-for-mac]
|
||||
- [Download Status for **Linux**][download-status-for-linux]
|
||||
- [Download the Status **mobile app**][download-the-status-mobile-app]
|
||||
- [If you **upgrade** from the old Status app][if-you-upgrade-from-the-old-status-app]
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
id: 407
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Invite friends to Status
|
||||
---
|
||||
|
||||
If some of your friends don't have Status profiles yet, you can invite them and help them find you in the app. Once they [download][download-status] and install Status, [share your profile with them][share-your-status-profile] and ask them to [add you to their contacts][add-a-contact-in-status].
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 103
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Join a Status Community
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 594
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Layer-2 scaling solutions for Ethereum
|
||||
---
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
---
|
||||
id: 41
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Run the Status app for the first time
|
||||
---
|
||||
|
||||
When you run Status for the first time, the app creates a pair of [cryptographic keys] [understand-your-status-keys-and-recovery-phrase] representing your Status identity. Unlike centralized apps, Status doesn't rely on your username or email address to identify your profile. Instead, it uses your private and public keys.
|
||||
|
||||
These keys are securely stored on your device and protected by your Status password. To understand how these keys work and how they protect your data and privacy, check out [Understand your Status keys and recovery phrase][understand-your-status-keys-and-recovery-phrase].
|
||||
|
||||
## Create a new Status profile
|
||||
|
||||
If you want to create your profile from an existing recovery phrase, check out [Create or restore your Status profile using a recovery phrase][create-or-restore-your-status-profile-using-a-recovery-phrase]. If you're going to use a Keycard to create your profile, check out [Create or restore your Status profile using Keycard][create-or-restore-your-status-profile-using-keycard].
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. Open the Status app and tap **I'm new to Status**.
|
||||
1. On the following screen, select **Generate keys**.
|
||||
1. [Customize your Status profile](#customize-your-profile) with your preferred name, profile picture and colour, and tap **Continue**.
|
||||
1. Enter and confirm your password and tap **Confirm password**.
|
||||
1. Configure your device's biometrics (fingerprint, face or other) to fill in your password. If you want to enable biometrics later, tap **Maybe later**.
|
||||
1. On the **profile identifiers** screen, you can learn more about your Status profile or tap **Skip** to finish the profile setup.
|
||||
1. Tap **Start using Status**.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
### Step 1: Generate new keys
|
||||
|
||||
1. Open the Status app. Your operating system may ask you to set your notification preferences for Status. In the **Allow notifications** screen, click **OK, got it**.
|
||||
1. Check the box to accept the Status **Terms of Use and Privacy Policy** and click **Get Started**. You can find and read this information on the [Status website :octicons-tab-external-16:][status-website].
|
||||
1. On the welcome screen, click **I am new to Status**.
|
||||
1. Click **Generate new keys**.
|
||||
|
||||
### Step 2: Create your password and customize other settings
|
||||
|
||||
1. On the **Your profile** screen, [customize your Status profile](#customize-your-profile) with your preferred name, profile picture, and colour, and click **Continue**.
|
||||
1. On the **Your emojihash and identicon ring** screen, you can learn more about your Status profile. Click **Next**.
|
||||
1. Enter and confirm your password and click **Create password**.
|
||||
1. Confirm your password again and click **Finalize Status Password Creation**.
|
||||
1. Enable your device's biometrics (fingerprint, face or other) to fill in your password. Alternatively, click **I prefer to use my password**.
|
||||
|
||||
To protect your Status data and funds, [back up and secure your recovery phrase][back-up-and-secure-your-recovery-phrase] immediately after creating your profile.
|
||||
|
||||
:::warn
|
||||
Status doesn't know your password and can't reset it for you. If you forget your password, you may lose access to your Status profile and wallet funds. Remember your Status password, keep it in a safe place and don't share it with anyone.
|
||||
:::
|
||||
|
||||
## Customize your profile
|
||||
|
||||
Here you only fill out basic information. You can customize your Status profile further at any time in the [Status settings][edit-your-status-profile].
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. On the **Create profile** screen, set your profile name. Don't use special characters or emojis.
|
||||
1. Tap the :mobile-camera: **Camera** in your avatar and set a profile picture. To add your profile picture, you must authorize the Status app to access your camera or photo gallery.
|
||||
1. Choose a profile colour.
|
||||
1. Tap **Continue** to complete your profile customization.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. On the **Your profile** screen, set your profile name. Don't use special characters or emojis.
|
||||
1. Click :desktop-plus: **Plus** in your avatar and set a profile picture. Adjust your picture size and click **Make this my profile picture**.
|
||||
1. Click **Next** to complete your profile customization.
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
# id
|
||||
revision: '0'
|
||||
title: Understand your actions in Status
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 101
|
||||
revision: '0'
|
||||
language: en
|
||||
title: What is Status
|
||||
---
|
||||
|
|
@ -0,0 +1,91 @@
|
|||
---
|
||||
id: 0
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Getting Started
|
||||
author: jorge-campo
|
||||
---
|
||||
|
||||
amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea **commodo consequat**. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
|
||||
## New heading
|
||||
|
||||
**Aute consequat cillum enim eu mollit sunt aute. Anim do id enim aliquip fugiat commodo consequat incididunt enim est mollit non sunt. Officia aliqua elit exercitation exercitation.**
|
||||
|
||||
_Tempor laborum nostrud commodo anim tempor irure id eiusmod qui. Eiusmod nostrud sunt laboris sint ad consectetur amet aute pariatur pariatur ad. Quis quis incididunt aliqua excepteur et enim mollit._
|
||||
|
||||
~~Ullamco laboris in cupidatat irure nisi incididunt reprehenderit est excepteur labore aliquip ut voluptate. Enim quis nulla labore aliquip nostrud commodo. Qui mollit reprehenderit id sunt.~~
|
||||
|
||||
Laboris dolore eu nulla sunt. **Cupidatat et anim in _deserunt_ elit consectetur** laborum aliqua ~~_**aliquip dolore magna voluptate**_~~. Nostrud cupidatat laboris.
|
||||
|
||||
## H2
|
||||
|
||||
Elit excepteur exercitation duis ea proident laborum sunt sunt laboris irure tempor nisi. Ex culpa occaecat et sit pariatur adipisicing voluptate. Sit ullamco consectetur deserunt et. Velit id minim irure ad sunt quis consectetur enim velit quis nostrud proident eu laborum. Aliqua incididunt elit et nisi qui mollit. Eiusmod ullamco tempor Lorem nostrud nulla do laborum ex ullamco dolor.
|
||||
|
||||
### H3
|
||||
|
||||
Consectetur exercitation minim duis excepteur quis culpa veniam dolor. Sit ipsum adipisicing eiusmod aliqua. Labore amet minim reprehenderit magna sunt ad minim nisi aliqua. Cupidatat dolore aliquip excepteur sit duis incididunt qui id ea. Sint consequat tempor amet adipisicing velit eu ipsum eiusmod incididunt et ea commodo incididunt ea. Excepteur voluptate ullamco est ea occaecat velit.
|
||||
|
||||
Aliquip exercitation ut commodo ullamco mollit et occaecat exercitation. Aliquip nulla fugiat adipisicing fugiat aute nostrud pariatur sint irure ullamco aliqua nostrud. Ea elit reprehenderit amet est esse culpa sit. Aliqua minim ad eiusmod duis. Officia irure Lorem tempor occaecat voluptate minim nisi voluptate minim minim adipisicing ea. Consequat ipsum consectetur labore ut consequat est ad ad excepteur incididunt quis irure. Deserunt ea magna fugiat sunt ea.
|
||||
|
||||
## Images
|
||||
|
||||
|
||||
|
||||
## Lists
|
||||
|
||||
### Unordered
|
||||
|
||||
- one
|
||||
- two
|
||||
- three
|
||||
|
||||
### Ordered
|
||||
|
||||
1. one
|
||||
2. two
|
||||
3. three
|
||||
|
||||
### Tasks
|
||||
|
||||
- [ ] one
|
||||
- [ ] two
|
||||
- [ ] three
|
||||
|
||||
## Admonitions
|
||||
|
||||
:::warn
|
||||
Here is some warning
|
||||
:::
|
||||
|
||||
:::info
|
||||
Here is some warning <br/>
|
||||
:::
|
||||
|
||||
:::tip
|
||||
Here is some warning
|
||||
:::
|
||||
|
||||
### Code blocks
|
||||
|
||||
Needs some improvement on styling.
|
||||
|
||||
```ts
|
||||
const a = 1
|
||||
const b = 2
|
||||
const c = a + b
|
||||
console.log(c)
|
||||
```
|
||||
|
||||
## Work in progress
|
||||
|
||||
### Tables
|
||||
|
||||
| Name | Age |
|
||||
| :------- | :-- |
|
||||
| John Doe | 30 |
|
||||
| Jane Doe | 25 |
|
||||
|
||||
### Tabs
|
||||
|
||||
### Icons
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
id: 295
|
||||
revision: '0'
|
||||
language: en
|
||||
title: About losing access to a channel
|
||||
---
|
||||
|
||||
There are two types of channels in [Status Communities][about-status-communities]: [public and private][channels-your-quick-start-guide]. When you join a community, you automatically get access to all public channels and private channels for which you meet the [channel requirements][understand-token-requirements-in-channels].
|
||||
|
||||
:::tip
|
||||
Private channels show a :mobile-locked-lock: lock icon next to the channel name.
|
||||
:::
|
||||
|
||||
You can lose access to a channel for two reasons:
|
||||
|
||||
- You lose access to the community. Check out [About losing access to a community][about-losing-access-to-a-community] for more information.
|
||||
- You no longer [hold the required tokens][understand-token-requirements-in-channels] for a private channel. If you lose access to a private channel, you must request to [join the channel][join-a-channel] again.
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
id: 125
|
||||
revision: '0'
|
||||
language: en
|
||||
title: About Status messages
|
||||
---
|
||||
|
||||
Messaging is a critical Status component. The Status app combines [peer-to-peer messaging][peer-to-peer-messaging] technologies with robust end-to-end encryption across all your devices. Peer-to-peer messaging eliminates the need for centralized servers and intermediaries, providing a censorship-resistant alternative to other popular messaging apps.
|
||||
|
||||
We've built the Status app to keep your messages and information out of our reach. Other messaging apps offer end-to-end encryption, but their centralized network design allows interpretation of who is talking to whom and where. See how Status compares to other messaging apps in the table below:
|
||||
|
||||
| Privacy feature | Status | Other messaging apps |
|
||||
| :---------------------------- | :------------------- | :------------------- |
|
||||
| End-to-end encryption | :material-check-all: | :material-check-all: |
|
||||
| Network metadata encryption | :material-check-all: | :octicons-x-24: |
|
||||
| "Who talks to who" encryption | :material-check-all: | :material-check: |
|
||||
| Censorship resistant | :material-check-all: | :octicons-x-24: |
|
||||
| Anonymous | :material-check-all: | :material-check: |
|
||||
| Open source | :material-check-all: | :material-check: |
|
||||
|
||||
(:material-check-all: available, :material-check: available on some apps, :octicons-x-24: not available )
|
||||
|
||||
## The basics
|
||||
|
||||
- Your communications are end-to-end encrypted by default.
|
||||
- Your messages are not stored on centralized servers.
|
||||
- Only you and the message recipient can read your messages.
|
||||
- Status cannot identify you or other participants in the conversation.
|
||||
|
||||
:::tip
|
||||
For answers to general questions about your Status messages, check the [Messages FAQ][messages-faq] topic.
|
||||
:::
|
||||
|
||||
## Understand peer-to-peer messaging
|
||||
|
||||
Status provides resilient messaging without relying on centralized servers, data centers, or service providers. The Status app uses [Waku :octicons-tab-external-16:][waku], a peer-to-peer protocol for private, secure, and censorship-resistant communication.
|
||||
|
||||
Unlike centralized networks (A), which depend on a central server to relay messages, peer-to-peer networks (B) encrypt and broadcast every message to all participant nodes. A node is a computer or smartphone that relays messages to other nodes or temporarily stores them for disconnected peers. Even when all nodes can access your messages, the content is encrypted so that only you and the intended recipients can read them.
|
||||
|
||||
|
||||
|
||||
## Built-in privacy and security
|
||||
|
||||
The Status app secures your messages the entire time they are in transit using end-to-end encryption. This industry standard protection uses strong encryption keys and ensures that only you and the recipients can read your messages. No one else (not even Status) can read your conversations or identify you or other participants.
|
||||
|
||||
When you communicate with someone on the Status app, your messages, attachments, sender metadata, group chats, and group metadata are all end-to-end encrypted.
|
||||
|
||||
Status incorporates the [Perfect Forward Secrecy :octicons-tab-external-16:][perfect-forward-secrecy] (PFS) encryption mechanism, ensuring that encryption keys change on every message. If your keys are compromised, only the associated message is compromised. All previous messages remain private.
|
||||
|
||||
:::info
|
||||
Status messaging protects your privacy in one-to-one communications, chat groups, public chats, and Communities.
|
||||
:::
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
id: 276
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Add members to a group chat
|
||||
---
|
||||
|
||||
Any member of an existing group chat can add their [Status contacts][send-a-contact-request] to the chat. The maximum number of members is 50. Due to Status's security policy, new joiners won't be able to see the previous message history.
|
||||
|
||||
If you want to create a new chat, see [Create a group chat][create-a-group-chat] instead.
|
||||
|
||||
## Add members
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-messages: Messages.
|
||||
2. Open the group chat you want to add new members to.
|
||||
3. From the navigation bar, tap :mobile-more-options: **More options**.
|
||||
4. Tap :mobile-placeholder: **Add members**. If you're the group chat owner, this will say :mobile-placeholder: **Add / remove members** for you.
|
||||
5. Check the boxes next to the contacts you want to invite. Once you're done, tap **Confirm changes**.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click :desktop-chat: **Chat**.
|
||||
2. Open the group chat you want to add new members to.
|
||||
3. From the navigation bar at the top, click :desktop-more-options: **More options**.
|
||||
4. Click :desktop-group-chat: **Add / remove from group**.
|
||||
5. Type the Status handle of the contact you want to invite and select them. Once you're done, click **Confirm**.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 624
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Add people to a direct message
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 329
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Add, remove or share sticker sets
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 323
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Change who can invite you to group chats
|
||||
---
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
id: 320
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Clear group chat history
|
||||
---
|
||||
|
||||
Clearing a group chat history clears all messages inside the chat. Only the group chat owner can clear its history for all members.
|
||||
|
||||
If you’re not the owner, you’ll clear the chat history just for yourself. Everyone else will still see the full history.
|
||||
|
||||
:::info
|
||||
Once you clear the chat history, it can't be retrieved or restored.
|
||||
:::
|
||||
|
||||
## Clear group chat history
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-messages: Messages.
|
||||
2. Open the group chat whose history you want to clear.
|
||||
3. Tap :mobile-more-options: **More options**.
|
||||
4. Select :mobile-placeholder: **Clear history**.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation bar, click :desktop-chat: Chat.
|
||||
2. Open the group chat whose history you want to clear.
|
||||
3. Click :desktop-more-options: **More options**.
|
||||
4. Select :mobile-placeholder: **Clear history**.
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
id: 267
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Create a group chat
|
||||
---
|
||||
|
||||
Group chats are conversations of more than two people. To invite someone to a group chat, you need to have them on your Status contact list.
|
||||
|
||||
Group chats are different to communities, as they're meant to unite smaller groups of people or be centred around specific topics. For more information about group chats, see [Understand group chats][understand-group-chats].
|
||||
|
||||
## What to expect
|
||||
|
||||
- You can invite up to 20 members to your group chat. If you need more, consider [creating a community][create-a-status-community].
|
||||
- Once you create your group chat, you can [customize it][customize-a-group-chat] and [add members][add-members-to-a-group-chat], as well as [remove them][remove-members-from-a-group-chat].
|
||||
- Group chats are always end-to-end [encrypted][privacy-and-security] with secure cryptographic keys. Only the group chat members will have access to the messages in it. Status doesn't have the keys and can't access any messages by design.
|
||||
|
||||
## Create a group chat
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-messages: **Messages**.
|
||||
2. Tap :mobile-add: **Plus**.
|
||||
3. Select **New chat**.
|
||||
4. Check the boxes next to the contacts you want to invite to your chat. Tap **Setup group chat**.
|
||||
5. Choose a name and highlight colour for your group chat. All members will be able to see both the name and the colour. Once you're finished, tap **Create group chat**.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click :desktop-chat: **Chat**.
|
||||
2. Click :desktop-start-chat: **Start chat**.
|
||||
3. From your contact list, select those you want to add to this group chat.
|
||||
4. Optionally, type a message in the Message text field to start the group chat with. You can also leave it blank.
|
||||
5. Click **Confirm** or press ++return++ to create your group chat.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 275
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Customize a group chat
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 317
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Delete a chat with someone
|
||||
---
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
id: 272
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Delete a group chat
|
||||
---
|
||||
|
||||
If you don’t need a [group chat][understand-group-chats] anymore, you can delete the chat. Once you do that, the chat history and member list are gone forever, with no way to recover this or any other data.
|
||||
|
||||
:::info
|
||||
Only the group chat owner can delete the group. If you're a regular member, consider [leaving the chat][leave-a-group-chat] instead.
|
||||
:::
|
||||
|
||||
## Delete a group chat
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-messages: Messages.
|
||||
2. Open the group chat you want to delete.
|
||||
3. Tap :mobile-more-options: **More options**.
|
||||
4. Select :mobile-placeholder: **Leave and delete group**.
|
||||
5. Tap **Leave and delete**.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation bar, click :desktop-chat: Chat.
|
||||
2. Open the group chat you want to delete.
|
||||
3. Click :desktop-more-options: **More options**.
|
||||
4. Select :desktop-leave-group-chat: **Leave and delete group**.
|
||||
5. Click **Leave and delete**.
|
||||
|
|
@ -0,0 +1,56 @@
|
|||
---
|
||||
id: 249
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Edit and delete your messages
|
||||
---
|
||||
|
||||
Instead of a centralized server, Status uses a [peer-to-peer network][about-status-messages] to store and distribute messages. When you edit or delete a message, the peer-to-peer network distributes your changes to other users running the Status app.
|
||||
|
||||
In some cases, users may still see your original messages, even after you edit or delete them. For example, some users can:
|
||||
|
||||
- Run an out-of-date version of the Status app that isn't fully compatible with the peer-to-peer network features.
|
||||
- Run a custom build of the Status app that doesn't support message editing and deletion by choice.
|
||||
- Disconnect from the network before receiving your latest changes.
|
||||
|
||||
:::info
|
||||
Be careful with what you share, especially in communities. Once published to the network, what you shared may still remain on someone's device even if you choose to delete it later.
|
||||
:::
|
||||
|
||||
### What to expect
|
||||
|
||||
- You can edit and delete your Status messages with no time limitations.
|
||||
- You can only edit text messages. If you want to change a message that contains media content, consider [deleting](#delete-your-messages) and re-sending it.
|
||||
- Once you edit a message, a permanent note appears next to your message saying it was edited.
|
||||
- In communities and group chats, you can hide messages you don't want to see with **Delete for me**. Everyone else will still be able to see this message.
|
||||
- To delete a message for everyone, select **Delete for everyone**. You can only delete your own messages.
|
||||
|
||||
## Edit your messages
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. Open the community, DM chat or group chat with the message you want to delete.
|
||||
2. Long press this message.
|
||||
3. Select :mobile-edit: **Edit message**.
|
||||
4. Make your changes.
|
||||
5. Tap :mobile-send: **Send** to publish your changes.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. Open the community, DM chat or group chat with the message you want to delete.
|
||||
2. Hover over your message and click :desktop-edit: **Edit**.
|
||||
3. Make your changes and click **Save**.
|
||||
|
||||
## Delete your messages
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. Open the community, DM chat or group chat with the message you want to delete.
|
||||
2. Long press this message.
|
||||
3. Select :mobile-delete: **Delete Message**.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. Open the community channel, DM chat or group chat with the message you want to delete.
|
||||
2. Hover over your message and click :desktop-delete: **Delete**.
|
||||
3. Click **Confirm** to delete your message. You can also check the **Do not show this again** box to delete messages without confirmation in future.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 246
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Find people on Status
|
||||
---
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
id: 213
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Format your messages
|
||||
---
|
||||
|
||||
:::info
|
||||
The formatting options are not available on Status Web.
|
||||
:::
|
||||
|
||||
You can format text inside your messages to clarify or emphasize information. Formatting can make your communication more effective, especially for long messages.
|
||||
|
||||
In Status, you format your messages using the formatting toolbar or markup by surrounding the text with special characters.
|
||||
|
||||
## Formatting toolbar
|
||||
|
||||
To format your text using the formatting toolbar, select the text and choose the desired formatting option. You can also format a message you've already sent by [editing the message][edit-and-delete-your-messages]. The formatting toolbar is only available on Status desktop.
|
||||
|
||||
|
||||
|
||||
:::tip
|
||||
When you press ++return++ in Status desktop, your message is sent. If you want to start a new line, press ++shift+return++
|
||||
:::
|
||||
|
||||
## Markup
|
||||
|
||||
You can use markup options to format your text in the Status desktop and mobile apps.
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
title: Messaging and Web3 browser
|
||||
---
|
||||
|
||||
Send messages and files, create group chats or explore decentralized apps with the Status Web3 browser.
|
||||
|
||||
## Direct messages
|
||||
|
||||
- [Understand **direct messages**][understand-direct-messages]
|
||||
- [**Share** your Status **profile**][share-your-status-profile]
|
||||
- [**Find people** on Status][find-people-on-status]
|
||||
- [**Add a contact** in Status][add-a-contact-in-status]
|
||||
- [Send direct messages **to your contacts**][send-direct-messages-to-your-contacts]
|
||||
- [**Add people** to a direct message][add-people-to-a-direct-message]
|
||||
- [**Delete** a chat with someone][delete-a-chat-with-someone]
|
||||
|
||||
## Group chats
|
||||
|
||||
- [**Understand** group chats][understand-group-chats]
|
||||
- [**Create** a group chat][create-a-group-chat]
|
||||
- [**customize** a group chat][customize-a-group-chat]
|
||||
- [**Add members** to a group chat][add-members-to-a-group-chat]
|
||||
- [**Join** a group chat][join-a-group-chat]
|
||||
- [**Clear** group chat **history**][clear-group-chat-history]
|
||||
- [**Change** who can invite you to group chats][change-who-can-invite-you-to-group-chats]
|
||||
- [**Remove members** from a group chat][remove-members-from-a-group-chat]
|
||||
- [**Delete** a group chat][delete-a-group-chat]
|
||||
- [**Leave** a group chat][leave-a-group-chat]
|
||||
|
||||
## Message features and tools
|
||||
|
||||
- [About Status **messages**][about-status-messages]
|
||||
- [Messages **FAQ**][messages-faq]
|
||||
- [**Format** your messages][format-your-messages]
|
||||
- [**Edit** and **delete** your messages][edit-and-delete-your-messages]
|
||||
- [**Pin** a message][pin-a-message]
|
||||
- [**React and reply** to messages][react-and-reply-to-messages]
|
||||
- [Enable **rich link previews** in messages][enable-rich-link-previews-in-messages]
|
||||
- [**Use mentions** in Status][use-mentions-in-status]
|
||||
- [**Mute** your notifications][mute-your-notifications]
|
||||
|
||||
## Share files and conversations
|
||||
|
||||
- [**Share** images in Status][share-images-in-status]
|
||||
- [**Send** an **audio** message][send-an-audio-message]
|
||||
- [Send **GIFs and Stickers**][send-gifs-and-stickers]
|
||||
- [Add, remove or share **sticker sets**][add-remove-or-share-sticker-sets]
|
||||
- [Share a **conversation**][share-a-conversation]
|
||||
|
||||
## Status Web3 browser
|
||||
|
||||
- [Set the **default browser** in Status][set-the-default-browser-in-status]
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
id: 273
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Join a group chat
|
||||
---
|
||||
|
||||
In Status, the only way to join a [group chat][understand-group-chats] is to ask your contact who’s already a member to invite you. Refer them to [Add members to a group chat][add-members-to-a-group-chat] for instructions on how they can do that.
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
id: 278
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Leave a group chat
|
||||
---
|
||||
|
||||
If you don’t want to be a member of a [group chat][understand-group-chats] anymore, you can leave the chat. You can always [re-join the chat][join-a-group-chat] later if you change your mind.
|
||||
|
||||
Once you leave, a note appears in the group chat's message history letting other members know that you left the chat. You will still be able to access the group chat messages that were sent before you left.
|
||||
|
||||
If someone is adding you to group chats you don't want to be in, consider [changing who can invite you to group chats][change-who-can-invite-you-to-group-chats] or [blocking that person][block-someone-in-status].
|
||||
|
||||
:::info
|
||||
The group chat owner can't leave without deleting the chat for everyone. For more information, check out [Delete a group chat][delete-a-group-chat].
|
||||
:::
|
||||
|
||||
## Leave a group chat
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-messages: **Messages**.
|
||||
2. Open the group chat you want to leave.
|
||||
3. Tap :mobile-more-options: **More options**.
|
||||
4. Select :mobile-log-out: **Leave group**.
|
||||
5. Tap **Leave**.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click :desktop-chat: **Chat**.
|
||||
2. Open the group chat you want to leave.
|
||||
3. Click :desktop-more-options: **More options**.
|
||||
4. Select :desktop-leave-group-chat: **Leave group**.
|
||||
5. Click **Leave**.
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
---
|
||||
id: 232
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Messages FAQ
|
||||
---
|
||||
|
||||
Messaging others is an important part of your Status experience, along with [Status Communities][how-to-use-communities-your-quick-start-guide], the [Status Wallet][status-wallet-your-quick-start-guide] and the [Status Web3 browser][how-to-use-status-browser-your-quick-start-guide]. In Status, you can message others and chat in communities privately and securely.
|
||||
|
||||
The Status app provides a privacy-centric messenger using decentralized [peer-to-peer (P2P) technology][about-status-messages] and strong end-to-end (E2EE) encryption.
|
||||
|
||||
## General questions
|
||||
|
||||
### What makes Status messaging decentralized?
|
||||
|
||||
Instead of centralized networks, which rely on servers controlled by corporations or governments, Status uses a distributed network of nodes. This network is based on Waku, a [peer-to-peer protocol][about-status-messages] for private, secure and censorship-resistant communication.
|
||||
|
||||
In a distributed network, users can securely and directly exchange data without intermediaries that could potentially compromise their privacy.
|
||||
|
||||
### Peer-to-peer networks send messages to every node. Is this not a risk?
|
||||
|
||||
No, it's not. While it's true that messages are sent to every node in a peer-to-peer network, these messages are encrypted. Only the intended recipient can decrypt and read the message.
|
||||
|
||||
### How is Status messaging censorship-resistant?
|
||||
|
||||
The Status peer-to-peer network ensures the resilience of the messaging network. For instance, when a network node is shut down or blocked, you can still connect to other nodes.
|
||||
|
||||
Status supports free speech infrastructure that prevents us, or anyone else, from censoring you.
|
||||
|
||||
:::info
|
||||
Nodes in the network still rely on having an internet connection. So if your internet provider (or an authoritarian regime) shuts down your network, Status messaging won't work.
|
||||
:::
|
||||
|
||||
## Status messaging
|
||||
|
||||
### Are my messages in the blockchain?
|
||||
|
||||
No, your messages are not in the blockchain and are not transported through the [Ethereum network][about-the-ethereum-blockchain]. Messages are temporarily stored in the peer-to-peer network.
|
||||
|
||||
### Can I delete my messages?
|
||||
|
||||
Yes, you can always [edit and delete your messages][edit-and-delete-your-messages].
|
||||
|
||||
In some cases, users may still see your original messages, even after you edit or delete them. Check out [Edit and delete your messages][edit-and-delete-your-messages] for more information.
|
||||
|
||||
### If I'm disconnected, can I still access my messages?
|
||||
|
||||
The [peer-to-peer network][about-status-messages] store messages that couldn't be delivered for up to 30 days. Your device downloads and securely stores these messages permanently when you connect to the network. Messages stored on your device are always available offline.
|
||||
|
||||
## Privacy and security
|
||||
|
||||
### How does Status protect my privacy?
|
||||
|
||||
Status implements end-to-end encryption (E2EE) using [cryptographic keys][understand-your-status-keys-and-recovery-phrase]. When you send a message, the message is encrypted using the recipient's public key. The only way to decrypt the message and read its content is by using the recipient's private key. Even if a malicious actor intercepts the message, they can't read its content as they don't have the private key.
|
||||
|
||||
:::info
|
||||
The [Waku network][waku] implements additional privacy capabilities in addition to E2EE, such as sender anonymity or metadata protection.
|
||||
:::
|
||||
|
||||
### Other messaging apps use E2EE encryption; why use Status?
|
||||
|
||||
While other messaging apps offer E2EE encryption, their centralized network design allows interpretation of who is talking to whom and where. These messaging apps can collect and sell your data and create a profile about you.
|
||||
|
||||
We've built Status so your information is secure and out of our reach. However, it's important to remember that no privacy tool can guarantee absolute data security.
|
||||
|
||||
### Can Status read my messages?
|
||||
|
||||
No. No one besides you and the intended recipient can read your messages. For more information on how Status messaging protects your privacy, check out [About your Status keys][about-status-keys].
|
||||
|
||||
### Who owns the peer-to-peer network nodes?
|
||||
|
||||
Anybody running the Status app becomes a node in the peer-to-peer network. This contributes to a more decentralized and resilient network.
|
||||
|
||||
:::info
|
||||
Currently, Status runs nodes to ensure messages can be delivered reliably to disconnected peers.While all traffic is encrypted and out of Status reach, we hope to reduce Status participation progressively.
|
||||
:::
|
||||
|
||||
### Is Status really decentralized if Status runs some of the network nodes?
|
||||
|
||||
The fact that Status users are part of the network is a crucial feature of the decentralized design. As long as the network remains open and accessible to all users and is not controlled by a single entity, Status' operation of some network nodes does not undermine this design.
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
id: 339
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Pin a message
|
||||
---
|
||||
|
||||
You can pin important information in group chats so that it doesn't get lost in the message history. For example, you can pin your chat rules, event announcements and FAQ.
|
||||
|
||||
Chat members can pin both their own and other members' messages. Message pinning is available in direct messages (DMs), group chats and community channels.
|
||||
|
||||
Once you pin a message, it's highlighted and gets a label saying who pinned it.
|
||||
|
||||
## Pin a message
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-messages: Messages.
|
||||
2. Open the chat you want to pin a message in.
|
||||
3. Tap the message you want to pin.
|
||||
4. Tap :mobile-pin: **Pin to the chat**.
|
||||
To unpin a message, tap it and select :mobile-pin: **Unpin**.
|
||||
|
||||
To view all pinned messages in a group or direct messages chat, open this chat and tap :mobile-pin: **Pinned messages**. If the chat's full, tap the ribbon with the :mobile-pin: **Pin** icon underneath the chat's name.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click :desktop-chat: **Chat**.
|
||||
2. Open the chat you want to pin a message in.
|
||||
3. Hover over the message you want to pin.
|
||||
4. Click :desktop-pin: **Pin**.
|
||||
To unpin a message, hover over it and click :desktop-unpin: **Unpin**.
|
||||
|
||||
To view all pinned messages in a group or DM chat, click :desktop-pin: **N pinned messages** underneath the chat's name. In communities, this will say :desktop-pin: **N**, where N is the number of currently pinned messages.
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
id: 386
|
||||
revision: '0'
|
||||
language: en
|
||||
title: React and reply to messages
|
||||
---
|
||||
|
||||
In Status, you can reply to specific messages and react with emojis.
|
||||
|
||||
Replies are useful for when you want to make it clear who you are responding to, as well as receive a faster reply from them. Users whose messages you reply to receive notifications in their [Notification Centre][your-status-notifications-guide].
|
||||
|
||||
Reactions are helpful when you want to show others that you saw their message. Users whose messages you react to do not receive any notifications.
|
||||
|
||||
## React to messages
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. Open the group chat, DM chat or community channel with the message you want to react to.
|
||||
2. Long press the message.
|
||||
3. Choose an emoji to react with and tap it.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. Open the group chat, DM chat or community channel with the message you want to react to.
|
||||
2. Open the chat with the message you want to react to.
|
||||
3. Hover over the message.
|
||||
4. Click :desktop-emojis: **Add reaction**.
|
||||
5. Choose an emoji to react with and click it.
|
||||
|
||||
## Reply to messages
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. Open the group chat, DM chat or community channel with the message you want to react to.
|
||||
2. Long press the message.
|
||||
3. Tap :mobile-reply: **Reply**.
|
||||
4. Type your reply and tap :mobile-send: **Send**.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. Open the group chat, DM chat or community channel with the message you want to react to.
|
||||
2. Hover over the message and click :desktop-reply: **Reply**.
|
||||
3. Type your reply and press ++return++.
|
||||
|
||||
:::tip
|
||||
You can reply with text, emojis, images and stickers.
|
||||
:::
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
id: 277
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Remove members from a group chat
|
||||
---
|
||||
|
||||
A [group chat][understand-group-chats] owner can remove members from a group chat. As a group chat owner, you're free to set your own rules and remove members who misbehave. Regular members can't remove other members.
|
||||
|
||||
If you remove someone by mistake or change your mind about them later, you can always [re-add them to the chat][add-members-to-a-group-chat].
|
||||
|
||||
## Remove members
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-messages: Messages.
|
||||
2. Open the group chat you want to remove members from.
|
||||
3. Tap the member list underneath the chat's name.
|
||||
4. Tap :mobile-more-options: **More options** next to the member you want to remove.
|
||||
5. Select :mobile-remove-member: **Remove from the group**.
|
||||
6. Select **Remove** to confirm your decision.
|
||||
|
||||
If you want to remove multiple members in a batch, go to **Messages** > your group chat > **Manage members** and uncheck the boxes next to the members you want to remove. Tap **Confirm changes** to confirm your decision.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click :desktop-chat: **Chat**.
|
||||
2. Open the group chat you want to remove members from.
|
||||
3. From the navigation bar at the top, click :desktop-more-options: **More options**.
|
||||
4. Click :desktop-group-chat: **Add / remove from group**.
|
||||
5. Click the :desktop-cross: **Cross** next to the Status handle of the contact you want to remove. Once you're done, click **Confirm**.
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
---
|
||||
id: 245
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Send an audio message
|
||||
---
|
||||
|
||||
You can send an audio message in Status to communicate with your contacts. You can use audio messages to share ideas and updates. Anyone in a channel, group chat or direct message (DM) can play and send audio messages.
|
||||
|
||||
You can record an audio message up to one minute long and send as many audio messages as you want.
|
||||
|
||||
:::info
|
||||
Deleting an audio message in Status works as deleting any other message. Check out [Edit and delete your messages][delete-your-messages] for more information.
|
||||
:::
|
||||
|
||||
## Record and send an audio message
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-communities: **Communities** to send an audio message in a channel, or tap :mobile-messages: **Messages** to send an audio message in a group chat or DM.
|
||||
1. Long press :mobile-audio: **Audio** to start recording automatically.
|
||||
1. Optionally, whenever you want to send a long message, slide to :mobile-locked-lock: **Lock** for hands-free recording.
|
||||
1. When you’re finished, slide to :mobile-placeholder: **send** to stop recording and send the message or to :mobile-delete: **Delete** to discard the message.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click :desktop-communities: **Community** or :desktop-chat: **Chat** where you wish to send an audio message.
|
||||
1. In the channel, group chat or DM message field, click :mobile-placeholder: **Audio** to start recording.
|
||||
1. When you’re finished, click :mobile-placeholder: **Send**.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 180
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Send and read messages
|
||||
---
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
id: 124
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Send direct messages to your contacts
|
||||
---
|
||||
|
||||
A direct message (or DM, for short) is a communication between you and another person. In Status, you can send direct messages to people in your contact list. If the person is not your contact yet, [send a contact request][add-a-contact-in-status] first.
|
||||
|
||||
## Send direct messages
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-messages: **Messages**.
|
||||
1. Select **Contacts**.
|
||||
1. Tap the person you want to chat with and start sending messages.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click :desktop-chat: **Chat**.
|
||||
1. Click :desktop-start-chat: **Start chat**.
|
||||
1. From your contact list, select the person you want to chat with.
|
||||
1. Click **Confirm** and start sending messages.
|
||||
|
||||
:::tip
|
||||
In direct messages, you can send text messages, [images][share-images-in-status], [GIFs, stickers][send-gifs-and-stickers] and [audio messages][send-an-audio-message]. You can [format][format-your-messages], [edit][edit-messages] and [delete][delete-messages] your messages.
|
||||
:::
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
---
|
||||
id: 239
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Send GIFs and stickers
|
||||
---
|
||||
|
||||
Animated GIFs and stickers are a popular way of expressing emotions, reactions and humour in messaging apps. GIFs are short, looping animated videos of a few seconds in length, while stickers are static or animated images.
|
||||
|
||||
The Status app uses the [Tenor GIF :octicons-tab-external-16:][tenor] search engine and database for GIFs. You can also share GIFs from other sources by sending a message with the GIF URL.
|
||||
|
||||
You can add more stickers to default sticker sets in Status, or share a sticker set with someone. See [Add, remove or share sticker sets][add-remove-or-share-sticker-sets].
|
||||
|
||||
:::info
|
||||
To show the GIF preview and not its URL, [enable rich link previews][enable-rich-link-previews-in-messages] in messages.
|
||||
:::
|
||||
|
||||
## Send GIFs
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. Open the channel or chat where you want to share the GIF.
|
||||
1. In the message area, tap :mobile-placeholder: **React**.
|
||||
1. Tap :mobile-GIFs: **GIF**. The first time you send a GIF, you need to **Enable** the service.
|
||||
1. Search or choose the GIF you want to share. The GIF is sent immediately.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. Open the channel or chat where you want to share the GIF.
|
||||
1. In the message area, click :desktop-GIFs: **GIF**. The first time you send a GIF, you need to **Enable** the service.
|
||||
1. Search or choose the GIF you want to share. The GIF is sent immediately.
|
||||
1. Optionally, hover over the GIF in the preview window and click the :desktop-favourite: **Star** icon to save it as a favourite.
|
||||
|
||||
:::tip
|
||||
If you want to add a message to your GIF, write the text before selecting the GIF.
|
||||
:::
|
||||
|
||||
## Send stickers
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. Open the channel or chat where you want to share the sticker.
|
||||
1. In the message area, tap :mobile-placeholder: **React**.
|
||||
1. Tap :mobile-sticker: **Sticker**.
|
||||
1. From your list of stickers, tap the sticker you want to send. The sticker is sent immediately.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. Open the channel or chat where you want to share the sticker.
|
||||
1. Click :desktop-sticker: **Sticker**. If you don't have stickers, you need to **Get stickers**.
|
||||
1. Choose the sticker you want to share. The sticker is sent immediately.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 627
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Share a conversation
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 626
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Share a group chat
|
||||
---
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
id: 231
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Share images in Status
|
||||
---
|
||||
|
||||
:::info
|
||||
Sharing images is not available on Status Web.
|
||||
:::
|
||||
|
||||
In Status, conversations happen across channels, group chats and DMs (direct messages). To enrich your communication and make it more personal, you can share images. When you share an image on Status, other participants can download, react or answer to it.
|
||||
|
||||
Contrary to other messaging apps using a centralised server, Status protects your privacy using a peer-to-peer network to deliver your messages. Due to this [peer-to-peer network][about-status-messages], you are limited in how many images you can share within a message. However, you can share as many images as you want in different messages.
|
||||
|
||||
:::info
|
||||
At present, sharing files isn't possible on the Status peer-to-peer network.
|
||||
:::
|
||||
|
||||
## Share images
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. Open the channel or chat where you want to share the image.
|
||||
1. Tap the :mobile-image: **Image** next to the message field and choose the image you want to share.
|
||||
1. Optionally, add a message to your image.
|
||||
1. Tap :mobile-send: to send.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. Open the channel or chat where you want to share the image.
|
||||
1. Click :desktop-image: **Image** next to the message field and choose the image you want to share.
|
||||
1. Optionally, add a message to your image.
|
||||
1. Press ++enter++
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 620
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Understand direct messages
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 274
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Understand group chats
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 600
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Uninstall the Status desktop app
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 559
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Use mentions in Status
|
||||
---
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Network nodes and statistics
|
||||
---
|
||||
|
||||
Learn more about your Status Community node and other network nodes.
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
id: 514
|
||||
revision: '0'
|
||||
language: en
|
||||
title: About community request approvals
|
||||
---
|
||||
|
||||
The community owner might require new members to get manual approval. When manual approval for a community is set, the owner reviews each request and makes a decision based on their criteria. If you're a community owner and want to set up manual approval, read [set up your community's approval options][set-up-your-communitys-approval-options].
|
||||
|
||||
:::tip
|
||||
In addition to manual approval, community owners can set up [token requirements][understand-token-requirements-in-communities] to join their communities. Manual approval and token requirements work independently.
|
||||
:::
|
||||
|
||||
Once you send a request to [join a community][join-a-status-community], your request can be accepted or not. To check the status of your request, go to the community screen.
|
||||
|
||||
If the community owner approves your request to join, you get access to the community immediately.
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
id: 301
|
||||
revision: '0'
|
||||
language: en
|
||||
title: About losing access to a community
|
||||
---
|
||||
|
||||
You can lose your Status Community membership for different reasons. For example, a [token-gated community][about-status-communities] can change the token requirements to join, or your behaviour breaks the community rules.
|
||||
|
||||
The community owner can permanently ban your account if you break the community rules. Respect the community rules and members, and don't spam people or promote scams or deceptive practices.
|
||||
|
||||
## The basics
|
||||
|
||||
- If you lose access to a community, you must request to [join the community][join-a-status-community] again.
|
||||
- For token-gated communities, you should hold the token requirements at all times.
|
||||
- When you lose access to a community, it does show up under the Joined tab on your [Communities page][how-to-use-communities-your-quick-start-guide].
|
||||
- In the [notifications centre][view-notifications-and-updates], your Membership notifications show when you have lost access to a community. You don't receive a notification when you're banned from a community.
|
||||
|
||||
:::info
|
||||
Community owners control who has access to their communities. Status can't kick you out or ban you from a community. Likewise, Status can't grant you access to a community or override the community owner's actions.
|
||||
:::
|
||||
|
||||
## Reasons you can lose access to a community
|
||||
|
||||
There are four reasons:
|
||||
|
||||
| Reason | Description | Scope |
|
||||
| :------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------- |
|
||||
| Kick | The community owner has kicked you out of the community. | Open and token-gated communities |
|
||||
| Ban | The community owner has permanently banned you from the community. You can't request to join the community again. | Open and token-gated communities |
|
||||
| Token requirements change | The token requirements to access the community have changed and your tokens do not longer satisfy these requirements. Open the community page to review the new token requirements. | Token-gated communities |
|
||||
| Your tokens change | Your tokens or token amounts have changed and you don't longer satisfy the community requirements. Open the community page to verify your eligibility. | Token-gated communities |
|
||||
|
||||
:::warn
|
||||
Community owners can lose access to their community if they have to restore the profile on a different device and don't [back up the community key][backup-your-community-key].
|
||||
:::
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 302
|
||||
revision: '0'
|
||||
language: en
|
||||
title: About Status Communities
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 540
|
||||
revision: '0'
|
||||
language: en
|
||||
title: About Status Web Communities
|
||||
---
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
---
|
||||
id: 356
|
||||
revision: '0'
|
||||
language: en
|
||||
title: About the Community History Service
|
||||
---
|
||||
|
||||
:::info
|
||||
Currently, you can only configure and benefit from the community history service using Status desktop. [:octicons-desktop-download-16: Download Status desktop][status-web-download].
|
||||
:::
|
||||
|
||||
Status uses a [peer-to-peer network][peer-to-peer-messaging] to temporarily store your community messages for 30 days. When your community members get online, messages are automatically downloaded and stored locally on their computers.
|
||||
|
||||
The peer-to-peer network deletes messages older than 30 days, so members who don't receive them in time can't access them. With the Community History Service (CHS), every community member can access all historical messages.
|
||||
|
||||
## The basics
|
||||
|
||||
- The Status mobile app doesn't support the CHS.
|
||||
- The CHS is on by default, but community owners can [turn it off][turn-off-the-community-history-service]. Other community members can't turn it off or choose not to download historical messages.
|
||||
- When new members join, they can immediately see messages from the past 30 days. However, it may take a few days for messages older than 30 days to appear.
|
||||
- Messages are only readable after importing in Status. The messages in the archives are encrypted, and it's impossible to directly open the archives to read them.
|
||||
|
||||
:::info
|
||||
Downloading and importing messages can take a long time. If messages of a period don't appear, wait a few days.
|
||||
:::
|
||||
|
||||
## How the Community History Service works
|
||||
|
||||
The CHS uses BitTorrent, a communication protocol for decentralized data sharing, with a built-in BitTorrent client in the Status desktop. BitTorrent connects computers with IP addresses and transfers archives to every member's computer.
|
||||
|
||||
Every seven days, the CHS prompts your control node to create an archive for messages in the past seven days. Then BitTorrent clients in your and your community members' Status apps share the archive.
|
||||
|
||||
The CHS runs automatically in the background, you can't see its processes or notifications. You or your community members must be online with the Status desktop app running for the CHS to share, download or import archives.
|
||||
|
||||
:::info
|
||||
Status can't access or manipulate your messages through the CHS. The archives are stored locally on your and your community members' computers.
|
||||
:::
|
||||
|
||||
:::tip
|
||||
To avoid exposing your IP address to other community members, use a VPN when running Status.
|
||||
:::
|
||||
|
||||
## An example of the workflow
|
||||
|
||||
The following example demonstrates how a message archive is generated and how your community members Alice and Bob access it.
|
||||
|
||||
### Step 1: Your Status generates an archive
|
||||
|
||||
- [x] Your Status desktop running the control node is online.
|
||||
- [x] The control node generates an archive.
|
||||
- [x] The BitTorrent client in your Status app makes the archive sharable over a magnet link.
|
||||
|
||||
### Step 2: Community members read messages older than 30 days
|
||||
|
||||
- [x] Alice comes online, and the BitTorrent client in her Status app receives the magnet link.
|
||||
- [x] Using the magnet link and your IP address, the BitTorrent client in Alice's Status app downloads the archive from your computer.
|
||||
- [x] Alice's Status app processes the archive, and Alice can read the messages in the community interface.
|
||||
- [x] Bob's online, and his Status app downloads the archive from your or Alice's computer.
|
||||
|
||||
## Maintain the availability
|
||||
|
||||
The CHS archives messages only from the computer that runs the control node. If you miss any messages, your members can't receive a copy via the CHS. To provide a complete history, keep your control node online every day or at least once every six days.
|
||||
|
||||
Don't remove or edit torrent files, as they're part of the CHS mechanism.
|
||||
|
||||
If you [move your control node][restore-your-status-community] from one computer to another, copy the Status folder to the new computer to keep the existing archives accessible.
|
||||
|
||||
:::tip
|
||||
[Turning off the CHS][turn-off-the-community-history-service] significantly reduces community members' experience. Keep it on unless it's really necessary.
|
||||
:::
|
||||
|
||||
\*[magnet link]: A magnet link is a hyperlink containing information needed for downloading data in a peer-to-peer network, like the filename and download sources.
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
id: 506
|
||||
revision: '0'
|
||||
language: en
|
||||
title: About the control node in Status Communities
|
||||
---
|
||||
|
||||
:::info
|
||||
Currently, you can only administer communities and run a control node using the Status desktop app. [:octicons-desktop-download-16: Download Status desktop][status-web-download].
|
||||
:::
|
||||
|
||||
Status Communities require a type of node called the control node for administration purposes. When you [create a community][create-a-status-community], your computer becomes a control node.
|
||||
|
||||
As the community owner, the control node runs automatically in your Status desktop app if you use the same profile and computer where you set up the community.
|
||||
|
||||
## The basics
|
||||
|
||||
- The computer where you [create your Status Community][create-a-status-community] and every computer where you run Status desktop and [restore your community's private key][restore-your-status-community] becomes a control node.
|
||||
- To provide the best experience for your members, keep the Status desktop app acting as the control node online every day or at least once every six days.
|
||||
- Don't use more than one installation of Status Desktop as your community's control node. Running your community with multiple control nodes will cause unforeseen issues and increase your community's bandwidth requirements.
|
||||
- You can [install a new control node][replace-your-community-s-control-node] when you need to reinstall Status desktop or it becomes unavailable.
|
||||
- Owners can [set up additional computers](#administer-your-community-from-a-different-computer) to administer their community or [delegate admin permissions to someone else][delegate-admin-functions-to-community-members]. Owners still need the Status desktop app acting as the control node running and connected to the internet.
|
||||
|
||||
## Maintain your community available
|
||||
|
||||
The community control node maintains the settings, configuration and functionality of your community. Keep the Status desktop app where you set up your community running and connected to the internet as much as possible, or at least once every six days.
|
||||
|
||||
If the control node goes offline, your [community's functionality is affected][common-issues-when-the-community-s-control-node-is-offline]. You can [set up a new control node][replace-your-community-s-control-node] if the initial Status desktop fails or becomes inaccessible.
|
||||
|
||||
:::warn
|
||||
Don't use more than one installation of Status desktop as your community's control node. Running your community with multiple control nodes will cause unforeseen issues and increase your community's bandwidth requirements.
|
||||
:::
|
||||
|
||||
## Administer your community from a different computer
|
||||
|
||||
If you want to administer your community from another computer, [set up your same Status profile on that computer][create-or-restore-profile-with-recovery-phrase] without importing the community's private key. This process doesn't create a new control node, and you can complete it on as many computers as you want.
|
||||
|
||||
Using a different computer is helpful if you run your Status Community on your desktop computer but want to travel with your laptop, for example. Additionally, you can [delegate admin permissions to others][delegate-admin-functions-to-community-members] using tokens.
|
||||
|
||||
:::tip
|
||||
Community control nodes are the only ones with access to the community's private key. If you run Status desktop on multiple computers and are unsure which one is the control node, verify if you can [back up your community's private key][back-up-your-community-s-private-key]. If you can, you're running a control node.
|
||||
:::
|
||||
|
||||
No matter how many additional computers you use to administer your community, they all forward admin tasks to the Status desktop app working as the control node, which functions as the administration hub.
|
||||
|
||||
:::info
|
||||
Your community is still available when the Status desktop app acting as the control node is offline, but your community members' experience degrades. For more information, check out [Common issues when the control node is offline][common-issues-when-the-community-s-control-node-is-offline].
|
||||
:::
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 0
|
||||
revision: '0'
|
||||
language: en
|
||||
title: About tokens, collectibles, and ENS names
|
||||
---
|
||||
|
|
@ -0,0 +1,54 @@
|
|||
---
|
||||
id: 662
|
||||
revision: '0'
|
||||
language: en
|
||||
title: About view-only channels
|
||||
---
|
||||
|
||||
:::info
|
||||
Currently, you can only set up and manage view-only channels using Status desktop. [:octicons-desktop-download-16: Download Status desktop][status-web-download].
|
||||
:::
|
||||
|
||||
[Channels][channels-your-quick-start-guide] are spaces for conversation, discussion and information sharing. By default, all community members with access to a channel can read and send messages.
|
||||
|
||||
As a community [owner or admin][permissions-by-role-in-status-communities], you can set a channel as view-only. To learn how to do that, check out [Set up a view-only channel][set-up-a-view-only-channel].
|
||||
|
||||
A read-only channel helps maintain clear, uninterrupted communication for specific purposes. While members can't respond directly in these channels, they are crucial in keeping your community informed and engaged.
|
||||
|
||||
## View-only channel permission
|
||||
|
||||
When you [set up a channel permission][set-up-channel-permissions], only members who meet the criteria for that permission can perform the associated action within that channel.
|
||||
|
||||
This is how the `View` and `View and post` channel permissions work in your community.
|
||||
|
||||
| Channel permission \\ Member | Members not meeting the criteria | Members meeting the criteria | Owner and admins |
|
||||
| :--------------------------- | :------------------------------- | :--------------------------- | :------------------- |
|
||||
| None | :material-check-all: | :material-check-all: | :material-check-all: |
|
||||
| `View` | :octicons-x-24: | :material-check: | :material-check-all: |
|
||||
| `View and post` | :octicons-x-24: | :material-check-all: | :material-check-all: |
|
||||
|
||||
(:material-check-all: view and post, :material-check: view only, :octicons-x-24: no access)
|
||||
|
||||
:::tip
|
||||
Members with view-only access to the channel can still [react][react-and-reply-to-messages] to messages in the channel with emojis.
|
||||
:::
|
||||
|
||||
## Using a view-only channel
|
||||
|
||||
View-only channels can help keep your community organized and focused. Here are some ideas on how you can use view-only channels.
|
||||
|
||||
- **Community announcements and updates**
|
||||
|
||||
To keep important announcements or updates clutter-free, use a view-only channel. Only community owners and admins can write in these channels, ensuring your message is delivered without distractions.
|
||||
|
||||
- **Information sharing**
|
||||
|
||||
If there are specific resources or guidelines that members need to access regularly, a view-only channel is as a convenient and easy-to-find repository. For example, you can share information that new community members may find helpful.
|
||||
|
||||
- **Learning communities**
|
||||
|
||||
In learning communities, view-only channels allow owners to share exercises and training materials while keeping the conversation focused.
|
||||
|
||||
- **Voting or pooling areas**
|
||||
|
||||
Because members with view-only access can still [react][react-and-reply-to-messages] to messages in view-only channels, owners can use them for voting on different topics or proposals.
|
||||
|
|
@ -0,0 +1,54 @@
|
|||
---
|
||||
id: 311
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Back up your community's private key
|
||||
---
|
||||
|
||||
:::info
|
||||
Currently, you can only back up your community key using [Status desktop][download-status].
|
||||
:::
|
||||
|
||||
When you create a [Status Community][about-status-communities], the Status app generates a public and a private cryptographic key (a key pair). In essence, these keys are very large numbers securely stored on your device and protected by your Status password.
|
||||
|
||||
The community's private key provides control over your community's settings, membership approvals and other important aspects of its operation. Use your community's private key backup to [restore the community][restore-your-status-community] onto another device or to [transfer your community's ownership][transfer-your-community-s-ownership] to someone else.
|
||||
|
||||
:::warn
|
||||
Manually transferring your community from one computer to another by copying the private key is an insecure method of handling a private key. Still, it's currently the only way to do so.
|
||||
We're aware of this issue and plan to implement a secure solution in a future release. In the meantime, be extra cautious when handling your community key and keep it safe.
|
||||
:::
|
||||
|
||||
## What to expect
|
||||
|
||||
- As a community owner, you're responsible for backing up your community's private key and keeping it safe. Status doesn't have access to this key and can't recover it for you.
|
||||
- Anyone with access to your community's private key may become the owner of the community and control its settings, permissions and membership approvals.
|
||||
- Even with your community's private key, your community may disappear irretrievably if [you delete it][delete-your-status-community] or the owner's node is offline for more than 30 days without activity.
|
||||
|
||||
## Back up your community key
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click your community.
|
||||
1. At the top of the channel sidebar, click your community logo and then, click :desktop-overview: **Overview**.
|
||||
1. In the **Back up community key** area, click :desktop-back-up: **Back up**.
|
||||
1. In the pop-up window showing your community's private key, click **Copy**.
|
||||
1. Close the window showing the key. You can access this information at any time.
|
||||
1. Paste the community's private key on a document or write it down on paper.
|
||||
|
||||
:::info
|
||||
Keep your community's private key safe. Status will never ask you for this information, and anyone who does is trying to steal your community.
|
||||
:::
|
||||
|
||||
## Common questions
|
||||
|
||||
### Where is my community information backed up?
|
||||
|
||||
Your community configuration and messages for up to 30 days are cached in the Waku [peer-to-peer network][peer-to-peer-messaging]. The community's private key represents proof of ownership but doesn't store the community configuration and messages.
|
||||
|
||||
### How frequently should I back up the community's private key?
|
||||
|
||||
You only need to back up your community's private key once, as long as you don't lose it. You can create the backup right after you [create the community][create-a-status-community].
|
||||
|
||||
### How can I protect my community's private key?
|
||||
|
||||
To minimize the risk of unauthorized access to your community's private key, avoid keeping online copies or screenshots of it and maintain at least one pen-and-paper backup.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 593
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Burn your community tokens
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 638
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Change a private channel to public
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 637
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Change a private community to public
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 315
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Change the channel access type
|
||||
---
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
---
|
||||
id: 287
|
||||
revision: '0'
|
||||
language: en
|
||||
title: 'Channels: your quick start guide'
|
||||
---
|
||||
|
||||
In [Status Communities][how-to-use-communities-your-quick-start-guide], you have access to dedicated spaces called channels. Channels bring the right people and information together for any project or topic. A channel conversation focuses on specific topics, and you can [join](./join-a-channel.md) and [leave](./leave-a-channel.md) the conversation anytime.
|
||||
|
||||
As a community owner, you can use channels to break down a large community into smaller, more focused sub-groups. With Status, you can [configure channel permissions][configure-channel-permissions] based on token ownership. For example, you can make a public channel private or view-only by only allowing holders of specific tokens to join or post.
|
||||
|
||||
:::tip
|
||||
To add channels to your community, check out [Create a channel][create-a-channel].
|
||||
:::
|
||||
|
||||
`{/* [image](image) */}`
|
||||
|
||||
=== ":mobile-one: Community information"
|
||||
Information about the community, such as the number of members, active users or the main community topics.
|
||||
|
||||
=== ":mobile-two: Channel categories"
|
||||
Community owners can group related channels into [categories][create-a-channel]. This is especially useful for communities with a lot of channels.
|
||||
|
||||
=== ":mobile-three: Channels list"
|
||||
The list of available channels in a community. [Private channels][configure-channel-permissions] have a :mobile-locked-lock: lock icon next to the channel name.
|
||||
|
||||
## Public and private channels
|
||||
|
||||
All members in a [Status Community][how-to-use-communities-your-quick-start-guide] can browse and join public channels. For private channels, you must [meet the token requirements][understand-token-requirements-in-channels] to join the channel. To maintain access to private channels, hold the required tokens at all times.
|
||||
|
||||
:::info
|
||||
Messages in [private communities][how-to-use-communities-your-quick-start-guide] and private channels are always end-to-end encrypted.
|
||||
:::
|
||||
|
||||
`{/* [image](image) */}`
|
||||
|
||||
=== ":mobile-one: Public channel"
|
||||
All community members can join public channels. When you join a community, you automatically get access to these channels.
|
||||
|
||||
=== ":mobile-two: Private channel"
|
||||
Private channels have a :mobile-locked-lock: lock icon next to the channel name. To access these channels, you need to [meet the token requirements][understand-token-requirements-in-channels]. To maintain access, keep holding the required tokens.
|
||||
|
||||
## Channel information
|
||||
|
||||
`{/* [image](image) */}`
|
||||
|
||||
=== ":mobile-one: Channel information"
|
||||
You can see the channel name and permissions here. Private channels have a :mobile-locked-lock: lock icon. From this area, you can select :mobile-more-options: **More options** to view more details about the channel, such as channel members, permissions or notifications.
|
||||
|
||||
=== ":mobile-two: Pinned message area"
|
||||
Channel members can [pin messages][pin-a-message] to this area, such as announcements, FAQ or channel rules.
|
||||
|
||||
=== ":mobile-three: Channel feed"
|
||||
This area shows the channel activity, including messages, photos, reactions or links.
|
||||
|
||||
=== ":mobile-four: Message field"
|
||||
From here, you can send messages to channel members with [text][send-and-read-messages], [images][share-images-in-status] or emojis, as well as [audio messages][send-an-audio-message].
|
||||
|
||||
## The #general channel
|
||||
|
||||
The #general channel is created by default when you [create a community][create-a-status-community]. You can use this channel for various purposes, including sharing news, discussing community policies and events or making announcements.
|
||||
|
||||
This channel works like any other channel. As a community administrator, here's how you can make this channel more helpful:
|
||||
|
||||
- Don't rename the channel. The #general channel is widely recognized and understood in communities. Renaming the channel may confuse members.
|
||||
- [Set up permissions][configure-channel-permissions] to restrict who can post in #general. This removes noise from the channel and keeps it on topic.
|
||||
- Use the #general channel to [pin messages][pin-a-message] describing FAQs, community rules or other information relevant to your community.
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
id: 604
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Common issues when the community control node is offline
|
||||
---
|
||||
|
||||
When you [create a community][create-a-status-community], your computer becomes a [control node][about-the-control-node-in-status-communities]. As the community owner, the control node runs automatically in your Status desktop app if you use the same profile and computer where you set up the community.
|
||||
|
||||
:::info
|
||||
You can [set up a new control node][replace-your-community-s-control-node] if the initial Status desktop fails or becomes inaccessible.
|
||||
:::
|
||||
|
||||
If you don't have the Status desktop app running and connected to the internet, your community keeps working, but your members' experience degrades. Here are some of the problems you and your members may find:
|
||||
|
||||
- Members can't access messages over one month because the [Community History Service][about-the-community-history-service] is not running.
|
||||
- [Community join requests][manage-community-join-requests] can't be processed and are rejected or ignored.
|
||||
- [Banning or kicking out members][kick-or-ban-someone-from-your-community] is delayed until the control node is online.
|
||||
- Your community can't verify if members in [token-gated channels][set-up-channel-permissions] still hold the required tokens.
|
||||
- Members who could not access a private channel for not [meeting the requirements][understand-token-requirements-in-channels] can't join the channel even if they meet them now.
|
||||
|
||||
:::tip
|
||||
Keep the Status desktop app working as the [community control node][about-the-control-node-in-status-communities] online every day or at least once every six days.
|
||||
:::
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
id: 355
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Configure your community permissions
|
||||
---
|
||||
|
||||
:octicons-tools-24:
|
||||
|
||||
:::info
|
||||
We're working on this content.
|
||||
:::
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
id: 313
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Create a channel
|
||||
---
|
||||
|
||||
:::info
|
||||
Currently, you can only create a channel using Status desktop.
|
||||
:::
|
||||
|
||||
Community owners can create public and private channels in the Status app. All community members can browse and join public channels. To join private channels, members must meet the [channel requirements][understand-token-requirements-in-channels]. As a community owner, you can set up specific permissions to create a private channel.
|
||||
|
||||
## Create a channel
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click the community where you want to create a channel.
|
||||
1. In the **Community** sidebar, right-click the empty space and select **Create Channel**.
|
||||
1. Type your **Channel name**. Optionally, click :desktop-emojis: **Emoji** to choose an emoji.
|
||||
1. Optionally, choose a **Channel colour** and add a **Description** of your channel.
|
||||
1. Click **Create Channel**.
|
||||
|
||||
If you need to set up additional permissions, click **Add permissions** and check out [configure channel permissions][configure-channel-permissions]. For example, you can create a view-only announcement channel or a channel all members can view and post in.
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
---
|
||||
id: 29
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Create a Status Community
|
||||
---
|
||||
|
||||
:::info
|
||||
Currently, you can only create and administer communities using the Status desktop app.
|
||||
[Download Status desktop :octicons-desktop-download-16:][status-web-download]
|
||||
:::
|
||||
|
||||
A [Status Community][about-status-communities] is a place where you can connect and communicate with people who share your interests. Communities are ideal for those with a passion or hobby, study groups, gaming communities, professional network groups, or creators looking to generate income from their content without intermediaries.
|
||||
|
||||
As a community owner, you can create open communities or [restrict community access using tokens][set-up-a-private-community], control [membership approval][set-up-your-community-s-approval-options] and organize discussion groups in [channels][create-a-channel]. Owners have complete control over their community and are responsible for maintaining its rules.
|
||||
|
||||
## Create a community
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click :desktop-communities: **Communities**.
|
||||
1. On top of the content area, click **Create community**.
|
||||
1. Add a **name** and a **short description** of your community.
|
||||
1. Optionally, add a **logo**, **banner**, **colour** palette and **tags**. You can [customize these settings](#customize-your-community) at any time.
|
||||
1. Configure [additional community settings](#configure-additional-settings).
|
||||
1. Click **Next** to complete the [information about your community](#describe-your-community-and-its-rules).
|
||||
1. Click **Create community**.
|
||||
|
||||
## Configure additional settings
|
||||
|
||||
You can configure these community settings:
|
||||
|
||||
| Setting | Description |
|
||||
| :------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **Community history service** | Status Communities store up to 30 days of chat history by default. When this option is checked, community members can see messages older than 30 days. |
|
||||
| **Request to join required** | Community owners must manually approve each join request if this setting is checked. This option applies to [open and private][about-status-communities] communities. |
|
||||
| **Any member can pin a message** | Any community member can [pin messages][pin-a-message] when this setting is checked. If the setting is unchecked, only the community owner can pin messages. |
|
||||
|
||||
:::info
|
||||
The Community history service uses the [BitTorrent peer-to-peer network :octicons-tab-external-16:][bittorrent-peer-to-peer-network] to store and retrieve community messages older than 30 days. Status uses a decentralized network and does not store this information.
|
||||
:::
|
||||
|
||||
## Describe your community and its rules
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. In the **Community introduction and rules**, introduce your community to new members and describe the community guidelines.
|
||||
1. In the **Leaving community message**, write the message sent to members leaving your community.
|
||||
1. Click **Create community** if you haven't already.
|
||||
|
||||
## Customize your community
|
||||
|
||||
After you create a community, you can customize its settings at any time.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click your community.
|
||||
1. On top of the channel sidebar, click your community logo.
|
||||
1. Click :desktop-overview: **Overview**.
|
||||
1. Expand the window and click **Edit Community**.
|
||||
1. Edit your community look-and-feel, [additional settings](#configure-additional-settings) or [community rules](#describe-your-community-and-its-rules).
|
||||
1. Click **Save changes**.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 314
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Create a token-gated channel
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 405
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Customize your channel
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 294
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Customize your community
|
||||
---
|
||||
|
|
@ -0,0 +1,63 @@
|
|||
---
|
||||
id: 543
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Delegate admin functions to community members
|
||||
---
|
||||
|
||||
:::info
|
||||
Currently, you can only delegate admin functions using Status desktop. [:octicons-desktop-download-16: Download Status desktop][status-web-download].
|
||||
:::
|
||||
|
||||
Community owners have total control over their communities, including settings, membership approvals and permissions. In addition, owners can delegate administrative functions to other community members through the [admin role][permissions-by-role-in-status-communities]. Admins play a similar role to owners, but with some important differences. Check out [Permissions by role in Status Communities][permissions-by-role-in-status-communities] for more information.
|
||||
|
||||
To delegate admin functions to others, owners use [token-based community permissions][set-up-your-community-permissions]. Tokens are digital assets in a blockchain (such as the [Ethereum blockchain][about-the-ethereum-blockchain]), including assets (virtual coins), collectibles and ENS names.
|
||||
|
||||
## What to expect
|
||||
|
||||
- To delegate admin functions, assign the `Become admin` community permission to a collectible or ENS name owner.
|
||||
- Using ENS names to delegate admin functions is more straightforward than using collectibles, but it requires the admin to own the ENS name.
|
||||
- You can create a maximum of five different `Become admin` community-level permissions, but you can apply a single permission to multiple members.
|
||||
- To stop delegating admin functions, [self-destruct the admin token][self-destruct-a-token-remotely] or [delete the admin permission][delete-community-permissions].
|
||||
|
||||
## Choose your delegation token
|
||||
|
||||
You can delegate [admin functions][permissions-by-role-in-status-communities] to others using a collectible or an ENS name.
|
||||
|
||||
If you use a collectible, follow this process:
|
||||
|
||||
- [x] [Mint][mint-tokens-for-your-community] a non-transferable (soulbound) and remotely-destructible collectible.
|
||||
- [x] [Airdrop the collectible][how-to-airdrop-tokens-in-status] to the person you wish to delegate admin functions to.
|
||||
- [x] [Delegate the admin function](#delegate-admin-functions-using-collectibles-or-ens-names) using token-based community permissions.
|
||||
|
||||
Using ENS names, you don't need to mint and airdrop any token. You [delegate admin functions](#delegate-admin-functions-using-collectibles-or-ens-names) to a specific ENS name owner (such as alice.acme.eth) or a group of people under the same ENS domain (such as acme.eth).
|
||||
|
||||
:::info
|
||||
Assets don't have the non-transferable (soulbound) and self-destructing properties collectibles have, making it harder to remove admin functions from other users. Avoid using assets to delegate admin functions.
|
||||
:::
|
||||
|
||||
## Delegate admin functions using collectibles or ENS names
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click your community.
|
||||
1. On top of the channel sidebar, click your community logo and then, click **Permissions**.
|
||||
1. Click **Add permission**.
|
||||
1. For the `Who holds` variable, choose your delegation option and use the table below for reference.
|
||||
1. For the `Is allowed to` variable, select :desktop-admin: **Become admin**.
|
||||
1. For the `In` variable, make sure your community is selected.
|
||||
1. Click **Create permission**. The new permission takes effect immediately.
|
||||
|
||||
| Delegation option | Steps |
|
||||
|:---|:---|
|
||||
| Collectible | 1. Select **Collectibles**. |
|
||||
|| 2. Choose the collectible and amount you want to use to delegate admin functions. |
|
||||
|| 3. Alternatively, **Import existing collectible**. |
|
||||
|| 4. Click **Add**. |
|
||||
| ENS name | 1. Select **ENS**.
|
||||
|| 2. Enter the ENS name or domain you want to delegate admin functions to. |
|
||||
|| 3. Click **Add**. |
|
||||
|
||||
:::info
|
||||
When you select the `Become admin` role, the **Hide permission** option is enabled automatically.
|
||||
:::
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
id: 403
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Delete a channel
|
||||
---
|
||||
|
||||
:::info
|
||||
Currently, you can only delete a channel using Status desktop.
|
||||
:::
|
||||
|
||||
Community owners can delete [channels][channels-your-quick-start-guide] within their communities. As a community owner, when you delete a channel, all messages and files associated with that channel are also deleted.
|
||||
|
||||
:::info
|
||||
Once you delete a channel, it can't be retrieved or restored.
|
||||
:::
|
||||
|
||||
## What to expect
|
||||
|
||||
- You can only delete a channel if you are the community owner.
|
||||
|
||||
- When you delete a channel, it disappears immediately, and all users lose access to its content (messages and files).
|
||||
|
||||
- If you delete a private channel, the [permissions][configure-channel-permissions] you configured for the channel are also lost. If you want to recreate the channel, you need to configure its permissions again.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click the community with the channel you want to delete.
|
||||
1. In the **Community** sidebar, right-click the channel.
|
||||
1. Select :desktop-delete: **Delete Channel**.
|
||||
1. In the **Delete** pop-up window, click **Delete**.
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
id: 538
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Delete your Status Community
|
||||
---
|
||||
|
||||
:::info
|
||||
Currently, you can only delete your community using Status desktop.
|
||||
:::
|
||||
|
||||
Status uses a [peer-to-peer network][peer-to-peer-messaging] that temporarily stores data of your community. Because of this decentralized architecture, there is no one-click way to delete a community and all associated data.
|
||||
|
||||
## What to expect
|
||||
|
||||
- For a community to disappear, you must remove everyone from the community, including yourself, and make sure no activity happens for 30 days.
|
||||
- Community data recorded on the blockchain continues to exist. For example, if you [minted tokens for your community][mint-tokens-for-your-community], the transaction is on-chain and persists in the blockchain.
|
||||
|
||||
:::info
|
||||
Your messages are not in the blockchain and are not transported through the Ethereum network. [Messages][about-status-messages] are temporarily stored in the peer-to-peer network.
|
||||
:::
|
||||
|
||||
## Delete your Status Community
|
||||
|
||||
You must complete the following tasks:
|
||||
|
||||
- [x] Set up [manual approval][manage-community-join-requests] for the community.
|
||||
- [x] [Kick out all members from the community][kick-or-ban-someone-from-your-community].
|
||||
- [x] [Leave your community][leave-a-status-community].
|
||||
- [x] Delete or destroy the community's private key if it's stored anywhere.
|
||||
- [x] Wait 30 days.
|
||||
|
||||
After 30 days, the Waku peer-to-peer network stops caching your community data, and the community is deleted irrecoverably.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 592
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Grant exclusive access with custom tokens
|
||||
---
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
---
|
||||
id: 592
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Grant exclusive access with tokens
|
||||
---
|
||||
|
||||
As a community owner in Status, you can use tokens to create different access levels within your community. These levels apply to both the community overall and individual channels within it. This approach helps to keep your community engaging and organized.
|
||||
|
||||
For example, you can use tokens to organize a conference with community access limited to token holders and exclusive channels just for speakers. If you are an artist or content creator, you can set up a community for your fans and give certain fans access to exclusive channels where you release new content.
|
||||
|
||||
The options are many, allowing you to create an environment tailored to your community's needs. For more examples of using tokens to provide exclusive access to your community, check out [Token-based access to communities and channels][token-based-access-to-communities-and-channels].
|
||||
|
||||
## Practical example: use a Status Community to organize an event
|
||||
|
||||
If you use a Status Community to organize a conference or event, you might want a community open to all interested individuals. Yet, you also need a space just for the speakers.
|
||||
|
||||
With tokens, you can limit access to your community only to the individuals invested in the conference topic. Additionally, you can create an exclusive channel within the community, only accessible to the event speakers. This provides a platform for them to discuss and collaborate on the conference preparation.
|
||||
|
||||
### Step 1: mint the community tokens
|
||||
|
||||
You start minting the community tokens you need to organize the event. In this particular example, you consider two different tokens:
|
||||
|
||||
- A general-access token for attendees.
|
||||
- A VIP-access token only for speakers.
|
||||
|
||||
:::info
|
||||
Currently, you can only mint collectibles.
|
||||
:::
|
||||
|
||||
- [x] [Mint a new collectible][mint-tokens-for-your-community] to grant general access to the event attendees.
|
||||
- [x] Customize the general-access [collectible options][set-up-collectible-options]. For example, you may want to turn on `Unlimited supply` and turn off the `Not transferable (Soulbound)` option.
|
||||
- [x] [Mint a collectible][mint-tokens-for-your-community] to grant exclusive access to the event speakers.
|
||||
- [x] Configure the VIP-access [collectible options][set-up-collectible-options]. In this case, you may want to turn off `Ulimited supply` and turn on the `Not transferable (Soulbound)` and `Remote self-destruct` options.
|
||||
|
||||
:::info
|
||||
You can't change the collectible description or options after minting.
|
||||
:::
|
||||
|
||||
### Step 2: create the token-based permissions
|
||||
|
||||
To create the permissions, check out [Set up your community permissions][set-up-your-community-permissions]. In this example, you create two different permissions using the tokens from the [previous step](#step-1-mint-the-community-tokens):
|
||||
|
||||
- Community-level permission to grant general access to the conference attendees.
|
||||
- Channel-level permission to grant exclusive channel access to the event speakers.
|
||||
|
||||
You may want to configure these permissions as follows:
|
||||
|
||||
| Scope | Applies to | Variable | Option |
|
||||
| :-------------- | :--------------------- | :-------------- | :----------------------------------- |
|
||||
| Community-level | Attendees and speakers | `Who holds` | Your general-access token |
|
||||
| | | `Is allowed to` | :desktop-member: Become member |
|
||||
| | | `In` | Your community |
|
||||
| Channel-level | Speakers only | `Who holds` | Your VIP-access token |
|
||||
| | | `Is allowed to` | :desktop-member: Become member |
|
||||
| | | `In` | Your exclusive speakers-only channel |
|
||||
|
||||
:::tip
|
||||
You can also set up exclusive access to communities or channels for holders of a particular ENS domain (for example, alice.acme.eth or bob.acme.eth).
|
||||
:::
|
||||
|
||||
### Step 3: distribute tokens to attendees and speakers
|
||||
|
||||
After you [create the permissions](#step-2-create-the-token-based-permissions), you can distribute the tokens via [airdrops][how-to-airdrop-tokens-in-status] to all the conference's participants:
|
||||
|
||||
- [x] Airdrop the general-access token to the conference attendees and speakers.
|
||||
- [x] Airdrop the VIP-access token to the conference speakers only.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 540
|
||||
revision: '0'
|
||||
language: en
|
||||
title: How to airdrop tokens in Status
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 575
|
||||
revision: '0'
|
||||
language: en
|
||||
title: How to mint an admin token
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 102
|
||||
revision: '0'
|
||||
language: en
|
||||
title: 'How to run a community: your quick start guide'
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 110
|
||||
revision: '0'
|
||||
language: en
|
||||
title: 'How to use Communities: your quick start guide'
|
||||
---
|
||||
|
|
@ -0,0 +1,56 @@
|
|||
---
|
||||
id: 445
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Import a community someone shares with you
|
||||
---
|
||||
|
||||
You can import a Status Community someone [shares with you][invite-people-to-a-status-community] using the link, QR code or public's community key. Importing a community can also be helpful when you need help finding the community.
|
||||
|
||||
:::info
|
||||
If you're a community owner and want to restore your community on a different device, read [Restore your Status Community][restore-your-status-community].
|
||||
:::
|
||||
|
||||
## Import community options
|
||||
|
||||
You have three options to import a Status Community.
|
||||
|
||||
| Option | Description | Works with |
|
||||
| :--------------------- | :-------------------------------------------------------------------------- | :----------------- |
|
||||
| Link | Tap or click the Status Community link to open the community page. | Mobile and desktop |
|
||||
| QR code | Use this option to scan the community QR code someone shares with you. | Mobile |
|
||||
| Community's public key | Import the key using the Status app to find the community you want to join. | Mobile and desktop |
|
||||
|
||||
Use the community link, QR code or public key to find and import the community you're interested in. Status includes the community's public key in the QR code or link, like this: `https://join.status.im/c/zQ3shMtRomXyM5svciMpdK7zDaR12XDeQWbzi4Fb8E6YywDrE`. The link contains the community's public key at the end, so you don't have to type it in.
|
||||
|
||||
## Import a community
|
||||
|
||||
To import the community, ask the person sharing the community to [send you the link or show you the QR code][invite-people-to-a-status-community].
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. If you receive the community link, tap the link to open the community page.
|
||||
1. If you receive the community QR code or public's community key, follow the steps provided in the table below.
|
||||
1. Review the information when the community page opens and tap :mobile-unlocked-lock: **Join community**.
|
||||
|
||||
| Option | Steps |
|
||||
|:---|:---|
|
||||
| QR code | 1. From the tab bar, tap :mobile-communities: **Communities**.
|
||||
||2. From the top navigation, tap :mobile-scan: **Scan** and scan the QR code. |
|
||||
| Public's community key | 1. From the tab bar, tap :mobile-communities: **Communities**. |
|
||||
|| 2. Tap :mobile-add: **Add** > :mobile-download: **Import community**. |
|
||||
|| 3. In the **Community key** text field, enter the community link or public's community key. |
|
||||
|| 4. Verify the community you're about to import and tap :mobile-download: **Import community**. |
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
If you receive the community link, click the link to open the community page. Review the information when the community page opens and tap :mobile-unlocked-lock: **Join community**. If you receive the public's community key, follow these steps:
|
||||
|
||||
1. From the navigation sidebar, click :desktop-communities: **Communities**.
|
||||
1. On top of the content area, click **Import using key**.
|
||||
1. In the **Community key** text field, enter the community link or public's community key.
|
||||
1. Click **Import**. If the **Import** option is unavailable, verify you're entering the correct key.
|
||||
|
||||
:::info
|
||||
After opening the link or scanning the QR code, you can [install Status][download-status] if you haven't already.
|
||||
:::
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 631
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Import a Discord Community into Status
|
||||
---
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 630
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Import tokens to your community
|
||||
---
|
||||
|
|
@ -0,0 +1,78 @@
|
|||
---
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Status Communities
|
||||
---
|
||||
|
||||
Create your community, set up private channels or join others' communities and channels.
|
||||
|
||||
## Status Communities
|
||||
|
||||
- [**Import** a community someone shares with you][import-a-community-someone-shares-with-you]
|
||||
- [**Invite** people to a Status community][invite-people-to-a-status-community]
|
||||
- [About community **request approvals**][about-community-request-approvals]
|
||||
- [Understand **token requirements** in communities][understand-token-requirements-in-communities]
|
||||
- [**Leave** a Status Community][leave-a-status-community]
|
||||
- [About **losing access** to a community][about-losing-access-to-a-community]
|
||||
|
||||
## Channels
|
||||
|
||||
- [**Channels**: your quick start guide][channels-your-quick-start-guide]
|
||||
- [**Join** a channel][join-a-channel]
|
||||
- [**Invite** people to a channel][invite-people-to-a-channel]
|
||||
- [Understand **token requirements** in channels][understand-token-requirements-in-channels]
|
||||
- [About **losing access** to a channel][about-losing-access-to-a-channel]
|
||||
|
||||
## Create your community
|
||||
|
||||
- [How to **run a community**: your quick start guide][how-to-run-a-community-your-quick-start-guide]
|
||||
- [**Create** a Status community][create-a-status-community]
|
||||
- [**Customize** your community][customize-your-community]
|
||||
- [**Import a Discord Community** into status][import-a-discord-community-into-status]
|
||||
- [**Back up** your community's private key][back-up-your-community-s-private-key]
|
||||
|
||||
## Administer your community
|
||||
|
||||
- [Manage community **join requests**][manage-community-join-requests]
|
||||
- [About the **control node** in Status Communities][about-the-control-node-in-status-communities]
|
||||
- [**Replace** your community's control node][replace-your-community-s-control-node]
|
||||
- [**Transfer** your community's ownership][transfer-your-community-s-ownership]
|
||||
- [**Restore** your Status Community][restore-your-status-community]
|
||||
- [About the **Community History Service**][about-the-community-history-service]
|
||||
- [**Turn off** the Community **History** Service][turn-off-the-community-history-service]
|
||||
- [**Kick or ban** someone from your community][kick-or-ban-someone-from-your-community]
|
||||
- [**Delete** your Status **Community**][delete-your-status-community]
|
||||
|
||||
## Administer channels
|
||||
|
||||
- [**Create** a channel][create-a-channel]
|
||||
- [**Customize** your channel][customize-your-channel]
|
||||
- [**Change** a private channel to public][change-a-private-channel-to-public]
|
||||
- [Set up **channel permissions**][set-up-channel-permissions]
|
||||
- [About **view-only channels**][about-view-only-channels]
|
||||
- [Set up a view-only channel][set-up-a-view-only-channel]
|
||||
- [Set up a private channel][set-up-a-private-channel]
|
||||
- [**Delete** a channel][delete-a-channel]
|
||||
|
||||
## Use tokens and set community permissions
|
||||
|
||||
- [**Token-based access** to communities and channels][token-based-access-to-communities-and-channels]
|
||||
- [Set up a **private community**][set-up-a-private-community]
|
||||
- [**Change** a private community to public][change-a-private-community-to-public]
|
||||
- [**Permissions by role** in Status Communities][permissions-by-role-in-status-communities]
|
||||
- [Set up your **community permissions**][set-up-your-community-permissions]
|
||||
- [Grant **exclusive access** with tokens][grant-exclusive-access-with-tokens]
|
||||
- [**Mint tokens** for your community][mint-tokens-for-your-community]
|
||||
- [How to mint an **admin token**][how-to-mint-an-admin-token]
|
||||
- [**Import tokens** to your community][import-tokens-to-your-community]
|
||||
- [How to **airdrop tokens** in status][how-to-airdrop-tokens-in-status]
|
||||
- [**Delegate admin functions** to community members][delegate-admin-functions-to-community-members]
|
||||
- [**Remotely self destruct** a token][remotely-self-destruct-a-token]
|
||||
- [**Burn** your community tokens][burn-your-community-tokens]
|
||||
|
||||
## Status Web Communities
|
||||
|
||||
- [About status **web communities**][about-status-web-communities]
|
||||
- [**Join** a Community on Status Web][join-a-community-on-status-web]
|
||||
- [Understand **throwaway profiles** in Status Web][understand-throwaway-profiles-in-status-web]
|
||||
- [**Use a throwaway profile** in Status Web][use-a-throwaway-profile-in-status-web]
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
id: 581
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Invite people to a channel
|
||||
---
|
||||
|
||||
Whether you're a comunity owner or a member, you can invite anyone to any channel you're a member of.
|
||||
|
||||
:::info
|
||||
To join the channel, the person you're inviting needs to be a member of the community.
|
||||
:::
|
||||
|
||||
## Invite options
|
||||
|
||||
There are three different options you can invite someone to a channel.
|
||||
|
||||
| Option | Description | Works with |
|
||||
| :-------------------------- | :----------------------------------------------------------------------- | :----------------- |
|
||||
| Invite your Status contacts | You can share the channel with anyone who's on your Status contact list. | Mobile and desktop |
|
||||
| Show QR code | Show the channel's QR code to the person you want to invite. | Mobile |
|
||||
| Share a link | Share the link via messenger apps or social media. | Mobile and desktop |
|
||||
|
||||
## Invite people to a channel
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-communities: **Communities**.
|
||||
1. Tap the community with the channel you want to share.
|
||||
1. In the channel list, long press the channel you want to share.
|
||||
1. In the action sheet, choose an option and proceed as follows:
|
||||
|
||||
| Option | Steps |
|
||||
|---------|--------|
|
||||
| Invite your Status contacts | 1. Select :mobile-add-user: **Invite people from contacts list**. <br/> 2. Check the boxes next to the contacts you want to invite. <br/> 3. Tap **Invite users**. |
|
||||
| Show QR code | 1. Select :moblie-qr-code: **Show QR code**. <br/> 2. Show the QR code to the person you want to invite. |
|
||||
| Share a link | 1. Select :mobile-share: **Share channel**. <br/> 2. Share the channel link via social media, messenger apps or any other app you prefer.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click the community with the channel you want to share.
|
||||
1. In the channels sidebar, right click the channel and then select :desktop-share: **Share channel**.
|
||||
1. Choose the contacts or copy the link and proceed as follows:
|
||||
|
||||
| Option | Steps |
|
||||
|---------|--------|
|
||||
| Invite your Status contacts | 1. In the **Invite Contacts** pop-up window, type the names of your contacts in the search bar or check the boxes next to the names. <br/> 2. Click **Next**. <br/> 3. Optionally, type an invitation message. <br/> 4. Click **Send Invites**. |
|
||||
| Share a link | 1. In the **Invite Contacts** pop-up window, click :desktop-copy: **Copy** next to the link. <br/> 2. Switch to the app where you want to share the link and paste it there.
|
||||
|
||||
:::tip
|
||||
After opening the link or scanning the QR code, people can [install Status][run-the-status-app-for-the-first-time] if they haven't already.
|
||||
:::
|
||||
|
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
id: 425
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Invite people to a Status Community
|
||||
---
|
||||
|
||||
Whether you are a community member or not, you can tell people about the community and invite them to join.
|
||||
|
||||
:::info
|
||||
People you invite still need to meet the requirements to join private communities.
|
||||
:::
|
||||
|
||||
## Invite options
|
||||
|
||||
There are three approaches to inviting someone.
|
||||
|
||||
| Approach | Description | Works with |
|
||||
| :----------------------- | :-------------------------------------------------------------------------------------------- | :----------------- |
|
||||
| Share to Status contacts | Use this option to share the community with people in your Status contact list. | Mobile and desktop |
|
||||
| Show QR code | Use this option to show the community QR code to people to scan. | Mobile |
|
||||
| Share a link | Use this option to share a link via your other social media or copy it and share it manually. | Mobile and desktop |
|
||||
|
||||
## Invite people to a community
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-communities: **Communities**.
|
||||
1. In the **Communities** list, long press the community you want to share. If you don't see the community, enter the name in the search bar.
|
||||
1. In the action sheet, choose an option and proceed as follows:
|
||||
|
||||
| Option | Steps |
|
||||
|:---|:---|
|
||||
| Share to Status contacts | 1. Select :mobile-add-user: **Invite people from contacts list**. <br/> 2. Check the boxes next to the contacts you want to share with. <br/> 3. Tap **Invite users**. |
|
||||
| Show QR code | 1. Select :moblie-qr-code: **Show QR code**. <br/> 2. Show or send the QR code to people you want to invite. |
|
||||
| Share a link | 1. Select :mobile-share: **Share community**. <br/> 2. To share the link via another app on your phone, tap a profile picture or an app icon. To copy the link, tap **Copy**. |
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click :desktop-communities: **Communities**.
|
||||
1. Choose the community you want to share. If you don't see the community, enter the name in the search bar.
|
||||
1. From the navigation sidebar, right click the community logo and then select :desktop-share: **Share**.
|
||||
1. Choose the contacts or copy the link and proceed as follows:
|
||||
|
||||
| Option | Steps |
|
||||
|:---|:---|
|
||||
| Share to Status contacts | 1. In the **Invite Contacts** pop-up window, type the names of your contacts in the search bar or check the boxes next to the names. <br/> 2. Click **Next**. <br/> 3. Optionally, type an invitation message. <br/> 4. Click **Send Invites**. |
|
||||
| Share a link | 1. In the **Invite Contacts** pop-up window, click :desktop-copy: **Copy** next to the link. <br/> 2. Switch to the app or platform where you want to share the link and paste it there.
|
||||
|
||||
:::tip
|
||||
After opening the link or scanning the QR code, people can [install Status][download-status] Status if they haven't already.
|
||||
:::
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
id: 325
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Join a channel
|
||||
---
|
||||
|
||||
With Status, you can organize your conversations with community members into designated spaces called [channels](channels-your-quick-start-guide.md). Channels bring the right people and information together for a common purpose, like a specific project or topic.
|
||||
|
||||
All members of a [community](about-status-communities.md) can browse and join public channels. For private channels, you must [meet the requirements](understand-token-requirements-in-channels.md) to join the channel. To maintain access to private channels, hold the necessary tokens at all times.
|
||||
|
||||
## Join a public channel
|
||||
|
||||
All members can join channels that don't have a :mobile-locked-lock: lock icon next to their names. When you join a community, you automatically get access to these channels.
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-communities: **Communities**.
|
||||
1. Tap the community with the channel you want to join.
|
||||
1. Tap on the public channel.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click the community with the channel you want to join.
|
||||
1. In the channel sidebar, click the public channel.
|
||||
|
||||
## Join a private channel
|
||||
|
||||
Private channels have a :mobile-locked-lock: lock icon next to their names. To access these channels, you need to meet the token requirements. To maintain access, you need to keep holding the required tokens.
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-communities: **Communities**.
|
||||
1. Tap the community with the channel you want to join.
|
||||
1. Verify if you meet the channel requirements. If you don't meet the channel requirements, the **Enter channel** button is greyed out.
|
||||
1. Tap **Enter channel**.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click the community with the channel you want to join.
|
||||
1. In the channel sidebar, select the private channel.
|
||||
1. Verify if you meet the channel requirements. If you don't meet the channel requirements, the **Enter channel** button is greyed out.
|
||||
1. Click **Enter channel**.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 238
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Join a community on Status Web
|
||||
---
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
id: 103
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Join a Status Community
|
||||
---
|
||||
|
||||
:octicons-tools-24:
|
||||
|
||||
:::info
|
||||
We're working on this content.
|
||||
:::
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
id: 305
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Kick or ban someone from your community
|
||||
---
|
||||
|
||||
Community owners can kick out or ban members who violate the community guidelines or behave in a toxic manner. The difference between a kick and a ban in Status Communities is that a kick is temporary, while a ban is permanent. Community owners can kick or ban members in open and token-gated communities.
|
||||
|
||||
In the case of minor offences or annoyances, consider kicking the offender. For major violations of the community guidelines or repeated offences, you can use the ban option. Use the ban option cautiously, as this action is irreversible.
|
||||
|
||||
:::info
|
||||
Banning or kicking a user on your Status contact list doesn't remove the contact. If you want to remove the user from your contact list, [remove the contact][remove-a-contact-from-status] or [block the user][block-someone-in-status].
|
||||
:::
|
||||
|
||||
## What to expect
|
||||
|
||||
- A user who has been kicked out of a community can ask to join the community again.
|
||||
- A user who has been banned from a community cannot join the community again, but can request to join using a different profile.
|
||||
- Users receive a notification when they are kicked out but not when they are banned.
|
||||
- Users can see they have been kicked out or banned when they try to reaccess the community.
|
||||
|
||||
## Kick or ban someone
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-communities: **Communities**.
|
||||
1. Tap your community.
|
||||
1. From the navigation bar, tap :mobile-more-options: **More options**.
|
||||
1. Tap **View members** and then, tap :mobile-more-options: **More options** next to the member you want to kick or ban.
|
||||
1. Select :mobile-placeholder: **Kick** or :mobile-placeholder: **Ban**, depending on the action you wish to perform.
|
||||
1. Tap **Kick** or **Ban** again to confirm your action.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click your community.
|
||||
1. At the top of the channel sidebar, click your community logo.
|
||||
1. Click :mobile-placeholder: **Members** to show all the community users.
|
||||
1. Hover over the user and select **Kick** or **Ban**, depending on the action you wish to perform.
|
||||
1. Click **Kick** or **Ban** again to confirm your action.
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
id: 295
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Leave a channel
|
||||
---
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
id: 529
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Leave a Status Community
|
||||
---
|
||||
|
||||
There are times when you may not enjoy the conversations in a community, and you can leave it.
|
||||
|
||||
:::tip
|
||||
If you find yourself overwhelmed by community notifications, there's no need to leave the communities. You can [turn off the notifications][configure-community-and-channel-notifications].
|
||||
:::
|
||||
|
||||
## What to expect
|
||||
|
||||
- When you leave a community, you stop receiving messages or updates from that community.
|
||||
- Status does not notify the community owner and other members when you leave.
|
||||
- You can request to join the community again. Depending on the community rules, rejoining might require a new approval process or specific tokens.
|
||||
|
||||
## Leave a Status Community
|
||||
|
||||
=== "Mobile"
|
||||
|
||||
1. From the tab bar, tap :mobile-communities: **Communities**.
|
||||
1. In the **Communities** list, select the one you want to leave.
|
||||
1. Tap :mobile-more-options: **More options**.
|
||||
1. Select :mobile-log-out: **Leave community**.
|
||||
1. Tap **Leave community** again to confirm.
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, right click the community you want to leave.
|
||||
1. Select :desktop-left-arrow: **Leave Community**.
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
id: 491
|
||||
revision: '0'
|
||||
language: en
|
||||
title: Manage community join requests
|
||||
---
|
||||
|
||||
:::info
|
||||
Currently, you can only manage community join requests in Status desktop app.
|
||||
:::
|
||||
|
||||
You can set up manual or automatic approval join requests for your community. All requests to join your community are automatically approved by default, but you can enable manual approval.
|
||||
|
||||
With the manual approval option, you receive a notification whenever someone requests to join your community. This way, you can decide whether to accept, reject or ignore the request.
|
||||
|
||||
## What to expect
|
||||
|
||||
- Users don't receive a notification when a community owner or admin rejects their join request. Users only get a notification when the request to join is accepted.
|
||||
- The community screen is where the user can find out if their request was approved or denied.
|
||||
- If your control node is offline (for example, when you turn off your computer or close the Status desktop app), automatic join requests are rejected, and manual join requests time out in seven days. Keep the Status desktop app running as much as possible.
|
||||
- In addition to manual approval, you can set up [token requirements][understand-token-requirements-in-communities] to join communities. Manual approval and token requirements work independently.
|
||||
|
||||
:::info
|
||||
Status Communities take into account token requirements before membership requests.
|
||||
:::
|
||||
|
||||
## Set up the approval request option
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click your community.
|
||||
1. At the top of the channel sidebar, click your community logo.
|
||||
1. Click :desktop-overview: **Overview**.
|
||||
1. At the top of the content area, click **Edit Community**.
|
||||
1. Check or uncheck the **Request to join required** box to enable or disable manual approval.
|
||||
1. Click **Save changes**.
|
||||
|
||||
## Reject or accept community join requests
|
||||
|
||||
=== "Desktop"
|
||||
|
||||
1. From the navigation sidebar, click your community.
|
||||
1. At the top of the channel sidebar, click your community logo.
|
||||
1. Click :web-members: **Members**.
|
||||
1. At the top of the content area, select **Pending requests**.
|
||||
1. Hover over the user and select **Accept** or **Reject**, depending on your decision.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue