diff --git a/docs/chat/share-address-with-friends.md b/docs/chat/share-address-with-friends.md index c0483dbc..ddc2c82b 100644 --- a/docs/chat/share-address-with-friends.md +++ b/docs/chat/share-address-with-friends.md @@ -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 \ No newline at end of file +For information on blocking connections from people you don't know please see [Settings: Block Unknown Connections](/docs/settings/behaviour/block-unknown-connections) \ No newline at end of file diff --git a/docs/groups/accept-group-invite.md b/docs/groups/accept-group-invite.md index 5acd2bff..6486618d 100644 --- a/docs/groups/accept-group-invite.md +++ b/docs/groups/accept-group-invite.md @@ -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 diff --git a/docs/groups/create-group.md b/docs/groups/create-group.md index f600b26d..12e05857 100644 --- a/docs/groups/create-group.md +++ b/docs/groups/create-group.md @@ -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 diff --git a/docs/groups/edit-group-name.md b/docs/groups/edit-group-name.md index 275ad436..17cb8c19 100644 --- a/docs/groups/edit-group-name.md +++ b/docs/groups/edit-group-name.md @@ -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 diff --git a/docs/groups/enable-experiment.md b/docs/groups/enable-experiment.md deleted file mode 100644 index e5f37022..00000000 --- a/docs/groups/enable-experiment.md +++ /dev/null @@ -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 \ No newline at end of file diff --git a/docs/groups/introduction.md b/docs/groups/introduction.md index c13947ec..56516ff1 100644 --- a/docs/groups/introduction.md +++ b/docs/groups/introduction.md @@ -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.** diff --git a/docs/groups/leave-group.md b/docs/groups/leave-group.md index 2ce68883..42cf5faf 100644 --- a/docs/groups/leave-group.md +++ b/docs/groups/leave-group.md @@ -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 diff --git a/docs/groups/manage-known-servers.md b/docs/groups/manage-known-servers.md index b0062ba3..2a2cbac1 100644 --- a/docs/groups/manage-known-servers.md +++ b/docs/groups/manage-known-servers.md @@ -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 diff --git a/docs/groups/send-invite.md b/docs/groups/send-invite.md index 59b86b08..a431e65d 100644 --- a/docs/groups/send-invite.md +++ b/docs/groups/send-invite.md @@ -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 diff --git a/docs/servers/create-server.md b/docs/servers/create-server.md index 6e8626f0..a704a8f0 100644 --- a/docs/servers/create-server.md +++ b/docs/servers/create-server.md @@ -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 diff --git a/docs/servers/delete-server.md b/docs/servers/delete-server.md index 28a9bad1..9ed2eac9 100644 --- a/docs/servers/delete-server.md +++ b/docs/servers/delete-server.md @@ -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 diff --git a/docs/servers/edit-server.md b/docs/servers/edit-server.md index df7ff888..9aea3381 100644 --- a/docs/servers/edit-server.md +++ b/docs/servers/edit-server.md @@ -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 diff --git a/docs/servers/enable-experiment.md b/docs/servers/enable-experiment.md deleted file mode 100644 index 011e76af..00000000 --- a/docs/servers/enable-experiment.md +++ /dev/null @@ -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 \ No newline at end of file diff --git a/docs/servers/introduction.md b/docs/servers/introduction.md index e1675c84..5fea04b7 100644 --- a/docs/servers/introduction.md +++ b/docs/servers/introduction.md @@ -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. diff --git a/docs/servers/share-key.md b/docs/servers/share-key.md index 08833e0f..0568666a 100644 --- a/docs/servers/share-key.md +++ b/docs/servers/share-key.md @@ -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 diff --git a/docs/servers/unlock-server.md b/docs/servers/unlock-server.md index f061b999..99d7d4d4 100644 --- a/docs/servers/unlock-server.md +++ b/docs/servers/unlock-server.md @@ -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 diff --git a/docs/settings/experiments/group-experiment.md b/docs/settings/experiments/group-experiment.md index c35289ee..58d569bc 100644 --- a/docs/settings/experiments/group-experiment.md +++ b/docs/settings/experiments/group-experiment.md @@ -2,4 +2,8 @@ sidebar_position: 1 --- -# Groups \ No newline at end of file +# Enable the Groups Experiment + +1. Go to Settings +2. Enable Experiments +3. Enable the Group experiment \ No newline at end of file diff --git a/docs/settings/experiments/server-hosting.md b/docs/settings/experiments/server-hosting.md index 4f802f91..fd060968 100644 --- a/docs/settings/experiments/server-hosting.md +++ b/docs/settings/experiments/server-hosting.md @@ -2,4 +2,11 @@ sidebar_position: 2 --- -# Server Hosting \ No newline at end of file +# 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 \ No newline at end of file