experiment warnings

This commit is contained in:
Sarah Jamie Lewis 2022-06-02 09:22:48 -07:00
parent 34d9386939
commit 498901e3fe
18 changed files with 108 additions and 29 deletions

View File

@ -9,4 +9,4 @@ sidebar_position: 3
You can now share this address. People with this address will be able to add you as a Cwtch contact.
For information on blocking connections from people you don't know please see
For information on blocking connections from people you don't know please see [Settings: Block Unknown Connections](/docs/settings/behaviour/block-unknown-connections)

View File

@ -4,6 +4,13 @@ sidebar_position: 5
# Accepting a Group Invite
:::caution
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
the [Group Experiment](https://docs.cwtch.im/docs/settings/experiments/group-experiment) turned on.
:::
1. If a friend sends you a group request
2. Choose if you want or not to join this group
3. Now the group is on your contact list

View File

@ -4,6 +4,13 @@ sidebar_position: 3
# Creating a New Group
:::caution
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
the [Group Experiment](https://docs.cwtch.im/docs/settings/experiments/group-experiment) turned on.
:::
1. On your contacts pane
2. Press on the plus action button
3. Press on Create Group

View File

@ -4,6 +4,13 @@ sidebar_position: 7
# Editing a Group Name
:::caution
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
the [Group Experiment](https://docs.cwtch.im/docs/settings/experiments/group-experiment) turned on.
:::
Group names are private to you, it will not be shared, it is your local name for the group.
1. On the chat pane go to settings

View File

@ -1,11 +0,0 @@
---
sidebar_position: 2
---
# Enable the Groups Experiment
Groups are currently an experimental feature in Cwtch so they are not enabled by default
1. Go to Settings
2. Enable Experiments
3. Enable the Group experiment

View File

@ -4,6 +4,13 @@ sidebar_position: 1
# An Introduction to Cwtch Groups
:::caution
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
the [Group Experiment](https://docs.cwtch.im/docs/settings/experiments/group-experiment) turned on.
:::
**Note: Metadata Resistant Group Communication is still an active research area and what is documented here
will likely change in the future.**

View File

@ -4,6 +4,13 @@ sidebar_position: 6
# How to leave group
:::caution
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
the [Group Experiment](https://docs.cwtch.im/docs/settings/experiments/group-experiment) turned on.
:::
1. On the chat pane go to settings
2. Scroll down on the settings pane
3. Press on leave conversation

View File

@ -4,6 +4,13 @@ sidebar_position: 7
# Managing Servers
:::caution
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
the [Group Experiment](https://docs.cwtch.im/docs/settings/experiments/group-experiment) turned on.
:::
Cwtch groups are hosted by untrusted servers. If you want to see the servers you know about, their status, and the groups hosted on them:
1. On your contacts pane

View File

@ -4,6 +4,13 @@ sidebar_position: 4
# Sending Invites to a Group
:::caution
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
the [Group Experiment](https://docs.cwtch.im/docs/settings/experiments/group-experiment) turned on.
:::
1. Go to a chat with a friend
2. Press on the invite icon
3. Select the group you want to invite them to

View File

@ -4,6 +4,13 @@ sidebar_position: 2
# How to create a server
:::caution
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
the [Server Hosting Experiment](https://docs.cwtch.im/docs/settings/experiments/server-hosting) turned on.
:::
1. Go to the server icon
2. Press the + action button to make a new server
3. Choose a name for your server

View File

@ -2,6 +2,13 @@
sidebar_position: 4
---
:::caution
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
the [Server Hosting Experiment](https://docs.cwtch.im/docs/settings/experiments/server-hosting) turned on.
:::
# How to delete server
1. Go to the server Icon

View File

@ -2,6 +2,13 @@
sidebar_position: 3
---
:::caution
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
the [Server Hosting Experiment](https://docs.cwtch.im/docs/settings/experiments/server-hosting) turned on.
:::
# How to edit a server
1. Go to the server icon

View File

@ -1,12 +0,0 @@
---
sidebar_position: 2
---
# Enable Servers Experiment
**Server hosting is currently an experimental feature in Cwtch so it is not enabled by default.**
1. Go to Settings
2. Enable Experiments
3. Enable the Server Hosting experiment
4. You will probably also want to enable the Group experiment if you want to participate on a group hosted on your server

View File

@ -4,6 +4,13 @@ sidebar_position: 1
# Servers Introduction
:::caution
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
the [Server Hosting Experiment](https://docs.cwtch.im/docs/settings/experiments/server-hosting) turned on.
:::
Cwtch contact to contact chat is fully peer to peer, which means if one peer is offline, you cannot chat, and there is no mechanism for multiple people to chat.
To support group chat (and offline delivery) we have created untrusted Cwtch servers which can host messages for a group. The messages are encrypted with the group key, and fetch via ephemeral onions, so the server has no way to know what messages for what groups it might be holding, or who is accessing it.

View File

@ -2,9 +2,16 @@
sidebar_position: 5
---
# How to copy your server keys
# How to share your Server Key Bundle
Your server key bundle is the package of data a Cwtch app needs inorder to use a server. If you just want to make other Cwtch users aware of your server, you can share this with them. Then they will have the ability to create their own groups on the server.
:::caution
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
the [Server Hosting Experiment](https://docs.cwtch.im/docs/settings/experiments/server-hosting) turned on.
:::
Your server key bundle is the package of data a Cwtch app needs in order to use a server. If you just want to make other Cwtch users aware of your server, you can share this with them. Then they will have the ability to create their own groups on the server.
1. Go to the server Icon
2. Select the server you want

View File

@ -4,7 +4,14 @@ sidebar_position: 6
# How to Unlock a server
If you created your server with a password, it will need to be unlocked each time you restart the application.
:::caution
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
the [Server Hosting Experiment](https://docs.cwtch.im/docs/settings/experiments/server-hosting) turned on.
:::
If you protected your server with a password, it will need to be unlocked each time you restart the application.
1. Go to the server Icon
2. Click on the pink unlock icon

View File

@ -2,4 +2,8 @@
sidebar_position: 1
---
# Groups
# Enable the Groups Experiment
1. Go to Settings
2. Enable Experiments
3. Enable the Group experiment

View File

@ -2,4 +2,11 @@
sidebar_position: 2
---
# Server Hosting
# Server Hosting
**Server hosting is currently an experimental feature in Cwtch so it is not enabled by default.**
1. Go to Settings
2. Enable Experiments
3. Enable the Server Hosting experiment
4. You will probably also want to enable the Group experiment if you want to participate on a group hosted on your server