Update Home

2025-08-13 21:04:41 -05:00
parent 461bde7d7f
commit f27d1e5e0f

44
Home.md

@@ -1,15 +1,37 @@
## Welcome to the Repertory Wiki
# Welcome to the Repertory Wiki!
**!!PAGES UNDER CONSTRUCTION!!**
> !!PAGES UNDER ACTIVE CONSTRUCTION!!
This wiki will provide greater insight into the core of `repertory`.
This wiki is a friendly companion to the **Repertory** CLI tool—a detailed guide to help you make the most of remote mounting, S3/Sia integrations, and all things Repertory.
### Contents
---
- [Caching and Eviction](Caching-and-Eviction)
- [CLI Usage](CLI-Usage)
- [Configuration File Options](Configuration-File-Options)
- [Download Types](Download-Types)
- [File Pinning](File-Pinning)
- [HTTP REST API](HTTP-REST-API)
- [Providers](Providers)
## What's Inside
Use the links below to explore detailed sections. Each one walks you through setup, usage, and configuration—step by step.
| Section | Description |
|--------|-------------|
| [CLI Usage](CLI%20Usage) | Learn how to install Repertory, configure it, and mount your first bucket—across Linux, macOS, and Windows. |
| [Configuration File Options](Configuration%20File%20Options) | Discover every setting you can tweak, from API ports to encryption and caching. |
| [Download Types](Download%20Types) | Understand how Repertory downloads content: default cache, direct streaming, or ring-buffer—pick what's right for you. |
| [File Pinning](File%20Pinning) | Lock important files in place—pin, unpin, and check status through CLI or API. |
| [HTTP REST API](HTTP%20REST%20API) | Unlock programmatic access with endpoints for config, file operations, and system metrics—secure and well documented. |
| [Providers](Providers) | Get familiar with supported backends: S3, Sia, and how you can layer in encryption. |
---
## Need a Quick Start?
If you're just getting started, here's a fast track:
- Head to **[CLI Usage](CLI%20Usage)** to mount your storage of choice.
- Then explore **[Download Types](Download%20Types)** to optimize how your files load.
- Ready to include it in your scripts or web tools? Dive into **[HTTP REST API](HTTP%20REST%20API)** for full access.
---
## Questions or Feedback?
As you use Repertory, you might notice topics that are missing or need more detail. Please open an [Issue](https://git.fifthgrid.com/BlockStorage/repertory/issues) or drop a comment on this wiki—your insights help make it better for everyone.
Thanks for being part of the journey! Let's unlock seamless cloud-mounted drives 🗄️✨