A modern, secure 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 ccad3aa57a Remove server deployment from CI/CD 1 month ago
content Update Mastodon guide 2 months ago
routes Fix missing env variable 2 months ago
server Remove newlines before checking equality 2 months ago
static wrapping verifyProof in try 1 month ago
views Migrate to different QR library 3 months ago
.drone.yml Remove server deployment from CI/CD 1 month ago
.gitignore Additional changes to accommodate the Node.js migration 3 months ago
.licenseignore Add Dockerfile to licenseignore 3 months ago
CHANGELOG.md Update changelog 1 month ago
CODE_OF_CONDUCT.md Fix contact method 3 months ago
Dockerfile Add Dockerfile 3 months ago
LICENSE Update LICENSE 4 months ago
LICENSE.HEADER Update LICENSE 4 months ago
README.md Change NPM script calls 3 months ago
favicon.svg Update favicon 4 months ago
index.js Add Onion URL to footer if it is defined 3 months ago
license-checker-config.json Update PHP comment style 4 months ago
package-lock.json Release 2.2.8 2 months ago
package.json Release 2.2.8 2 months ago
template.env Fix template DOMAIN name 3 months ago

README.md

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.

To add support for Twitter account verification, make a developer account, obtain a Bearer token and run:

docker run -d -p 3000:3000 -e "TWITTER_API_AUTH=XXXXXXXXXXXXXXXXXX" keyoxide/keyoxide:stable

Docker-compose

To run Keyoxide using docker-compose, add the following snippet to your docker-compose.yml:

keyoxide:
  image: keyoxide/keyoxide:stable
  ports:
    - 3000:3000
  environment:
    - TWITTER_API_AUTH=XXXXXXXXXXXXXXXXXX

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 NodeJS
    • directly from their website, or
    • using nvm: nvm install --lts; nvm use --lts
  • run the server with npm run dev

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