A modern and privacy-friendly platform to establish your decentralized online identity
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 2d78d29292
Release 3.3.1
5 months ago
.gitea Improve issue template 5 months ago
api/v0 Migrate to ES6 modules 6 months ago
content Remove guides and additional content 9 months ago
routes Migrate to ES6 modules 6 months ago
server Fix exports 5 months ago
src Fix paths 5 months ago
static/img Remove static files 6 months ago
static-src Restructure static files and main script file 5 months ago
test Add initial tests 5 months ago
views Update year 5 months ago
.drone.yml Fix latest tag for docker container 5 months ago
.envrc Adding quick dev setup using nix and direnv 1 year ago
.gitignore Ignore entire static folder 5 months ago
.licenseignore Optimize docker builds 6 months ago
CHANGELOG.md Release 3.3.1 5 months ago
CODE_OF_CONDUCT.md Fix contact method 2 years ago
Dockerfile Fix docker builds 5 months ago
LICENSE Update LICENSE 2 years ago
LICENSE.HEADER Add regex to license check 6 months ago
README.md Adding quick dev setup using nix and direnv 1 year ago
docker-compose.yaml Add domain env variable 5 months ago
license-checker-config.json Add regex to license check 6 months ago
nodemon.json WIP Integrating redesign 1 year ago
package.json Release 3.3.1 5 months ago
shell.nix Adding quick dev setup using nix and direnv 1 year ago
template.env Add highlights 1 year ago
webpack.config.js Allow webpack to copy static files 5 months ago
yarn.lock Allow webpack to copy static files 5 months 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