Katta Documentation

Katta: transform your S3 storage into a secure, team-friendly workspace with client-side encryption.

Official documentation site for Katta. Built with Docusaurus.

Contributing

We welcome contributions! Please read our contributing guidelines for details on how to help.

Quick Start

This repo uses pnpm (pinned via packageManager in package.json). The easiest way to get a matching version is to enable Corepack: corepack enable.

pnpm install
pnpm start

Opens dev server at http://localhost:8000 with live reload.

Structure

• docs/introduction.md, docs/concepts.md, docs/glossary.md - the pages every reader needs.
• docs/user-guide/ - User Guide - for people who use Katta.
• docs/admin-guide/ - Admin Guide - for people who administer a Katta Server.
• docs/self-hosting-guide/ - Self-Hosting Guide - for people who run one.
• docs/architecture/ - Architecture - how Katta works internally.
• docs/img/ - Resources

Scripts

pnpm build # Build static site
pnpm serve # Serve built site locally

Other scripts can be found in package.json.

Deployment

Deployed to docs.katta.cloud via GitHub Pages from the main branch.

License

This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License (CC-BY-SA 4.0).

Acknowledgements

Based on Cryptomator Docs.