scientific-witchery/pds-starter-pack
4
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Move custom did:plc to new file and add supporting links

Browse source
This commit is contained in:
Turtlepaw 2025-07-04 00:03:07 -04:00
parent c480b68f6b
commit 1f82fd1759
Signed by untrusted user who does not match committer: turtlepaw
GPG key ID: EDB93688ECBE7AB9
2 changed files with 99 additions and 92 deletions
Download patch file Download diff file Expand all files Collapse all files

92
README.md
View file

@ -39,98 +39,6 @@ In case of anything significant affecting the PDS, we will do our best to tell y
3. Done! 3. Done!
4. **Recommended if using did:plc!** [Set up a custom did:plc key](#setting-up-a-custom-didplc) for your account. You can use [boat](https://boat.kelinci.net/) to both generate a key pair (store it somewhere safe!) and to add the public key to your account. This will allow you to point your DID to a different PDS without using our PDS's key. 4. **Recommended if using did:plc!** [Set up a custom did:plc key](#setting-up-a-custom-didplc) for your account. You can use [boat](https://boat.kelinci.net/) to both generate a key pair (store it somewhere safe!) and to add the public key to your account. This will allow you to point your DID to a different PDS without using our PDS's key.
### Setting up a custom did:plc
#### Obtain secret keys
1. Generate [secret keys using boat](https://boat.kelinci.net/crypto-generate)
<details>
<summary>📸 Image</summary>
![Image of using boat.kelinci.net to generate secret keys](/images/secret-keys.png)
</details>
2. Store these keys in a safe location! (and don't share your private keys with anyone!)
#### Add the new keys to your did:plc
1. Open the [PLC applicator](https://boat.kelinci.net/plc-applicator)
2. Enter your handle and login
<details>
<summary>📸 Image</summary>
![Image of logging into boat.kelinci.net's PLC applicator](/images/apply_plc_login.png)
</details>
3. Select "Append an operation"
<details>
<summary>📸 Image</summary>
![Image of selecting "Append an operation" into boat.kelinci.net's PLC applicator](/images/apply_plc_append.png)
</details>
4. Add your new generated public key (did:key) to the top of the `rotationKeys` array (with a following comma)
<details>
<summary>See example payload</summary>
```json
{
"alsoKnownAs": [
"at://placeholder.pds.witchcraft.systems"
],
"rotationKeys": [
"did:key:zQ3shcmcnHahf41czhQHUb4zCLDEaLyHznd1ENHmatUtw6vPn", // your new public key (did:key)
"did:key:zQ3shuT9p9qxyXwJaUPsegQ5GCp7fxyLsjDKS5nybPXSohght" // your old did:key
],
"services": {
"atproto_pds": {
"type": "AtprotoPersonalDataServer",
"endpoint": "https://pds.witchcraft.systems"
}
},
"verificationMethods": {
"atproto": "did:key:zQ3shrEaHqBf3PtN8r3PksRCRNpiB92czfEZWZUt8DcjExLam"
}
}
```
</details>
<details>
<summary>📸 Image</summary>
![Image of payload data in boat.kelinci.net's PLC applicator](/images/apply_plc_payload.png)
</details>
5. Request a verification code and enter it below, then press next.
</details>
<details>
<summary>📸 Image</summary>
![Image of entering a verification code in boat.kelinci.net's PLC applicator](/images/apply_plc_confirmation.png)
</details>
</details>
<details>
<summary>Not receiving the email?</summary>
- Check your junk mail
- Outlook emails don't seem to work, you can try Proton
</details>
6. Your did:plc should be updated, which means you can point your did:plc to a different PDS by yourself while keeping your identity!
## How to leave if we ever go down ## How to leave if we ever go down
We have no plans of shutting down the PDS, but for your benefit, here are the rough steps to migrate your data to another PDS if we ever do: We have no plans of shutting down the PDS, but for your benefit, here are the rough steps to migrate your data to another PDS if we ever do:

99
custom-did-plc.md Normal file
View file

@ -0,0 +1,99 @@
# Setting up a custom did:plc
This guide will help you modify your did:plc so you can point it to a different PDS yourself without losing your identity! ✨
## Obtain secret keys
1. Generate [secret keys using boat](https://boat.kelinci.net/crypto-generate)
<details>
<summary>📸 Example image</summary>
![Image of using boat.kelinci.net to generate secret keys](/images/secret-keys.png)
</details>
2. Store these keys in a safe location! (and don't share your private keys with anyone!)
## Add the new keys to your did:plc
1. Open the [PLC applicator](https://boat.kelinci.net/plc-applicator) in boat
2. Enter your handle and password
<details>
<summary>📸 Image</summary>
![Image of logging into boat.kelinci.net's PLC applicator](/images/apply_plc_login.png)
</details>
3. Select "Append an operation"
<details>
<summary>📸 Image</summary>
![Image of selecting "Append an operation" into boat.kelinci.net's PLC applicator](/images/apply_plc_append.png)
</details>
4. Add your new generated public key (did:key) to the top of the `rotationKeys` array (with a following comma)
<details>
<summary>See example payload</summary>
```json
{
"alsoKnownAs": [
"at://placeholder.pds.witchcraft.systems"
],
"rotationKeys": [
"did:key:zQ3shcmcnHahf41czhQHUb4zCLDEaLyHznd1ENHmatUtw6vPn", // add your new public key (did:key) here
"did:key:zQ3shuT9p9qxyXwJaUPsegQ5GCp7fxyLsjDKS5nybPXSohght" // your old did:key
],
"services": {
"atproto_pds": {
"type": "AtprotoPersonalDataServer",
"endpoint": "https://pds.witchcraft.systems"
}
},
"verificationMethods": {
"atproto": "did:key:zQ3shrEaHqBf3PtN8r3PksRCRNpiB92czfEZWZUt8DcjExLam"
}
}
```
</details>
<details>
<summary>📸 Image</summary>
![Image of payload data in boat.kelinci.net's PLC applicator](/images/apply_plc_payload.png)
</details>
5. Request a verification code and enter it below, then press next.
</details>
<details>
<summary>📸 Image</summary>
![Image of entering a verification code in boat.kelinci.net's PLC applicator](/images/apply_plc_confirmation.png)
</details>
</details>
<details>
<summary>Not receiving the email?</summary>
- Check your junk mail
- Outlook emails don't seem to work, you can try Proton
</details>
6. Your did:plc should be updated, which means you can point your did:plc to a different PDS by yourself while keeping your identity!
### See also
- [Identity - AT Protocol](https://atproto.com/guides/identity)
- [DID - AT Protocol](https://atproto.com/specs/did)
- [did-method-plc - GitHub](https://github.com/did-method-plc/did-method-plc)