32 lines
1.4 KiB
Markdown
32 lines
1.4 KiB
Markdown
# nix-decred
|
|
|
|
nix-decred is a collection of Nix packages and NixOS modules, inspired by [nix-bitcoin](https://github.com/fort-nix/nix-bitcoin).
|
|
|
|
Overview
|
|
---
|
|
While nix-decred is used in production today, it is considered experimental.
|
|
|
|
nix-decred nodes can be deployed on dedicated hardware, virtual machines or containers.
|
|
The Nix packages and NixOS modules can be used independently and combined freely.
|
|
|
|
nix-decred is built on top of Nix and [NixOS](https://nixos.org/) which provide powerful abstractions to keep it highly customizable and maintainable. Running nix-decred currently requires previous experience with the Nix ecosystem, as no support is provided.
|
|
|
|
Security Considerations
|
|
---
|
|
Using this flake could be dangerous, as it provides the hashes for the software you'll be running.
|
|
|
|
If you want to use this today, the sane way would be to fork the project, review the codebase, and then review and merge all future changes as necessary. If you're familiar with nix, forking should still be faster than writing the packages and modules from scratch yourself.
|
|
|
|
The git server for this project runs on a shared virtual server, so don't trust unsigned or unverified messages.
|
|
|
|
Service Module Notes
|
|
---
|
|
- [bisonw](docs/bisonw.md)
|
|
- [dcrd](docs/dcrd.md)
|
|
- [dcrwallet](docs/dcrwallet.md)
|
|
- [vspd](docs/vspd.md)
|
|
|
|
Support
|
|
---
|
|
No support is provided. If you have ideas for improvement, general feedback, or a PR, you can tag @stakeynet on the Decred matrix channels.
|