Verifying online identity with cryptography
Find a file
Yarmo Mackenbach d11b13ab27
Improve message
2021-05-02 13:06:18 +02:00
content Update gitlab guide 2021-04-01 22:50:03 +02:00
routes Improve layout and rendering of profiles 2021-05-02 12:49:52 +02:00
server Improve layout and rendering of profiles 2021-05-02 12:49:52 +02:00
static Improve message 2021-05-02 13:06:18 +02:00
views Improve layout and rendering of profiles 2021-05-02 12:49:52 +02:00
.drone.yml Remove server deployment from CI/CD 2020-10-23 18:45:23 +02:00
.gitignore Update year 2021-01-11 14:58:47 +01:00
.licenseignore Update licenseignore 2021-01-11 14:59:05 +01:00
CHANGELOG.md Release 2.5.0 2021-03-09 12:36:08 +01:00
CODE_OF_CONDUCT.md Fix contact method 2020-08-12 12:01:30 +02:00
Dockerfile Switch to yarn 2020-12-11 11:11:03 +01:00
favicon.svg Update favicon 2020-07-16 08:42:20 +02:00
index.js Improve layout and rendering of profiles 2021-05-02 12:49:52 +02:00
LICENSE Update LICENSE 2020-07-30 11:30:14 +02:00
license-checker-config.json Update PHP comment style 2020-07-31 00:34:09 +02:00
LICENSE.HEADER Update year 2021-01-11 14:58:47 +01:00
nodemon.json WIP Integrating redesign 2021-03-01 15:01:34 +01:00
package.json Update deps 2021-05-02 12:49:03 +02:00
README.md Clarify local dev steps 2021-01-15 14:53:49 +01:00
robots.txt Add robots.txt 2021-01-10 18:23:45 +01:00
template.env Fix template DOMAIN name 2020-08-18 09:38:46 +02:00
yarn.lock Update deps 2021-05-02 12:49:03 +02:00

Keyoxide

Build Status License Docker Image Version (latest semver) Docker Pulls Mastodon Follow

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
  • 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