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 5ef292a482
Clarify local dev steps
1 week ago
content Adapt owncast documentation to new style 1 week ago
routes Update year 1 week ago
server Update year 1 week ago
static Improve code style 1 week ago
views Link to owncast documentation 1 week ago
.drone.yml Remove server deployment from CI/CD 3 months ago
.gitignore Update year 1 week ago
.licenseignore Update licenseignore 1 week ago
CHANGELOG.md Release 2.4.1 1 week ago
CODE_OF_CONDUCT.md Fix contact method 5 months ago
Dockerfile Switch to yarn 1 month ago
LICENSE Update LICENSE 5 months ago
LICENSE.HEADER Update year 1 week ago
README.md Clarify local dev steps 1 week ago
favicon.svg Update favicon 6 months ago
index.js Update year 1 week ago
license-checker-config.json Update PHP comment style 5 months ago
package.json Release 2.4.1 1 week ago
robots.txt Add robots.txt 1 week ago
template.env Fix template DOMAIN name 5 months ago
yarn.lock Update deps 1 week 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.

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