Skip to content

Commit 3eb370a

Browse files
authored
Merge pull request #45 from pubky/docs/standardize-pkarr-casing
Standardize PKARR casing (Pkarr → PKARR)
2 parents b4f3592 + a2c682c commit 3eb370a

5 files changed

Lines changed: 9 additions & 9 deletions

File tree

Explore/PubkyCore/Pkarr/1.WhyPkarr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Why Pkarr?"
2+
title: "Why PKARR?"
33
aliases:
44
- "../../Pubky-Core/Pkarr/1.Why-Pkarr"
55
---

Explore/PubkyCore/Pkarr/2.GettingStartedWithPkarr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Getting Started with Pkarr"
2+
title: "Getting Started with PKARR"
33
aliases:
44
- "../../Pubky-Core/Pkarr/2.Getting-Started-with-Pkarr"
55
---

Explore/PubkyCore/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ title: "Pubky Core"
77
- [[Explore/PubkyCore/SDK|SDK]]
88
- [[Explore/PubkyCore/Authentication|Authentication]]
99
- [[Explore/PubkyCore/Homeserver|Homeserver]]
10-
- [[Explore/PubkyCore/Pkarr/0.Introduction|Pkarr]]
10+
- [[Explore/PubkyCore/Pkarr/0.Introduction|PKARR]]

Explore/Technologies/PubkyDocker.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ aliases:
1010

1111
Pubky Docker orchestrates the following components:
1212

13-
1. **Pkarr Relay** - DHT relay for public key-addressable records
13+
1. **PKARR Relay** - DHT relay for public key-addressable records
1414
2. **Pubky Homeserver** - Decentralized data storage instance
1515
3. **Pubky Nexus** - Social media indexer and aggregator
1616
4. **Pubky App** - Social media client frontend
@@ -96,7 +96,7 @@ pubky-workspace/
9696

9797
## Stack Components
9898

99-
### 1. Pkarr Relay (Port 6882)
99+
### 1. PKARR Relay (Port 6882)
100100
Local DHT relay for public key-addressable resource records. Enables domain resolution for Pubky identities.
101101

102102
**Configuration**: `pkarr.config.toml`
@@ -168,7 +168,7 @@ The stack uses a custom Docker bridge network (`172.18.0.0/16`) with static IPs:
168168

169169
| Service | IP | External Ports |
170170
|---------|------|---------------|
171-
| Pkarr | 172.18.0.2 | 6882 |
171+
| PKARR | 172.18.0.2 | 6882 |
172172
| Nexus | 172.18.0.3 | 8080, 8081 |
173173
| Homeserver | 172.18.0.4 | 6286-6288, 15411-15412 |
174174
| Neo4j | 172.18.0.5 | 7474, 7687 |
@@ -251,7 +251,7 @@ All data is stored in the `.storage/` directory:
251251

252252
```
253253
.storage/
254-
├── pkarr/ # Pkarr relay cache
254+
├── pkarr/ # PKARR relay cache
255255
├── postgres/ # Homeserver database
256256
├── neo4j/ # Nexus graph data
257257
├── redis/ # Nexus search index
@@ -324,7 +324,7 @@ The Pubky Docker stack demonstrates the full architecture of a Pubky Social appl
324324
└──────────┬───────────┘
325325
326326
┌──────▼───────┐
327-
Pkarr Relay │
327+
PKARR Relay │
328328
│ (DHT/DNS) │
329329
└──────────────┘
330330
```

FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Yes. You'll need port forwarding or tunneling if behind NAT.
6868
Use [[PubkyExplorer|Pubky Explorer]] ([explorer.pubky.app](https://explorer.pubky.app)), a web-based file browser for public Pubky data. Enter any public key or path (e.g., `pubky://your-key/pub/pubky.app/profile.json`) to browse files and directories stored on Homeservers. Features include keyboard navigation, file preview, directory traversal, and shareable URLs.
6969

7070
**Q18. How can I run the complete Pubky stack locally for development?**
71-
Use [[PubkyDocker|Pubky Docker]], a Docker Compose orchestration that runs the entire Pubky Social stack with one command. It includes Pkarr relay, Homeserver (with PostgreSQL), Pubky Nexus (with Neo4j and Redis), and the Pubky App frontend—all preconfigured and ready to use. Clone the repository, configure `.env` for testnet or mainnet, and run `docker compose up -d`. Perfect for testing integrations, developing custom frontends, or learning how all components interact. See [[PubkyDocker|Pubky Docker]] for setup instructions.
71+
Use [[PubkyDocker|Pubky Docker]], a Docker Compose orchestration that runs the entire Pubky Social stack with one command. It includes PKARR relay, Homeserver (with PostgreSQL), Pubky Nexus (with Neo4j and Redis), and the Pubky App frontend—all preconfigured and ready to use. Clone the repository, configure `.env` for testnet or mainnet, and run `docker compose up -d`. Perfect for testing integrations, developing custom frontends, or learning how all components interact. See [[PubkyDocker|Pubky Docker]] for setup instructions.
7272

7373
**Q19. When should I use Pubky Docker vs SDK libraries?**
7474
Use the SDK libraries ([@synonymdev/pubky](https://www.npmjs.com/package/@synonymdev/pubky) for JavaScript, [pubky](https://crates.io/crates/pubky) for Rust) when building applications that interact with Pubky. Only use [[PubkyDocker|Pubky Docker]] if you need to run the full stack locally to experiment with Pubky Nexus, test custom social frontends, debug cross-component issues, or learn the complete architecture. For most app development, the SDK libraries connected to public infrastructure are simpler and faster.

0 commit comments

Comments
 (0)