Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/christopherbilg/ri2p
Rust implementation of the i2p client/server/router protocols
https://github.com/christopherbilg/ri2p
anonymity cryptography distributed encryption i2p networking p2p-clients p2p-http p2p-network rust
Last synced: about 1 month ago
JSON representation
Rust implementation of the i2p client/server/router protocols
- Host: GitHub
- URL: https://github.com/christopherbilg/ri2p
- Owner: ChristopherBilg
- License: gpl-2.0
- Created: 2022-01-01T18:01:15.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-20T11:03:53.000Z (over 1 year ago)
- Last Synced: 2023-03-04T19:22:50.464Z (over 1 year ago)
- Topics: anonymity, cryptography, distributed, encryption, i2p, networking, p2p-clients, p2p-http, p2p-network, rust
- Language: Rust
- Homepage: https://chrisbilger.com/ri2p
- Size: 296 MB
- Stars: 12
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# ri2p
Rust implementation of the i2p client/server/router protocols
## Status
## Common Commands
- `cargo build`: Builds the ri2p binary
- `cargo run`: Runs the ri2p binary
- `cargo test`: Runs all test functions, in the ./tests directory, that contain the #[test] attribute
- `cargo doc [--open]`: Builds the automatically generated ri2p Rust documentation, and optionally opens it in a web browser
- `cargo fmt`: Standard formatter for Rust codestyle
- `cargo clippy [--fix]`: Standard linter for Rust, and optionally will automatically fix linted issues
- `mdbook build`: Builds the ri2p mdbook locally
- `mdbook serve`: Serves the ri2p mdbook at http://localhost:3000, and rebuilds it on changes
## CI/CD Information
GitHub is the central CI/CD platform for the ri2p project. CI/CD will occur only when modifications are made (pull-requests) to the **master** branch.
## Additional Important Information
- [Code of Conduct Guidelines](./CODE_OF_CONDUCT.md)
- [Contributing Guidelines](./CONTRIBUTING.md)
- [Open Source License](./LICENSE.md)
- [Security (Vulnerability) Policy](./SECURITY.md)
- [Major Authors & Contributors](./AUTHORS.md)
- [Changelog (SemVer)](./CHANGELOG.md)
## Developers
If you would like to work on this project, please feel free to check the [issues](https://github.com/ChristopherBilg/ri2p/issues) for a list of the current items that we need to be worked on. If you would like to work on any of them, please contact ri2p in the [discussions](https://github.com/ChristopherBilg/ri2p/discussions) area and I will mark a task for you.
### Documentation
Developers can find documentation for ri2p in the [docs/](./docs/) directory, or hosted online at [chrisbilger.com/ri2p/](https://chrisbilger.com/ri2p/).
The `cargo doc` documentation that is automatically generated by Cargo can be viewed by running `cargo doc --open`, or hosted online at [chrisbilger.com/ri2p/doc/doc/ri2p](https://chrisbilger.com/ri2p/doc/doc/ri2p).
## Roadmap & Goals
### v1.0.0
Minimally viable i2p router.
### v2.0.0
Add in router UI. (This will probably be a web server that serves a static site and periodic data refreshes.)
### v3.0.0
Remove all unnecessary dependencies in order to reduce attack-surface. This also includes re-reading all source code in order to pinpoint potential security vulnerabilities.
### v4.0.0+
TBD. Versions at this level will be feature additions and possibly a "module" system that allows the addition of external modules for additional/enhanced features and functionality.