A modern and privacy-friendly platform to establish your decentralized online identity https://keyoxide.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Yarmo Mackenbach b666f281e4
Improve WKD instructions
4 weeks ago
api/v0 Fix verification options in API 1 month ago
content Remove guides and additional content 1 month ago
routes Remove guides and additional content 1 month ago
server Add openpgp4fpr to keyData object 2 months ago
static Minor update to styles and content 1 month ago
views Improve WKD instructions 4 weeks ago
.drone.yml Make drone react to main branch pushes 7 months ago
.envrc Adding quick dev setup using nix and direnv 6 months ago
.gitignore Adding quick dev setup using nix and direnv 6 months ago
.licenseignore Update licenseignore 11 months ago
CHANGELOG.md Release 3.2.0 1 month ago
CODE_OF_CONDUCT.md Fix contact method 1 year ago
Dockerfile Improve docker builds 2 months ago
LICENSE Update LICENSE 1 year ago
LICENSE.HEADER Update year 11 months ago
README.md Adding quick dev setup using nix and direnv 6 months ago
favicon.svg Update favicon 7 months ago
index.js Add alpha API 2 months ago
license-checker-config.json Update PHP comment style 1 year ago
nodemon.json WIP Integrating redesign 9 months ago
package.json Release 3.2.0 1 month ago
robots.txt Add robots.txt 11 months ago
shell.nix Adding quick dev setup using nix and direnv 6 months ago
template.env Add highlights 6 months ago
yarn.lock Remove markdown dependencies 1 month ago

README.md

Keyoxide

Drone (self-hosted) with branch License Docker Image Version (latest semver) Docker Pulls Mastodon Follow Liberapay receiving

Keyoxide is a modern, secure and decentralized platform to prove your online identity.

Self-hosting

Self-hosting Keyoxide is an important aspect of the project. Users need to trust the Keyoxide instance they're using to reliably verify identities. Making Keyoxide itself decentralized means no one needs to trust a central server. If a friend or family member is hosting a Keyoxide instance, it becomes much easier to trust the instance!

Docker

The Docker container allows you to easily self-host the Keyoxide project. To get started, simply run:

docker run -d -p 3000:3000 keyoxide/keyoxide:stable

Keyoxide will now be available by visiting http://localhost:3000.

Contributing

Anyone can contribute if they'd like! No need to be a programmer or technically-oriented for that matter.

Contributing to Keyoxide can happen in many forms:

  • Finding and reporting bugs
  • Suggesting new features
  • Improving documentation
  • Writing code to fix bugs and features
  • Promoting decentralized identity and web3.0

Please note that this project has a Code of Conduct that all contributors agree to abide when participating.

Local development

To run Keyoxide locally on your machine for development:

  • install either
    • NodeJS
      • directly from their website, or
      • using nvm: nvm install --lts; nvm use --lts
    • yarn
    • nix with direnv will install yarn and other dependencies.
  • install dependencies with npm install or yarn
  • run the server with npm dev or yarn dev

Keyoxide will now be available at https://localhost:3000