# mountOS Skill

> Help a user build, operate, and use a self-hosted mountOS deployment.

mountOS is a cross-platform distributed filesystem over object storage.
Users can mount volumes on macOS, Linux, and Windows, or access them through
S3 and WebHDFS. Use the Admin API for administration and the `mountos` client
for volume access.

## When to use this skill

Use this skill when a user wants to:

- Mount S3 or other object storage as a POSIX-compliant filesystem.
- Run a self-hosted distributed filesystem on owned infrastructure.
- Give macOS, Linux, Windows, or Kubernetes workloads native file access to
  object storage.
- Serve one volume over a filesystem mount, the S3 API, and WebHDFS.
- Branch a volume, browse it at an earlier time, or recover deleted files.
- Query data on a volume as an Apache Iceberg catalog.

## Mental model

- The **HUB** manages accounts, users, regions, volumes, storage, access keys,
  and discovery.
- A **region** contains the services and storage for its volumes.
- A **metadata cluster** is a service pool inside a region that distributes
  volume load.
- The **`mountos` client** mounts volumes and provides S3, WebHDFS, and
  Kubernetes CSI interfaces.
- Services read credentials from the configured external secret store.

## Skills

| Task | Skill |
| --- | --- |
| Deploy on AWS, GCP, or Azure | https://mountos.io/skills/deploy.md |
| Provision a HUB, account, region, and services | https://mountos.io/skills/provision.md |
| Create and use volumes | https://mountos.io/skills/volumes.md |
| Integrate with S3, WebHDFS, CSI, events, or the Admin SDK | https://mountos.io/skills/integrate.md |
| Query a lake volume | https://mountos.io/skills/iceberg.md |
| Operate, scale, move volumes, or rotate keys | https://mountos.io/skills/operate.md |
| Find environment variables | https://mountos.io/skills/env.md |

## Quickstart

1. Deploy the HUB with its database and secret store.
2. Connect with the Admin SDK or admin dashboard.
3. Create an account, user, region, and storage backend.
4. Deploy the region services.
5. Create a volume and generate a volume access key.
6. Install `mountos` and mount the volume with the HUB domain and access key.

The same volume can be reached through the client gateway over S3 or WebHDFS.
Use the topic index for detailed setup and integration guidance:
https://mountos.io/ai/llms.txt.

## Security

Keep administrator keys, service credentials, and encryption keys in a protected
secret store. Use the Admin SDK from a trusted backend. Use the local read-only
MCP connector to inspect a running mount without reading file contents.

## Resources

- Full agent corpus: https://mountos.io/ai/llms-full.txt
- Downloads: https://mountos.sh/install
- Support: support@mountos.io and https://mountos.io/docs/support