more docs

This commit is contained in:
Sarah Jamie Lewis 2022-06-02 08:52:59 -07:00
parent f447efb5ca
commit 0f21671cd8
6 changed files with 38 additions and 15 deletions

View File

@ -13,18 +13,10 @@ Cwtch (/kʊtʃ/ - a Welsh word roughly translating to “a hug that creates a sa
# Security, Encryption and Safety
For a more in depth look at the security, privacy and underlying encryption technology used in Cwtch, please
For a more in depth look at the security, privacy, and underlying encryption technology used in Cwtch, please
consult our [Security Handbook](https://docs.openprivacy.ca/cwtch-security-handbook/)
# Getting Started
You can download the latest version of Cwtch from [https://cwtch.im/download/](https://cwtch.im/download/)
### Install
Install on OS of choice:
- Windows
- Android
- MacOS
- Linux

View File

@ -4,6 +4,6 @@ sidebar_position: 2
# Changing Your Display Name
1. Press the pencil next to the profile you want to edit
1. On the Manage Profiles view, Press the pencil next to the profile you want to edit
2. Change your name
3. Click save profile

View File

@ -1,6 +1,12 @@
---
sidebar_position: 4
---
:::note
This feature requires [Experiments Enabled](https://docs.cwtch.im/docs/settings/introduction#experiments) and
both the [File Sharing](https://docs.cwtch.im/docs/settings/experiments/file-sharing) and [Image Previews and Profile Pictures](https://docs.cwtch.im/docs/settings/experiments/image-previews-and-profile-pictures) enabled.
:::
# Changing Your Profile Image

View File

@ -6,8 +6,16 @@ sidebar_position: 1.5
1. Press the + action button in the right bottom corner
2. Select a display name
3. Select if you want an account with or without password
3. Select if you want to protect this profile locally with strong encryption:
- Password: your account is protected from other people who may use this device
- No Password: anyone who has access to this device may be able to access this profile
4. Fill in your password and re-enter it
5. Click add new profile
5. Click add new profile
## A note on Password Protected (Encrypted) Profiles
Profiles are stored locally on disk and encrypted using a key derived from user-known password (via pbkdf2).
Note that once encrypted, and stored on disk, the only way to recover a profile is by rederiving the password - as such it isn't possible to provide a full list of profiles a user might have access to until they enter a password.
See also: [Cwtch Security Handbook: Profile Encryption & Storage](https://docs.openprivacy.ca/cwtch-security-handbook/profile_encryption_and_storage.html)

View File

@ -7,4 +7,19 @@ sidebar_position: 1
With Cwtch you can create one of more **Profiles**. Each profile generates a random ed25519 keypair compatible with
the Tor Network.
This is the identifier that you can give out to people and that they can use to contact you via Cwtch.
This is the identifier that you can give out to people and that they can use to contact you via Cwtch.
Cwtch allows you to create and manage multiple, separate profiles. Each profile is associated with a different
key pair which launches a different onion service.
## Manage Profiles
On start up Cwtch will launch the Manage Profiles screen. From this screen you can:
- [Create a New Profile](https://docs.cwtch.im/docs/profiles/create-a-profile)
- [Unlock Existing Encrypted Profiles](https://docs.cwtch.im/docs/profiles/unlock-profile)
- Manage Loaded Profiles
- [Changing The Display Name of a Profile](https://docs.cwtch.im/docs/profiles/change-name/)
- [Changing the Password of a Profile](https://docs.cwtch.im/docs/profiles/change-password/)
- [Deleting a Profile](https://docs.cwtch.im/docs/profiles/delete-profile)
- [Changing a Profile Image](https://docs.cwtch.im/docs/profiles/change-profile-image/)

View File

@ -4,8 +4,10 @@ sidebar_position: 5
# Unlocking Encrypted Profiles
When you restart Cwtch, if you used a [password](/docs/profiles/change-password/) on your profile, it will not be loaded by default, you need to unlock it.
When you restart Cwtch, if you used a [password](/docs/profiles/change-password/) to protect your profile, it will not be loaded by default, and you will need to unlock it.
1. Press the pink unlock icon <img src="/img/lock_open-24px.webp" className="ui-button" alt="unlock icon" />
2. Input your password
3. Click “unlock your profile”
3. Click “unlock your profile”
See also: [Cwtch Security Handbook: Profile Encryption & Storage](https://docs.openprivacy.ca/cwtch-security-handbook/profile_encryption_and_storage.html)