# Pelican Documentation

> Documentation for the Pelican Platform.

## Docs

- [What Is the Pelican Platform?](https://docs.pelicanplatform.org/about-pelican)
- [Install Pelican](https://docs.pelicanplatform.org/install)
- [Install Pelican on CentOS, Fedora, openSUSE, Alma, or Rocky](https://docs.pelicanplatform.org/install/rhel)
- [Install Pelican on Debian or Ubuntu](https://docs.pelicanplatform.org/install/debian)
- [Install Pelican on Alpine](https://docs.pelicanplatform.org/install/alpine)
- [Install Pelican as unprivileged Linux user](https://docs.pelicanplatform.org/install/linux-binary)
- [Install Pelican on MacOS](https://docs.pelicanplatform.org/install/macos)
- [Install Pelican on Windows](https://docs.pelicanplatform.org/install/windows)
- [Install Pelican via Conda-forge](https://docs.pelicanplatform.org/install/conda)
- [Run Pelican Server with Docker Image](https://docs.pelicanplatform.org/install/docker)
- [Configuration](https://docs.pelicanplatform.org/parameters)
- [Getting Started](https://docs.pelicanplatform.org/getting-started)
- [Accessing Data](https://docs.pelicanplatform.org/getting-started/accessing-data)
- [Getting Data With Pelican](https://docs.pelicanplatform.org/getting-data-with-pelican)
- [Pelican’s Command Line Client](https://docs.pelicanplatform.org/getting-data-with-pelican/client)
- [Pelican’s Python FSSpec](https://docs.pelicanplatform.org/getting-data-with-pelican/fsspec)
- [Working with Protected Data](https://docs.pelicanplatform.org/getting-data-with-pelican/auth)
- [Federating Your Data](https://docs.pelicanplatform.org/federating-your-data)
- [Namespace Prefixes and How To Choose One](https://docs.pelicanplatform.org/federating-your-data/choosing-namespaces)
- [Federating Your Data via a Pelican Origin](https://docs.pelicanplatform.org/federating-your-data/origin)
- [S3 Storage Backend](https://docs.pelicanplatform.org/federating-your-data/s3-backend)
- [Globus Storage Backend](https://docs.pelicanplatform.org/federating-your-data/globus-backend)
- [SSH Storage Backend](https://docs.pelicanplatform.org/federating-your-data/ssh-backend)
- [Generating Tokens for Accessing Protected Objects](https://docs.pelicanplatform.org/federating-your-data/generating-tokens)
- [Operating a Pelican Federation](https://docs.pelicanplatform.org/operating-a-federation)
- [Serving a Pelican Registry](https://docs.pelicanplatform.org/operating-a-federation/registry)
- [Serving a Pelican Director](https://docs.pelicanplatform.org/operating-a-federation/director)
- [Serving a Pelican Cache](https://docs.pelicanplatform.org/operating-a-federation/cache)
- [Managing Server Downtime](https://docs.pelicanplatform.org/managing-your-server/managing-downtime)
- [Query Pelican Server Metrics via Prometheus](https://docs.pelicanplatform.org/monitoring-pelican-services/prometheus)
- [Visualize Pelican Server Metrics with Grafana](https://docs.pelicanplatform.org/monitoring-pelican-services/grafana)
- [Managing Administrator Credentials](https://docs.pelicanplatform.org/advanced-concepts/server)
- [HTCondor Plugin](https://docs.pelicanplatform.org/advanced-concepts/plugin)
- [Pelican’s Authorization System](https://docs.pelicanplatform.org/advanced-concepts/auth)
- [Getting Help](https://docs.pelicanplatform.org/getting-help)
- [Frequently Asked Questions](https://docs.pelicanplatform.org/getting-help/faqs)
- [Troubleshooting](https://docs.pelicanplatform.org/getting-help/troubleshooting)
- [API Documentation](https://docs.pelicanplatform.org/api-docs)
- [commands-reference](https://docs.pelicanplatform.org/commands-reference)
- [commands-reference/pelican](https://docs.pelicanplatform.org/commands-reference/pelican)
- [commands-reference/pelican/client-agent](https://docs.pelicanplatform.org/commands-reference/pelican/client-agent)
- [commands-reference/pelican/client-agent/start](https://docs.pelicanplatform.org/commands-reference/pelican/client-agent/start)
- [commands-reference/pelican/client-agent/status](https://docs.pelicanplatform.org/commands-reference/pelican/client-agent/status)
- [commands-reference/pelican/client-agent/stop](https://docs.pelicanplatform.org/commands-reference/pelican/client-agent/stop)
- [commands-reference/pelican/config](https://docs.pelicanplatform.org/commands-reference/pelican/config)
- [commands-reference/pelican/config/describe](https://docs.pelicanplatform.org/commands-reference/pelican/config/describe)
- [commands-reference/pelican/config/dump](https://docs.pelicanplatform.org/commands-reference/pelican/config/dump)
- [commands-reference/pelican/config/get](https://docs.pelicanplatform.org/commands-reference/pelican/config/get)
- [commands-reference/pelican/config/summary](https://docs.pelicanplatform.org/commands-reference/pelican/config/summary)
- [commands-reference/pelican/credentials](https://docs.pelicanplatform.org/commands-reference/pelican/credentials)
- [commands-reference/pelican/credentials/prefix](https://docs.pelicanplatform.org/commands-reference/pelican/credentials/prefix)
- [commands-reference/pelican/credentials/prefix/add](https://docs.pelicanplatform.org/commands-reference/pelican/credentials/prefix/add)
- [commands-reference/pelican/credentials/prefix/delete](https://docs.pelicanplatform.org/commands-reference/pelican/credentials/prefix/delete)
- [commands-reference/pelican/credentials/prefix/print](https://docs.pelicanplatform.org/commands-reference/pelican/credentials/prefix/print)
- [commands-reference/pelican/credentials/prefix/set](https://docs.pelicanplatform.org/commands-reference/pelican/credentials/prefix/set)
- [commands-reference/pelican/credentials/print](https://docs.pelicanplatform.org/commands-reference/pelican/credentials/print)
- [commands-reference/pelican/credentials/replace](https://docs.pelicanplatform.org/commands-reference/pelican/credentials/replace)
- [commands-reference/pelican/credentials/reset-local](https://docs.pelicanplatform.org/commands-reference/pelican/credentials/reset-local)
- [commands-reference/pelican/credentials/reset-password](https://docs.pelicanplatform.org/commands-reference/pelican/credentials/reset-password)
- [commands-reference/pelican/credentials/token](https://docs.pelicanplatform.org/commands-reference/pelican/credentials/token)
- [commands-reference/pelican/credentials/token/get](https://docs.pelicanplatform.org/commands-reference/pelican/credentials/token/get)
- [Set up credentials for reading from a namespace](https://docs.pelicanplatform.org/commands-reference/pelican/credentials/token/setup)
- [commands-reference/pelican/job](https://docs.pelicanplatform.org/commands-reference/pelican/job)
- [commands-reference/pelican/job/cancel](https://docs.pelicanplatform.org/commands-reference/pelican/job/cancel)
- [commands-reference/pelican/job/list](https://docs.pelicanplatform.org/commands-reference/pelican/job/list)
- [commands-reference/pelican/job/status](https://docs.pelicanplatform.org/commands-reference/pelican/job/status)
- [commands-reference/pelican/namespace](https://docs.pelicanplatform.org/commands-reference/pelican/namespace)
- [commands-reference/pelican/namespace/delete](https://docs.pelicanplatform.org/commands-reference/pelican/namespace/delete)
- [commands-reference/pelican/namespace/list](https://docs.pelicanplatform.org/commands-reference/pelican/namespace/list)
- [commands-reference/pelican/namespace/register](https://docs.pelicanplatform.org/commands-reference/pelican/namespace/register)
- [commands-reference/pelican/object](https://docs.pelicanplatform.org/commands-reference/pelican/object)
- [commands-reference/pelican/object/copy](https://docs.pelicanplatform.org/commands-reference/pelican/object/copy)
- [commands-reference/pelican/object/get](https://docs.pelicanplatform.org/commands-reference/pelican/object/get)
- [commands-reference/pelican/object/ls](https://docs.pelicanplatform.org/commands-reference/pelican/object/ls)
- [commands-reference/pelican/object/put](https://docs.pelicanplatform.org/commands-reference/pelican/object/put)
- [commands-reference/pelican/object/share](https://docs.pelicanplatform.org/commands-reference/pelican/object/share)
- [commands-reference/pelican/object/stat](https://docs.pelicanplatform.org/commands-reference/pelican/object/stat)
- [commands-reference/pelican/object/sync](https://docs.pelicanplatform.org/commands-reference/pelican/object/sync)
- [commands-reference/pelican/plugin](https://docs.pelicanplatform.org/commands-reference/pelican/plugin)
- [commands-reference/pelican/plugin/stage](https://docs.pelicanplatform.org/commands-reference/pelican/plugin/stage)
- [commands-reference/pelican/plugin/transfer](https://docs.pelicanplatform.org/commands-reference/pelican/plugin/transfer)
- [commands-reference/pelican/rclone](https://docs.pelicanplatform.org/commands-reference/pelican/rclone)
- [commands-reference/pelican/rclone/install](https://docs.pelicanplatform.org/commands-reference/pelican/rclone/install)
- [Generate config for reading from a namespace](https://docs.pelicanplatform.org/commands-reference/pelican/rclone/setup)
- [commands-reference/pelican/token](https://docs.pelicanplatform.org/commands-reference/pelican/token)
- [commands-reference/pelican/token/create](https://docs.pelicanplatform.org/commands-reference/pelican/token/create)
- [commands-reference/pelican-server](https://docs.pelicanplatform.org/commands-reference/pelican-server)
- [commands-reference/pelican-server/apikey](https://docs.pelicanplatform.org/commands-reference/pelican-server/apikey)
- [commands-reference/pelican-server/apikey/generate](https://docs.pelicanplatform.org/commands-reference/pelican-server/apikey/generate)
- [commands-reference/pelican-server/cache](https://docs.pelicanplatform.org/commands-reference/pelican-server/cache)
- [commands-reference/pelican-server/cache/serve](https://docs.pelicanplatform.org/commands-reference/pelican-server/cache/serve)
- [commands-reference/pelican-server/config](https://docs.pelicanplatform.org/commands-reference/pelican-server/config)
- [commands-reference/pelican-server/config/describe](https://docs.pelicanplatform.org/commands-reference/pelican-server/config/describe)
- [commands-reference/pelican-server/config/dump](https://docs.pelicanplatform.org/commands-reference/pelican-server/config/dump)
- [commands-reference/pelican-server/config/get](https://docs.pelicanplatform.org/commands-reference/pelican-server/config/get)
- [commands-reference/pelican-server/config/summary](https://docs.pelicanplatform.org/commands-reference/pelican-server/config/summary)
- [commands-reference/pelican-server/credentials](https://docs.pelicanplatform.org/commands-reference/pelican-server/credentials)
- [commands-reference/pelican-server/credentials/prefix](https://docs.pelicanplatform.org/commands-reference/pelican-server/credentials/prefix)
- [commands-reference/pelican-server/credentials/prefix/add](https://docs.pelicanplatform.org/commands-reference/pelican-server/credentials/prefix/add)
- [commands-reference/pelican-server/credentials/prefix/delete](https://docs.pelicanplatform.org/commands-reference/pelican-server/credentials/prefix/delete)
- [commands-reference/pelican-server/credentials/prefix/print](https://docs.pelicanplatform.org/commands-reference/pelican-server/credentials/prefix/print)
- [commands-reference/pelican-server/credentials/prefix/set](https://docs.pelicanplatform.org/commands-reference/pelican-server/credentials/prefix/set)
- [commands-reference/pelican-server/credentials/print](https://docs.pelicanplatform.org/commands-reference/pelican-server/credentials/print)
- [commands-reference/pelican-server/credentials/replace](https://docs.pelicanplatform.org/commands-reference/pelican-server/credentials/replace)
- [commands-reference/pelican-server/credentials/reset-local](https://docs.pelicanplatform.org/commands-reference/pelican-server/credentials/reset-local)
- [commands-reference/pelican-server/credentials/reset-password](https://docs.pelicanplatform.org/commands-reference/pelican-server/credentials/reset-password)
- [commands-reference/pelican-server/credentials/token](https://docs.pelicanplatform.org/commands-reference/pelican-server/credentials/token)
- [commands-reference/pelican-server/credentials/token/get](https://docs.pelicanplatform.org/commands-reference/pelican-server/credentials/token/get)
- [Set up credentials for reading from a namespace](https://docs.pelicanplatform.org/commands-reference/pelican-server/credentials/token/setup)
- [commands-reference/pelican-server/director](https://docs.pelicanplatform.org/commands-reference/pelican-server/director)
- [commands-reference/pelican-server/director/serve](https://docs.pelicanplatform.org/commands-reference/pelican-server/director/serve)
- [commands-reference/pelican-server/downtime](https://docs.pelicanplatform.org/commands-reference/pelican-server/downtime)
- [commands-reference/pelican-server/downtime/create](https://docs.pelicanplatform.org/commands-reference/pelican-server/downtime/create)
- [commands-reference/pelican-server/downtime/delete](https://docs.pelicanplatform.org/commands-reference/pelican-server/downtime/delete)
- [commands-reference/pelican-server/downtime/list](https://docs.pelicanplatform.org/commands-reference/pelican-server/downtime/list)
- [commands-reference/pelican-server/downtime/update](https://docs.pelicanplatform.org/commands-reference/pelican-server/downtime/update)
- [commands-reference/pelican-server/generate](https://docs.pelicanplatform.org/commands-reference/pelican-server/generate)
- [commands-reference/pelican-server/generate/password](https://docs.pelicanplatform.org/commands-reference/pelican-server/generate/password)
- [commands-reference/pelican-server/key](https://docs.pelicanplatform.org/commands-reference/pelican-server/key)
- [commands-reference/pelican-server/key/create](https://docs.pelicanplatform.org/commands-reference/pelican-server/key/create)
- [commands-reference/pelican-server/namespace](https://docs.pelicanplatform.org/commands-reference/pelican-server/namespace)
- [commands-reference/pelican-server/namespace/delete](https://docs.pelicanplatform.org/commands-reference/pelican-server/namespace/delete)
- [commands-reference/pelican-server/namespace/list](https://docs.pelicanplatform.org/commands-reference/pelican-server/namespace/list)
- [commands-reference/pelican-server/namespace/register](https://docs.pelicanplatform.org/commands-reference/pelican-server/namespace/register)
- [commands-reference/pelican-server/origin](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin)
- [commands-reference/pelican-server/origin/collection](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection)
- [commands-reference/pelican-server/origin/collection/acl](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection/acl)
- [commands-reference/pelican-server/origin/collection/acl/grant](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection/acl/grant)
- [commands-reference/pelican-server/origin/collection/acl/list](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection/acl/list)
- [commands-reference/pelican-server/origin/collection/acl/revoke](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection/acl/revoke)
- [commands-reference/pelican-server/origin/collection/create](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection/create)
- [commands-reference/pelican-server/origin/collection/delete](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection/delete)
- [commands-reference/pelican-server/origin/collection/get](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection/get)
- [commands-reference/pelican-server/origin/collection/list](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection/list)
- [commands-reference/pelican-server/origin/collection/metadata](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection/metadata)
- [commands-reference/pelican-server/origin/collection/metadata/delete](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection/metadata/delete)
- [commands-reference/pelican-server/origin/collection/metadata/get](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection/metadata/get)
- [commands-reference/pelican-server/origin/collection/metadata/set](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection/metadata/set)
- [commands-reference/pelican-server/origin/collection/update](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/collection/update)
- [commands-reference/pelican-server/origin/config](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/config)
- [commands-reference/pelican-server/origin/issuer](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/issuer)
- [commands-reference/pelican-server/origin/issuer/client](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/issuer/client)
- [commands-reference/pelican-server/origin/issuer/client/create](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/issuer/client/create)
- [commands-reference/pelican-server/origin/issuer/client/delete](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/issuer/client/delete)
- [commands-reference/pelican-server/origin/issuer/client/list](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/issuer/client/list)
- [commands-reference/pelican-server/origin/issuer/client/update](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/issuer/client/update)
- [commands-reference/pelican-server/origin/serve](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/serve)
- [Interactive login via WebSocket (auto-detects local origin)](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/ssh-auth)
- [commands-reference/pelican-server/origin/ssh-auth/login](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/ssh-auth/login)
- [commands-reference/pelican-server/origin/ssh-auth/status](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/ssh-auth/status)
- [Test with default settings (uses SSH agent or default keys)](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/ssh-auth/test)
- [commands-reference/pelican-server/origin/token](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/token)
- [commands-reference/pelican-server/origin/token/create](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/token/create)
- [commands-reference/pelican-server/origin/token/verify](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/token/verify)
- [commands-reference/pelican-server/origin/web-ui](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/web-ui)
- [commands-reference/pelican-server/origin/web-ui/reset-password](https://docs.pelicanplatform.org/commands-reference/pelican-server/origin/web-ui/reset-password)
- [commands-reference/pelican-server/registry](https://docs.pelicanplatform.org/commands-reference/pelican-server/registry)
- [commands-reference/pelican-server/registry/serve](https://docs.pelicanplatform.org/commands-reference/pelican-server/registry/serve)
- [commands-reference/pelican-server/server](https://docs.pelicanplatform.org/commands-reference/pelican-server/server)
- [commands-reference/pelican-server/server/database](https://docs.pelicanplatform.org/commands-reference/pelican-server/server/database)
- [commands-reference/pelican-server/server/database/backup](https://docs.pelicanplatform.org/commands-reference/pelican-server/server/database/backup)
- [commands-reference/pelican-server/server/database/backup/create](https://docs.pelicanplatform.org/commands-reference/pelican-server/server/database/backup/create)
- [commands-reference/pelican-server/server/database/backup/info](https://docs.pelicanplatform.org/commands-reference/pelican-server/server/database/backup/info)
- [commands-reference/pelican-server/server/database/backup/list](https://docs.pelicanplatform.org/commands-reference/pelican-server/server/database/backup/list)
- [commands-reference/pelican-server/server/database/backup/restore](https://docs.pelicanplatform.org/commands-reference/pelican-server/server/database/backup/restore)
- [commands-reference/pelican-server/server/database/backup/verify](https://docs.pelicanplatform.org/commands-reference/pelican-server/server/database/backup/verify)
- [commands-reference/pelican-server/server/set-logging-level](https://docs.pelicanplatform.org/commands-reference/pelican-server/server/set-logging-level)
- [commands-reference/pelican-server/token](https://docs.pelicanplatform.org/commands-reference/pelican-server/token)
- [commands-reference/pelican-server/token/create](https://docs.pelicanplatform.org/commands-reference/pelican-server/token/create)
- [Core Concepts and Terminology](https://docs.pelicanplatform.org/about-pelican/core-concepts)
- [Running a Site-Local Cache](https://docs.pelicanplatform.org/operating-a-federation/cache/site-local-cache)