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 mdbook-admonish@1.18.0 --locked
cargo install mdbook-katex@0.9.0 --locked
cargo install mdbook-i18n-helpers --locked
mdbook serve

Using translated versions

If there is a translated resource in po/ directory, it can be specified through the MDBOOK_BOOK__LANGUAGE environment variable. For example, to build or serve the Chinese translation:

MDBOOK_BOOK__LANGUAGE=zh_CN mdbook build
MDBOOK_BOOK__LANGUAGE=zh_CN mdbook serve

Please consult TRANSLATING.md for further information on how to create and maintain translations.

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).