From 14e67ef68ae669526f21b3d7ef3c79488c8c91b7 Mon Sep 17 00:00:00 2001 From: Astra Date: Fri, 4 Jul 2025 20:43:22 +0900 Subject: [PATCH 1/2] Minor PLC doc edits --- README.md | 6 +++--- custom-did-plc.md => docs/custom-did-plc.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) rename custom-did-plc.md => docs/custom-did-plc.md (85%) diff --git a/README.md b/README.md index 4eac825..db8f808 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ In case of anything significant affecting the PDS, we will do our best to tell y 3. Click on "You are creating an account on Bluesky Social", and set a custom provider URL to `https://pds.witchcraft.systems`. 4. Enter your invite code and the rest of the required information. 5. Congratulations! You now have a PDS account. You may want to subscribe to [@announcements.pds.witchcraft.systems](https://deer.social/profile/announcements.pds.witchcraft.systems) to get updates about the PDS. -6. **Recommended!** [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. +6. **Recommended!** [Set up a custom did:plc key](docs/custom-did-plc.md) for your account. ## How to move an existing account to our PDS @@ -37,13 +37,13 @@ In case of anything significant affecting the PDS, we will do our best to tell y 1. Get an invite code. 2. Follow [this guide](https://whtwnd.com/bnewbold.net/entries/Migrating%20PDS%20Account%20with%20%60goat%60) to migrate using the `goat` tool. Otherwise, you can use the [ATP INTERNECTIONAL AIRPORT](https://atpairport.com/) for a more user-friendly experience, but it is currently in alpha and may not work as expected. Keep in mind that those tools are made for did:plc; If you have a did:web - good luck, you figured it out when you created the account, so surely you'll figure it out now too :^) 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](docs/custom-did-plc.md) for your account. ## 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: -0. Have [custom keys in your did:plc](#setting-up-a-custom-didplc) or use a did:web. +0. Have [custom keys in your did:plc](docs/custom-did-plc.md) or use a did:web. 1. Grab the files for your DID from the [nightly backups S3 bucket](https://link.storjshare.io/s/jufla747mctifdglkggg2jqhvddq/pds-witchcraft-systems/backups/). 2. Upload the CAR contents and the blobs to your new PDS. 3. Point your DID at the new PDS. diff --git a/custom-did-plc.md b/docs/custom-did-plc.md similarity index 85% rename from custom-did-plc.md rename to docs/custom-did-plc.md index d0ac4f7..d6e8be0 100644 --- a/custom-did-plc.md +++ b/docs/custom-did-plc.md @@ -12,7 +12,7 @@ This guide will help you modify your did:plc so you can point it to a different ![Image of using boat.kelinci.net to generate secret keys](/images/secret-keys.png) -2. Store these keys in a safe location! (and don't share your private keys with anyone!) +2. Store these keys in a safe location, for example - in your password manager. (and don't share your private keys with anyone!) ## Add the new keys to your did:plc @@ -34,7 +34,7 @@ This guide will help you modify your did:plc so you can point it to a different -4. Add your new generated public key (did:key) to the top of the `rotationKeys` array (with a following comma) +4. Add your new generated public key (did:key) to the top of the `rotationKeys` array (with a following comma). It is important to add it at the top, since PLC keys aren't all equal, their position in the array defines their priority. If you add it at the bottom, it will not be able to override operations submitted by the old key (which is controlled by your PDS).
See example payload @@ -96,4 +96,4 @@ This guide will help you modify your did:plc so you can point it to a different - [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) \ No newline at end of file +- [did-method-plc - GitHub](https://github.com/did-method-plc/did-method-plc) From bc357cf2513fc749e5aaee51eac63fa8daba3e35 Mon Sep 17 00:00:00 2001 From: Astra Date: Fri, 4 Jul 2025 20:44:34 +0900 Subject: [PATCH 2/2] Image address fix --- docs/custom-did-plc.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/custom-did-plc.md b/docs/custom-did-plc.md index d6e8be0..81ce5f4 100644 --- a/docs/custom-did-plc.md +++ b/docs/custom-did-plc.md @@ -9,7 +9,7 @@ This guide will help you modify your did:plc so you can point it to a different
📸 Example image - ![Image of using boat.kelinci.net to generate secret keys](/images/secret-keys.png) + ![Image of using boat.kelinci.net to generate secret keys](../images/secret-keys.png)
2. Store these keys in a safe location, for example - in your password manager. (and don't share your private keys with anyone!) @@ -22,7 +22,7 @@ This guide will help you modify your did:plc so you can point it to a different
📸 Image - ![Image of logging into boat.kelinci.net's PLC applicator](/images/apply_plc_login.png) + ![Image of logging into boat.kelinci.net's PLC applicator](../images/apply_plc_login.png)
3. Select "Append an operation" @@ -30,7 +30,7 @@ This guide will help you modify your did:plc so you can point it to a different
📸 Image - ![Image of selecting "Append an operation" into boat.kelinci.net's PLC applicator](/images/apply_plc_append.png) + ![Image of selecting "Append an operation" into boat.kelinci.net's PLC applicator](../images/apply_plc_append.png)
@@ -65,7 +65,7 @@ This guide will help you modify your did:plc so you can point it to a different
📸 Image - ![Image of payload data in boat.kelinci.net's PLC applicator](/images/apply_plc_payload.png) + ![Image of payload data in boat.kelinci.net's PLC applicator](../images/apply_plc_payload.png)
@@ -76,7 +76,7 @@ This guide will help you modify your did:plc so you can point it to a different
📸 Image - ![Image of entering a verification code in boat.kelinci.net's PLC applicator](/images/apply_plc_confirmation.png) + ![Image of entering a verification code in boat.kelinci.net's PLC applicator](../images/apply_plc_confirmation.png)