Verifying online identity with cryptography
Find a file
2022-03-15 13:22:16 +01:00
api/v0 Migrate to ES6 modules 2022-02-27 22:59:17 +01:00
content Remove guides and additional content 2021-11-07 16:14:21 +01:00
routes Migrate to ES6 modules 2022-02-27 22:59:17 +01:00
server Fix exports 2022-03-03 16:25:34 +01:00
static/img Remove static files 2022-02-25 13:57:50 +01:00
static-src Make hostname configurable 2022-03-03 16:00:53 +01:00
test Add initial tests 2022-03-03 16:25:49 +01:00
views Add links to community forum 2022-03-15 13:22:16 +01:00
.drone.yml Make drone react to main branch pushes 2021-05-04 18:52:55 +02:00
.envrc Adding quick dev setup using nix and direnv 2021-06-27 11:20:00 +03:00
.gitignore Optimize docker builds 2022-02-27 19:52:06 +01:00
.licenseignore Optimize docker builds 2022-02-27 19:52:06 +01:00
CHANGELOG.md Add links to community forum 2022-03-15 13:22:16 +01:00
CODE_OF_CONDUCT.md Fix contact method 2020-08-12 12:01:30 +02:00
Dockerfile Optimize docker builds 2022-02-27 19:52:06 +01:00
favicon.svg Update favicon 2021-05-04 14:27:37 +02:00
index.js Migrate to ES6 modules 2022-02-27 22:59:17 +01:00
LICENSE Update LICENSE 2020-07-30 11:30:14 +02:00
license-checker-config.json Add regex to license check 2022-02-25 11:44:31 +01:00
LICENSE.HEADER Add regex to license check 2022-02-25 11:44:31 +01:00
nodemon.json WIP Integrating redesign 2021-03-01 15:01:34 +01:00
package.json Add initial tests 2022-03-03 16:25:49 +01:00
README.md Adding quick dev setup using nix and direnv 2021-06-27 11:20:00 +03:00
robots.txt Add robots.txt 2021-01-10 18:23:45 +01:00
shell.nix Adding quick dev setup using nix and direnv 2021-06-27 11:20:00 +03:00
template.env Add highlights 2021-06-21 11:36:21 +02:00
webpack.config.js Migrate to ES6 modules 2022-02-27 22:59:17 +01:00
yarn.lock Add initial tests 2022-03-03 16:25:49 +01:00

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