# Pinner.xyz

> Privacy-focused storage without the infrastructure.

## Docs

- [Authentication](/authentication): Pinner uses API tokens for authentication.
- [Installation](/installation)
- [Quickstart](/quickstart): Get started with Pinner in 5 minutes. But first, a quick overview...
- [Pinata Adapter Reference](/sdk/adapters): The Pinata adapter provides drop-in compatibility with the Pinata SDK, allowing you to migrate with minimal code changes.
- [SDK Configuration](/sdk/configuration): Configure the SDK with custom options.
- [Error Handling](/sdk/errors): Handle errors that may occur during SDK operations.
- [SDK Getting Started](/sdk/getting-started): Install and initialize the Pinner SDK.
- [Pin Management](/sdk/pins): Manage content pins using the Pinner SDK.
- [Progress Tracking](/sdk/progress): Monitor the progress of uploads and pin operations.
- [Upload Files](/sdk/upload): Upload various content types to Pinner.
- [SDK Utilities](/sdk/utilities): Utility functions for stream manipulation, type guards, and CAR preprocessing.
- [Pinata Migration Examples](/migration/examples): Comprehensive code examples for migrating from Pinata SDK to Pinner. See the [Migration Guide](/migration/pinata) for step-by-step instructions.
- [Migrate from Pinata](/migration/pinata): A step-by-step guide to migrate your application from Pinata SDK to Pinner.
- [Upload Your First File (3 minutes)](/guide/first-upload): **Expected output:**
- [Pinner Guides](/guide): Step-by-step tutorials. Copy, paste, adapt.
- [Migrate from Pinata](/guide/pinata-migration): Same API calls, better privacy.
- [CAR Files (Content Addressable Archive)](/concepts/car-files): A CAR (Content Addressable Archive) file is a container format for storing and transferring IPLD (InterPlanetary Linked Data) blocks. It's the standard format for packaging content-addressed data in IPFS ecosystems.
- [CIDs (Content Identifiers)](/concepts/cids): A CID is a self-describing content-addressed identifier used to address content in distributed systems like IPFS.
- [Pin Lifecycle](/concepts/pin-lifecycle): Content goes through several states when pinned to Pinner.
- [Quotas & Limits](/concepts/quotas): Pinner enforces usage limits to ensure fair access for all users.
- [CLI Authentication](/cli/auth): Manage authentication from the command line.
- [Command Overview](/cli/commands): The Pinner CLI provides commands for all operations.
- [Shell Completions](/cli/completion): Enable tab completion for the Pinner CLI in your shell.
- [CLI Config](/cli/config): Manage CLI configuration.
- [CLI Doctor](/cli/doctor): Run diagnostic checks to troubleshoot issues.
- [CLI Global Flags](/cli/flags): Flags available on all commands.
- [CLI Getting Started](/cli/getting-started): Install and configure the Pinner CLI.
- [CLI List](/cli/list): List your pinned content.
- [CLI Metadata](/cli/metadata): Manage metadata for pinned content.
- [CLI Pin](/cli/pin): Pin existing content by CID.
- [CLI Setup](/cli/setup): Use the interactive setup wizard to configure the CLI.
- [CLI Status](/cli/status): Check the status of pinned content.
- [Troubleshooting](/cli/troubleshooting): Common issues and solutions for the Pinner CLI. If you can't find your issue here, run `pinner doctor` to gather diagnostic information.
- [CLI Unpin](/cli/unpin): Remove a pin from content.
- [CLI Upload](/cli/upload): Upload files and directories to IPFS via the Pinner.xyz service.
- [Archive Uploads](/api/archives): Upload archive files (ZIP, tar, tar.gz, etc.) with the `archive_mode` parameter to control how archives are processed.
- [Authentication](/api/authentication): All API requests require authentication using Bearer tokens.
- [Large File Uploads (TUS)](/api/large-uploads): Upload files of any size using the [TUS](https://tus.io/) resumable upload protocol. TUS allows you to resume interrupted uploads and track progress.
- [Upload Limits](/api/limits): Retrieve the maximum allowed upload size for your account.
- [Small File Uploads (POST)](/api/small-uploads): Upload files up to 100MB using simple HTTP POST with multipart/form-data.
- [API Documentation](/api/swagger): Each service in the Pinner ecosystem provides self-hosted OpenAPI (Swagger) documentation.
- [Frequently Asked Questions](/about/faq): Pinning tells IPFS to keep a copy of content on a specific node. Without pinning, IPFS may garbage collect content that's not frequently accessed. Pinner ensures your important content is always available.
- [What is Pinner?](/about): **Pinner = Pinning** (keeping content available on decentralized networks)