3.8 KiB
keyoxide-web
keyoxide-web is the web client that powers keyoxide.org and which you can freely host on your own infrastructure.
Hosting keyoxide-web
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, run:
docker run -d -p 3000:3000 codeberg.org/keyoxide/keyoxide-web:latest
Keyoxide will now be available at http://localhost:3000.
More information available in the documentation.
Local development
Install node in one of the following ways:
Install the dependencies and run the server:
npm install
npm run dev
The web client will now be available at http://localhost:3000.
Using nix
Enter a development shell:
nix develop
npm run dev
Alternatively, start a local server directly:
nix develop --command bash -c "npm run dev"
Contributing
Anyone can contribute!
Developers are invited to:
- fork the repository and play around
- submit PRs to implement new features or fix bugs
If you are new to contributing to open source software, we'd love to help you! To get started, here's a list of "good first issues" that you could look into.
Everyone is invited to:
- find and report bugs
- suggesting new features
- help with translations
- improve documentation
- start using open source software and promote it
Please note that this project has a Code of Conduct that all contributors agree to abide when participating.
About the Keyoxide project
The Keyoxide project strives for a healthier internet for all and has made its efforts fully open source. Our community is open and welcoming, feel free to say hi!
Funding for the project comes from the NLnet foundation, NGI0 and the people supporting our OpenCollective. The project is grateful for all your support.