Skip to content

Commit cb24e44

Browse files
committed
rename pkarr to PKARR
1 parent 33a9213 commit cb24e44

13 files changed

+67
-93
lines changed

.obsidian/workspace.json

+42-68
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,16 @@
44
"type": "split",
55
"children": [
66
{
7-
"id": "bde2716aaeca2c3a",
7+
"id": "11883abd2160efc0",
88
"type": "tabs",
99
"children": [
1010
{
11-
"id": "2dc64b1d3735d56d",
11+
"id": "2714f48edb8555ee",
1212
"type": "leaf",
1313
"state": {
14-
"type": "markdown",
14+
"type": "image",
1515
"state": {
16-
"file": "Pubky Core/Pkarr/2.Getting Started with Pkarr.md",
17-
"mode": "source",
18-
"source": false
19-
}
20-
}
21-
},
22-
{
23-
"id": "3593b819d6c78f93",
24-
"type": "leaf",
25-
"state": {
26-
"type": "markdown",
27-
"state": {
28-
"file": "Concepts/Credible Exit.md",
29-
"mode": "source",
30-
"source": false
31-
}
32-
}
33-
},
34-
{
35-
"id": "f30e9fecad7dbed7",
36-
"type": "leaf",
37-
"state": {
38-
"type": "markdown",
39-
"state": {
40-
"file": "Technologies/DNS.md",
41-
"mode": "source",
42-
"source": false
16+
"file": "images/pubky-arch.png"
4317
}
4418
}
4519
}
@@ -72,7 +46,7 @@
7246
"state": {
7347
"type": "search",
7448
"state": {
75-
"query": "WIP",
49+
"query": "pkarr",
7650
"matchingCase": false,
7751
"explainSearch": false,
7852
"collapseAll": false,
@@ -109,7 +83,7 @@
10983
"state": {
11084
"type": "backlink",
11185
"state": {
112-
"file": "Pubky Core/Pkarr/2.Getting Started with Pkarr.md",
86+
"file": "images/pubky-arch.png",
11387
"collapseAll": false,
11488
"extraContext": false,
11589
"sortOrder": "alphabetical",
@@ -126,7 +100,7 @@
126100
"state": {
127101
"type": "outgoing-link",
128102
"state": {
129-
"file": "Pubky Core/Pkarr/2.Getting Started with Pkarr.md",
103+
"file": "images/pubky-arch.png",
130104
"linksCollapsed": false,
131105
"unlinkedCollapsed": true
132106
}
@@ -149,7 +123,7 @@
149123
"state": {
150124
"type": "outline",
151125
"state": {
152-
"file": "Pubky Core/Pkarr/2.Getting Started with Pkarr.md"
126+
"file": "images/pubky-arch.png"
153127
}
154128
}
155129
}
@@ -171,40 +145,45 @@
171145
"hide-folders:Show hidden folders": false
172146
}
173147
},
174-
"active": "2dc64b1d3735d56d",
148+
"active": "75a1317f66991245",
175149
"lastOpenFiles": [
176-
"quartz/public/static/contentIndex.json",
177-
"quartz/public/static",
178-
"quartz/public/index.xml",
179-
"quartz/public/sitemap.xml",
180-
"quartz/public/tags/segwit.html",
181-
"quartz/public/tags/privacy.html",
182-
"quartz/public/tags/index.html",
183-
"quartz/public/tags/Pubky.html",
184-
"quartz/public/tags",
185-
"quartz/public/readme.html",
186-
"quartz/public/index.html",
187-
"quartz/public/images/mermaid_charts/semantic_social_graph.svg",
150+
"images/pubky-core.png_original",
151+
"images/pubky-core.png_exiftool_tmp",
152+
"images/pubky-backend.png_exiftool_tmp",
153+
"images/pubky-arch.png_original",
154+
"images/pubky-arch.png_exiftool_tmp",
155+
"images/pubky-app.png_exiftool_tmp",
156+
"images/pubky-header.png",
157+
"images/pubky-core.png",
158+
"images/pubky-backend.png",
159+
"images/pubky-arch.png",
160+
"images/pubky-app.png",
161+
"images/client-homeserver.png",
162+
"Technologies/DNS.md",
163+
"Concepts/Credible Exit.md",
164+
"The vision of Pubky.md",
165+
"Pubky App/Introduction.md",
166+
"Pubky Core/Introduction.md",
167+
"index.md",
168+
"Pubky Core/Homeservers.md",
169+
"Pubky Core/Pkarr/ELI5.md",
170+
"Technologies/DoH.md",
171+
"Pubky Core/Pkarr/4.Architecture.md",
172+
"Pubky Core/Pkarr/3.Expectations.md",
173+
"Pubky Core/Pkarr/1.Why PKARR?.md",
174+
"Pubky Core/Pkarr/2.Getting Started with PKARR.md",
175+
"Pubky Core/Pkarr/0.Introduction.md",
176+
"quartz/public/404.html",
177+
"quartz/public/quartz/quartz/plugins/transformers/toc.ts",
178+
"quartz/public/quartz/quartz/plugins/transformers/syntax.ts",
179+
"quartz/public/quartz/quartz/plugins/transformers/oxhugofm.ts",
180+
"quartz/public/quartz/quartz/plugins/transformers/ofm.ts",
188181
"quartz/public/quartz/quartz/static/og-image.png",
189182
"quartz/public/quartz/quartz/static/icon.png",
190-
"quartz/public/images/quartz.png",
183+
"quartz/public/images/mermaid_charts/semantic_social_graph.svg",
191184
"quartz/public/images/pubky-header.png",
192-
"quartz/public/images/pubky-core.png",
193-
"quartz/public/images/pubky-backend.png",
194-
"quartz/public/images/pubky-arch.png",
195-
"quartz/public/images/pubky-app.png",
196-
"quartz/public/images/obsidian.png",
197-
"Pubky Core/Pkarr/1.Why Pkarr?.md",
198-
"Pubky Core/Pkarr/0.Introduction.md",
199185
"Pubky Core/ELI5.md",
200-
"Pubky Core/Homeservers.md",
201-
"Pubky Core/Introduction.md",
202-
"Technologies/DoH.md",
203-
"Technologies/DNS.md",
204186
"Technologies/DHT.md",
205-
"Pubky Core/Pkarr/2.Getting Started with Pkarr.md",
206-
"Concepts/Credible Exit.md",
207-
"Pubky App/Introduction.md",
208187
"Pubky App/Backend/Introduction.md",
209188
"Pubky App/Client/Introduction.md",
210189
"Pubky App/Backend/Web Server.md",
@@ -213,11 +192,6 @@
213192
"Pubky App/App Architectures/4. Custom Backend.md",
214193
"Pubky App/App Architectures/3. Global Aggregators.md",
215194
"Pubky App/App Architectures/2. Client - Homeserver.md",
216-
"Pubky App/App Architectures/1. Introduction.md",
217-
"Concepts/What Is a Decentralized Semantic Social Graph?.md",
218-
"Concepts/Semantic Social Graph.md",
219-
"readme.md",
220-
"Concepts/Censorship.md",
221-
"Technologies/Paykit.md"
195+
"Pubky App/App Architectures/1. Introduction.md"
222196
]
223197
}

Pubky App/Introduction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@ It is the part of the Pubky App that you interact with directly. It's responsibl
3232

3333
The early versions of Pubky app take some shortcuts over the [[Pubky Core/Introduction|Pubky Core]] design. The MVP app is centralized, therefore we saved time and complexity by aggregating functionality into fewer components. The main two components are the `Homeserver` and the `Indexer`
3434

35-
- The [[Homeservers|homeservers]] fulfils the function of `data stores`, republishing users keys to [[0.Introduction|Pkarr]] and it acts also as an identity-provider (Oauth-like sign-in). Users maintain a trust relationship with the homeserver.
35+
- The [[Homeservers|homeservers]] fulfils the function of `data stores`, republishing users keys to [[0.Introduction|PKARR]] and it acts also as an identity-provider (Oauth-like sign-in). Users maintain a trust relationship with the homeserver.
3636
- The `Indexer` fulfils the function of the [[Pubky App/Backend/Introduction|backend]] for the Pubky App.

Pubky Core/Homeservers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The Pubky network allows multiple, independent data stores, known as "homeservers." This improves [[Censorship|censorship-resistance]] and prevents any single entity from controlling the flow of information, or locking people & data in as a walled garden.
22

3-
Homeservers are meant to represent a primary place to retrieve data from a specific [[0.Introduction|pkarr]] public key, but the user can redefine the location of their homeserver at will by updating their [[0.Introduction|pkarr]] in [[DHT|mainline DHT]].
3+
Homeservers are meant to represent a primary place to retrieve data from a specific [[0.Introduction|PKARR]] public key, but the user can redefine the location of their homeserver at will by updating their [[0.Introduction|PKARR]] in [[DHT|mainline DHT]].
44

55
## Public vs Private Data
66

Pubky Core/Introduction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Pubky Core is built on a few core concepts:
66

77
- **[[Homeservers|Homeserver]]** - Decentralized data storage nodes that host user data. Data is encrypted at rest.
88

9-
- **[[0.Introduction|Pkarr]]** - Self-issued public keys that function as sovereign, publicly addressable domains are used to resolve the previous components.
9+
- **[[0.Introduction|PKARR]]** - Self-issued public keys that function as sovereign, publicly addressable domains are used to resolve the previous components.
1010

1111
Pubky Core's distributed architecture aims to provide user autonomy through [[Credible Exit|credible exit]] between interchangeable components.
1212

Pubky Core/Pkarr/0.Introduction.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
## Public-Key Addressable Resource Records
22

3-
[Pkarr](https://pkarr.org) is a revolutionary system that bridges the gap between the Domain Name System ([[DNS]]) and peer-to-peer overlay networks. It allows self-issued public keys to function as sovereign, publicly addressable domains. This means that anyone with a private key can have a domain that is accessible to everyone.
3+
[PKARR](https://pkarr.org) is a revolutionary system that bridges the gap between the Domain Name System ([[DNS]]) and peer-to-peer overlay networks. It allows self-issued public keys to function as sovereign, publicly addressable domains. This means that anyone with a private key can have a domain that is accessible to everyone.
44

55
The core idea is to streamline the process of publishing and resolving resource records for keys, leveraging the Distributed Hash Table ([[DHT]]) for efficient and scalable data distribution.
66

77
## Key Features
88

9-
- **Simplicity**: Pkarr streamlines the integration between [[DNS]] and peer-to-peer networks.
9+
- **Simplicity**: PKARR streamlines the integration between [[DNS]] and peer-to-peer networks.
1010
- **Sovereignty**: Public keys can be used as domains, enabling users to maintain control over their digital identities.
1111
- **Accessibility**: The system is designed to be accessible to anyone capable of maintaining a private key.
1212
- **Scalability and Resilience**: Designed with scalability and resilience in mind, using the [[Mainline DHT]] for storing ephemeral data, and employing caching strategies to minimize [[DHT]] traffic.
13-
- **Compatibility with Existing Applications**: Supports existing applications through [[DNS]] over [[HTTPS]] ([[DoH]]) queries to Pkarr servers, ensuring broad compatibility.
13+
- **Compatibility with Existing Applications**: Supports existing applications through [[DNS]] over [[HTTPS]] ([[DoH]]) queries to PKARR servers, ensuring broad compatibility.
1414

1515
## How It Works
1616

1717
1. **Publishing Records**: To publish resource records for a key, create a small encoded [[DNS]] packet (<= 1000 bytes), sign it, and publish it on the DHT. This can be done directly or through a relay if necessary.
1818
2. **Resolving Records**: To find resources associated with a key, applications can query the [[DHT]] directly or through a relay, verifying the signature themselves.
19-
3. **Fallback for Existing Applications**: Applications unaware of Pkarr can make normal [[DNS]] Queries over [[HTTPS]] (DoH) to Pkarr servers, ensuring accessibility.
20-
4. **Caching and Republishing**: Both clients and Pkarr servers cache records extensively to improve scalability. The [[DHT]] drops records after a few hours, necessitating periodic republishing to keep records alive.
19+
3. **Fallback for Existing Applications**: Applications unaware of PKARR can make normal [[DNS]] Queries over [[HTTPS]] (DoH) to PKARR servers, ensuring accessibility.
20+
4. **Caching and Republishing**: Both clients and PKARR servers cache records extensively to improve scalability. The [[DHT]] drops records after a few hours, necessitating periodic republishing to keep records alive.
2121

22-
For more technical details on Pkarr's architecture and how it works, refer to the [[4.Architecture|architecture]] note.
22+
For more technical details on PKARR's architecture and how it works, refer to the [[4.Architecture|architecture]] note.
2323

2424
## Getting Started
2525

26-
[To start using Pkarr](2.Getting%20Started%20with%20Pkarr.md), you can visit the [web app demo](https://app.pkarr.org) or explore the Rust examples provided in [Pkarr repository](https://github.com/Nuhvi/pkarr/).
26+
[To start using PKARR](2.Getting%20Started%20with%20PKARR.md), you can visit the [web app demo](https://app.pkarr.org) or explore the Rust examples provided in [PKARR repository](https://github.com/Nuhvi/pkarr/).

Pubky Core/Pkarr/1.Why Pkarr?.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This note explores the motivation behind Pkarr, addressing the challenges of distributed semantics, databases, and discovery.
1+
This note explores the motivation behind [[0.Introduction|PKARR]], addressing the challenges of distributed semantics, databases, and discovery.
22

33
In pursuit of a sovereign, distributed, and open web, we identify three challenges:
44

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This guide will help you understand how to publish and resolve resource records using [[0.Introduction|pkarr]].
1+
This guide will help you understand how to publish and resolve resource records using [[0.Introduction|PKARR]].
22

33
## Publishing Resource Records
44

@@ -10,12 +10,12 @@ To resolve some key's resources, applications can query the [[DHT]] directly or
1010

1111
## DNS Queries Over HTTPS
1212

13-
Existing applications unaware of [[0.Introduction|pkarr]] can make normal [[DNS]] Queries over [[HTTPS]] ([[DoH]]) to [[0.Introduction|pkarr]] servers.
13+
Existing applications unaware of [[0.Introduction|PKARR]] can make normal [[DNS]] Queries over [[HTTPS]] ([[DoH]]) to [[0.Introduction|PKARR]] servers.
1414

1515
## Caching and Scalability
1616

17-
Clients and [[0.Introduction|pkarr]] servers cache records extensively to minimize [[DHT]] traffic and improve scalability. The [[DHT]] drops records after a few hours, so it's important to republish records periodically.
17+
Clients and [[0.Introduction|PKARR]] servers cache records extensively to minimize [[DHT]] traffic and improve scalability. The [[DHT]] drops records after a few hours, so it's important to republish records periodically.
1818

1919
## Next Steps
2020

21-
For more technical details on [[0.Introduction|pkarr]]'s architecture and how it works, refer to the [[4.Architecture|architecture]] note.
21+
For more technical details on [[0.Introduction|PKARR]]'s architecture and how it works, refer to the [[4.Architecture|architecture]] note.

Pubky Core/Pkarr/3.Expectations.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
Understanding the expectations and limitations of [[0.Introduction|pkarr]] is crucial for effective use. This note outlines what [[0.Introduction|pkarr]] is not and what users should expect.
1+
Understanding the expectations and limitations of [[0.Introduction|PKARR]] is crucial for effective use. This note outlines what [[0.Introduction|PKARR]] is not and what users should expect.
22

33
## Not a Storage Platform
44

5-
[[0.Introduction|pkarr]] is not a storage platform. Records are ephemeral and need to be refreshed regularly to remain on the DHT.
5+
[[0.Introduction|PKARR]] is not a storage platform. Records are ephemeral and need to be refreshed regularly to remain on the DHT.
66

77
## Not a Real-time Communication Medium
88

9-
[[0.Introduction|pkarr]] is not designed for real-time communication. It is optimized for infrequent updates and heavy caching to reduce traffic.
9+
[[0.Introduction|PKARR]] is not designed for real-time communication. It is optimized for infrequent updates and heavy caching to reduce traffic.
1010

1111
## Rate Limiting and Proof of Work
1212

@@ -18,4 +18,4 @@ Records are heavily cached, and updates might take some time to propagate. In ca
1818

1919
## Next Steps
2020

21-
For a deeper understanding of why [[0.Introduction|pkarr]] was created and its motivation, refer to the [[1.Why Pkarr?|why pkarr?]] note.
21+
For a deeper understanding of why [[0.Introduction|PKARR]] was created and its motivation, refer to the [[1.Why PKARR?|why PKARR?]] note.

Pubky Core/Pkarr/4.Architecture.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
In-depth look at the architecture of [[0.Introduction|pkarr]], including its components and how they interact.
1+
In-depth look at the architecture of [[0.Introduction|PKARR]], including its components and how they interact.
22
## Components
33

44
- **Client**: Applications or users that publish or query resource records.
@@ -14,5 +14,5 @@ In-depth look at the architecture of [[0.Introduction|pkarr]], including its com
1414

1515
## Key Technologies
1616

17-
- **[[Mainline DHT]]**: Pkarr uses the Mainline [[DNS]] as its overlay network, specifically BEP44 for storing ephemeral data.
18-
- **[[DNS]] over [[HTTPS]] ([[DoH]])**: For applications unaware of Pkarr, DoH is used to resolve domains.
17+
- **[[Mainline DHT]]**: PKARR uses the Mainline [[DNS]] as its overlay network, specifically BEP44 for storing ephemeral data.
18+
- **[[DNS]] over [[HTTPS]] ([[DoH]])**: For applications unaware of PKARR, DoH is used to resolve domains.

Technologies/DoH.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DNS over HTTPS
22

3-
It is a security protocol that encrypts [[DNS]] queries and responses, enhancing privacy and security by preventing eavesdropping and tampering. In the context of [[0.Introduction|pkarr]], DoH plays a crucial role in ensuring that [[DNS]] queries made to resolve public-key addresses are secure and cannot be intercepted or manipulated by third parties.
3+
It is a security protocol that encrypts [[DNS]] queries and responses, enhancing privacy and security by preventing eavesdropping and tampering. In the context of [[0.Introduction|PKARR]], DoH plays a crucial role in ensuring that [[DNS]] queries made to resolve public-key addresses are secure and cannot be intercepted or manipulated by third parties.
44

55
### Key Points about DoH
66

images/pubky-arch.png

90.1 KB
Loading

images/pubky-core.png

30.8 KB
Loading

index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Welcome to the Pubky Knowledge Base
22

3-
This is a knowledge base for the Pubky platform, which includes [[Pubky Core/Introduction|Pubky Core]], [[Pubky Core/Pkarr/0.Introduction|Pkarr]] and [[Pubky App/Introduction|Pubky App]]. These documents are a work in progress, much like Pubky's protocols and applications!
3+
This is a knowledge base for the Pubky platform, which includes [[Pubky Core/Introduction|Pubky Core]], [[Pubky Core/Pkarr/0.Introduction|PKARR]] and [[Pubky App/Introduction|Pubky App]]. These documents are a work in progress, much like Pubky's protocols and applications!
44

55
# What is Pubky?
66

77
Pubky attempts to unlock the web by realizing our vision for a key-based, self-regulating web that puts users in control.
88

9-
So far, Pubky does this by combining practical decentralized routing & identity ([[Pubky Core/Pkarr/0.Introduction|Pkarr]]), with simple interoperable hosting ([[Pubky Core/Homeservers|Homeservers]]) that allow for [[Concepts/Censorship|censorship]] resistance and a [[Concepts/Credible Exit|credible exit]], as well as a publishing application, Pubky App, that facilitates the creation of a [[Concepts/Semantic Social Graph|Semantic Social Graph]], which can be used for filtering, discovery, matching and coordination.
9+
So far, Pubky does this by combining practical decentralized routing & identity ([[Pubky Core/Pkarr/0.Introduction|PKARR]]), with simple interoperable hosting ([[Pubky Core/Homeservers|Homeservers]]) that allow for [[Concepts/Censorship|censorship]] resistance and a [[Concepts/Credible Exit|credible exit]], as well as a publishing application, Pubky App, that facilitates the creation of a [[Concepts/Semantic Social Graph|Semantic Social Graph]], which can be used for filtering, discovery, matching and coordination.
1010

1111
Learn more about the overall vision here: [[The vision of Pubky|The Vision of Pubky]]
1212

0 commit comments

Comments
 (0)