Skip to content

Commit 4995ba7

Browse files
committed
Revamp docs landing page: restructured layout, restored links, added encryption-at-rest detail
1 parent 6f1404d commit 4995ba7

File tree

1 file changed

+40
-87
lines changed

1 file changed

+40
-87
lines changed

docs/README.md

Lines changed: 40 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,122 +1,75 @@
1-
---
2-
slug: /
3-
displayed_sidebar: docs
4-
---
1+
# **Welcome to the Polykey documentation**
52

6-
# Polykey Documentation
3+
* [Tutorials:](https://polykey.com/docs/tutorials) Step-by-step guides that introduce Polykey through practical outcomes.
74

8-
Welcome to the Polykey documentation.
5+
* [How-To Guides:](https://polykey.com/docs/how-to-guides) Short, targeted instructions for achieving specific use-cases, assuming prior familiarity.
96

10-
- [Tutorials](./tutorials) - these are a series of steps to introduce Polykey to
11-
new beginners to achieve a practical outcome
12-
- [How-To Guides](/docs/how-to-guides) - these are short guides on how to
13-
achieve a specific use-case which makes assumptions on the reader
14-
- [Theory](./theory/) - these are important for understanding the "why" of
15-
Polykey
16-
- [Reference](./reference/) - these are useful when you need remember how to use
17-
a particular command or function
7+
* [Theory:](https://polykey.com/docs/theory/) Conceptual foundations explaining the rationale behind Polykey.
8+
9+
* [Reference:](https://polykey.com/docs/reference/) Lookup documentation for commands, functions, and technical specifications.
1810

1911
## Introduction
2012

21-
Polykey helps yourself, teams and software agents to manage and share secrets in
22-
a secure and easy-to-use manner.
23-
24-
- Usable for the average person, you don't need to be a cryptography or
25-
cybersecurity expert to securely manage and share secrets.
26-
- Can be integrated into software for automation of secret workflows.
27-
- Unifies the workflow between interactive password management and
28-
infrastructure key management.
29-
- Decentralized and local-first software that does not hand over your secrets to
30-
the cloud. You maintain sovereignty over your secrets on your devices.
31-
- Easily backup and synchronise your secrets across all your devices: desktop,
32-
mobile or server.
33-
- End to end encryption for all network communication.
34-
- All data is encrypted at rest, thus preventing compromise even if devices are
35-
lost or stolen.
36-
37-
PolyKey is an open-source decentralised peer to peer secrets management system.
38-
It provides a software agent that runs on your device locally. Each agent
39-
process is a node in the Polykey peer to peer network. This agent manages your
40-
secret data and is capable of sharing secrets with other trusted Polykey agents.
41-
The secret data can be placed inside any directory on your computer including on
42-
USB storage.
13+
Polykey helps individuals, teams, and software agents manage and share secrets securely and intuitively.
4314

44-
## Features
15+
* **User-Friendly:** Designed for everyday users, with no need to be a cryptography or cybersecurity expert.
4516

46-
## Features
17+
* **Automation-Ready:** Integrates into software workflows for automated secret handling.
4718

48-
Polykey is designed to offer a robust, decentralized secrets management experience. Key features include:
19+
* **Unified Secrets Management:** Bridges the gap between personal password management and infrastructure-level key handling.
4920

50-
- **Decentralized & Local-First:**
51-
Polykey operates locally on your device in a peer-to-peer network, ensuring your secrets remain under your control without reliance on centralized cloud services.
21+
* **Decentralized and Local-First:** Your secrets never leave your device unless you choose to share them.
5222

53-
- **State-of-the-Art Cryptography:**
54-
Utilizes modern encryption protocols such as XChaCha20-Poly1305 for secure symmetric encryption, complemented by secure key exchange (X25519) and digital signatures (Ed25519), providing both confidentiality and data integrity.
23+
* **Seamless Synchronization:** Backup and sync secrets across desktops, mobile devices, and servers.
5524

56-
- **Secure Vault Architecture:**
57-
Secrets are organized into fully encrypted, version-controlled vaults that function like a secure, virtual filesystem - enabling safe storage, backup, and sharing with trusted peers.
25+
* **Comprehensive Encryption:** All data is end-to-end encrypted in transit and encrypted at rest.
5826

59-
- **Gestalt Identity Model:**
60-
Employs a unique decentralized identity system where multiple digital identities combine to form a Gestalt Identity, ensuring secure and trusted secret sharing across the network.
27+
Polykey is an open-source, peer-to-peer secrets management system. Each Polykey agent runs locally as a node in the network, managing secrets and enabling sharing with trusted peers. Secrets are stored within encrypted vaults and can be placed anywhere on your system, including external storage like USB drives.
6128

62-
- **Seamless Integration & Automation:**
63-
Designed for both interactive use and automated workflows, Polykey easily integrates into existing systems for streamlined secret management and operational efficiency.
29+
## Features
6430

65-
- **Cross-Platform & Open-Source:**
66-
As an open-source solution, Polykey is available on multiple platforms and benefits from community contributions, ensuring transparency and continuous improvement.
31+
Polykey delivers robust, decentralized secrets management through the following capabilities:
6732

68-
- **Future-Proof Security:**
69-
With ongoing developments, Polykey is actively exploring post-quantum cryptography and other advanced security measures to keep pace with emerging threats.
33+
* **Decentralized & Local-First:** Operates entirely on your device in a peer-to-peer network, giving you full control over your secrets.
7034

71-
## Principles
35+
* **State-of-the-Art Cryptography:** Employs XChaCha20-Poly1305 for encryption, X25519 for key exchange, and Ed25519 for signatures, ensuring confidentiality and integrity.
7236

73-
There are 2 main concepts to understand in Polykey:
37+
* **Secure Vault Architecture:** Secrets are organized into fully encrypted, version-controlled vaults that function like a secure, virtual filesystem, enabling safe storage, backup, and sharing with trusted peers. Data remains encrypted at rest, even when the Polykey agent is not running. It is only decrypted when the agent is launched and the user authenticates.
7438

75-
- Secrets Management
76-
- Decentralized Trust
39+
* **Gestalt Identity Model:** Aggregates multiple digital identities into a unified, trusted representation to facilitate secure sharing.
7740

78-
### Secrets Management
41+
* **Integration & Automation:** Works interactively or via CLI integration for seamless inclusion in CI/CD pipelines and system workflows.
7942

80-
Polykey was built from the ground up to focus on secrets management.
43+
* **Cross-Platform & Open Source:** Actively maintained, open-source, and operable across multiple environments.
44+
45+
* **Forward-Looking Security:** Investigating post-quantum cryptography and advanced protective mechanisms to stay ahead of evolving threats.
46+
47+
## Core Concepts
48+
49+
### Secrets Management
8150

82-
Secrets can be any kind of data that enables some sort of capability in the
83-
physical or virtual world.
51+
Polykey was purpose-built for secrets management: any data that enables capability.
8452

85-
The world is full of secrets. For example, a password is a secret that enables
86-
you to login to a website. A private key is a secret that enables you to sign
87-
and verify some data. A symmetric key is a secret that enables you to encrypt
88-
and decrypt some data. A token is a secret that enables software agents and
89-
machines to authenticate to remote services. A credit card is a secret that
90-
enables payments.
53+
* **Passwords** for authentication
9154

92-
Polykey is designed to manage all kinds of secrets. It is not limited to
93-
passwords or keys.
55+
* **Private Keys** for signing or decryption
9456

95-
For this reason, we think of secrets as "capabilities".
57+
* **Tokens** for machine-to-service authentication
9658

97-
All secrets are put into vaults. Each vault is a persistent, fully encrypted
98-
virtual filesystem with automatic version history. Vaults can be shared with
99-
other Polykey agents.
59+
* **Credit Card Info** for payments
10060

101-
Polykey's secrets management system provides users with secure communication and
102-
secure computation.
61+
All secrets are stored in encrypted vaults with automatic versioning. Vaults can be shared securely with other Polykey agents. Secrets are treated as capabilities, or elements that grant power in both digital and physical systems.
10362

10463
### Decentralized Trust
10564

106-
Sharing secrets depends on secure communications. Secure communications depends
107-
on trusted identities.
65+
Secret sharing relies on secure communications, which require trusted identities. Polykey introduces Gestalt Identity:
10866

109-
Polykey introduces a concept called "Gestalt Identity".
67+
A **Gestalt Identity** is a collection of digital identities (e.g., social profiles, Polykey nodes) representing the same person or agent.
11068

111-
A Gestalt Identity is a collection of digital identities (i.e. social media
112-
profiles and Polykey nodes) that all represent the same entity.
69+
* When a Polykey agent starts, it begins with a single-node gestalt.
11370

114-
When you start a Polykey agent, it immediately forms its own gestalt with the
115-
Polykey node as its only identity. Link up your digital identities to the node
116-
in order to expand your gestalt.
71+
* Users can link other identities to expand trust.
11772

118-
As you deploy more Polykey agents, you can join existing gestalts.
73+
* Gestalts allow others to verify and trust your identity when sharing secrets.
11974

120-
Your gestalt is how other users are able to share secrets with a trusted
121-
identity. Your identity is the sum of the reputation of all your digital
122-
identities that are part of the gestalt.
75+
Trust in Polykey is compositional, built from the integrity of all linked identities in your gestalt.

0 commit comments

Comments
 (0)