178bae142e
* switch branch * moved files around * validate webdav path in requests * async and sync writer * implemented file read and write via disk * cleaning up * clippy and fmt * cleanup 1 * last cleanup * fmt * test concurrent read/write * cleanup3 * cleanup3 * added log in case of a join error * removed pub from max_chunk_size() * fmt and clippy * fixed test * fmt * fixed main merge errors
An open protocol for per-public-key backends for censorship resistant web applications.
The Web, long centralized, must decentralize; Long decentralized, must centralize.
Overview
Pubky-core combines a censorship resistant public-key based alternative to DNS with conventional, tried and tested web technologies, to keep users in control of their identities and data, while enabling developers to build software with as much availability as web apps, without the costs of managing a central database.
Features
- Public key based authentication.
- Public key based 3rd party authorization.
- Key-value store through PUT/GET/DELETE HTTP API + pagination.
Getting started
This repository contains a Homeserver, and a Client (both Rust and JS wasm bindings).
You can a run a local homeserver using cargo run with more instructions in the README.
Check the Examples directory for small feature-focesed examples of how to use the Pubky client.
JavaScript
If you prefer to use JavaScript in NodeJs/Browser or any runtime with Wasm support, you can either install from npm @synonymdev/pubky
or build the bindings yourself:
cd pubky-client/pkg
npm i
npm run build
Testing
There are unit tests for the JavaScript bindings in both NodeJs and headless web browser, but first you need to run a local temporary Homeserver
npm run testnet
Then in a different terminal window:
npm test
Docker
An alternative way to start tinkering with Pubky is to build an isolated container and run it locally. Here is an example command how to build an image:
docker build --build-arg TARGETARCH=x86_64 -t pubky:core .
A command for running it in an isolated environment with log output:
docker run -it pubky:core
Additional optional arguments can be used to run it in the background, but the most important is --network=host, which allows the container to access the network and provides an admin endpoint accessible from the host machine. Please refer to the Docker documentation for more detailed options.