Skip to content

Documentation and examples for the Walrus decentralized storage system

License

Notifications You must be signed in to change notification settings

RandyPen/walrus-docs

 
 

Repository files navigation

The Walrus decentralized blob storage system

Welcome to the GitHub repository for Walrus, a decentralized storage and availability protocol designed specifically for large binary files, or "blobs". Walrus focuses on providing a robust solution for storing unstructured content on decentralized storage nodes while ensuring high availability and reliability even in the presence of Byzantine faults.

Documentation

Our documentation is available as a Walrus Site (see the documentation for further information on what this means) and on GitHub Pages; it is generated using mdBook from source files in the docs/ directory.

You can also build and access the documentation locally (assuming you have Rust installed):

cargo install mdbook
cargo install [email protected] --locked
cargo install [email protected] --locked
mdbook serve

Get help and report issues

If you have general questions or require help on how to use Walrus, please check for existing discussions. If your question is not answered yet, you can open a new discussion.

If you experience any issues or bugs, please check for existing issues and file an issue if it hasn't been reported yet. Please include the version of the walrus binary in your bug report (you can obtain it with walrus --version).

License

This project is licensed under the Apache License, Version 2.0 (LICENSE or https://www.apache.org/licenses/LICENSE-2.0).

About

Documentation and examples for the Walrus decentralized storage system

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Move 89.4%
  • CSS 10.6%