|
3 | 3 | staging:[](https://gitlab.com/MatrixAI/open-source/Polykey/commits/staging) |
4 | 4 | master:[](https://gitlab.com/MatrixAI/open-source/Polykey/commits/master) |
5 | 5 |
|
6 | | -Secrets management for today's decentralized world of people, services and devices. |
| 6 | +Polykey is an open-source decentralized secrets management and sharing system. It is made for today's decentralized world of people, services and devices. |
7 | 7 |
|
8 | | -Use Polykey to share secrets (passwords, keys, tokens and certificates) with people, between teams, and across machine infrastructure |
| 8 | +* Decentralized Encrypted Storage - No storage of secrets on third parties, secrets are stored on your device and synchronised point-to-point between Polykey nodes. |
| 9 | +* Secure Peer-to-Peer Communications - Polykey bootstraps TLS keys by federating trusted social identities (e.g. GitHub). |
| 10 | +* Secure Computational Workflows - Use Polykey to share secrets (passwords, keys, tokens and certificates) with people, between teams, and across machine infrastructure. |
9 | 11 |
|
10 | | -Polykey is an open-source peer to peer decentralized application for secrets management. It is intended to be used by both humans and machines. It synthesizes a unified workflow between interactive password management and infrastructure key management. |
| 12 | +Polykey was spun out of work on a cloud orchestration platform. However it now synthesizes a unified workflow between interactive password management and infrastructure key management. |
11 | 13 |
|
12 | 14 | You have complete end-to-end control and privacy over your secrets, with no third-party data collection. |
13 | 15 |
|
14 | | -Polykey runs on distributed keynodes referred to as "nodes". Any computing system can run multiple keynodes. Each node manages one or more vaults which are encrypted filesystems with automatic version history. Vaults are shared between the nodes. |
| 16 | +Polykey runs on distributed keynodes referred to as "nodes". Any computing system can run multiple keynodes. Each node manages one or more vaults which are encrypted filesystems with automatic version history. Vaults can be shared between the nodes. |
15 | 17 |
|
16 | | -This is the core library for running PolyKey. It provides a CLI `polykey` or `pk` for interacting with the PolyKey system. |
| 18 | +This repository is the core library for Polykey. |
17 | 19 |
|
18 | | -For tutorials, how-to guides, reference and theory, see the [wiki](https://github.com/MatrixAI/Polykey/wiki). |
| 20 | +The Polykey project is split up into these main repositories: |
19 | 21 |
|
20 | | -* [Polykey](https://github.com/MatrixAI/Polykey) - Polykey core library |
21 | | -* ~[Polykey-CLI](https://github.com/MatrixAI/Polykey-CLI) - CLI of Polykey~ - TBD |
| 22 | +* [Polykey](https://github.com/MatrixAI/Polykey) - Polykey Core Library |
| 23 | +* [Polykey-CLI](https://github.com/MatrixAI/Polykey-CLI) - CLI of Polykey |
22 | 24 | * [Polykey-Desktop](https://github.com/MatrixAI/Polykey-Desktop) - Polykey Desktop (Windows, Mac, Linux) application |
23 | 25 | * [Polykey-Mobile](https://github.com/MatrixAI/Polykey-Mobile) - Polykey Mobile (iOS & Android) Application |
24 | 26 |
|
| 27 | +At the moment, the CLI is embedded in this Polykey Core Library repository. This means it provides the CLI `polykey` or `pk` for interacting with the Polykey system. In the future these will be moved to [Polykey-CLI](https://github.com/MatrixAI/Polykey-CLI). |
| 28 | + |
25 | 29 | Have a bug or a feature-request? Please submit it the issues of the relevant subproject above. |
26 | 30 |
|
27 | | -Have a question? Join our discussion board: https://github.com/MatrixAI/Polykey/discussions |
| 31 | +For tutorials, how-to guides, reference and theory, see the [docs](https://polykey.io/docs). |
28 | 32 |
|
29 | | -Want to learn the theory of secret management? Or how to start using Polykey? Check out our wiki: https://github.com/MatrixAI/Polykey/wiki |
| 33 | +Have a question? Join our [discussion board](https://github.com/MatrixAI/Polykey/discussions). |
30 | 34 |
|
31 | | -See our website https://polykey.io for more details! |
| 35 | +Our main website is https://polykey.io |
32 | 36 |
|
33 | 37 | ## Installation |
34 | 38 |
|
|
0 commit comments