Pelican

https://docs.pelicanplatform.org/
Admin
Pelican is software designed for delivery, with its documentation detailing its features and usage.
Tokens:52,578
Snippets:404
Trust Score:6.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Quickstart Pelican Installation

Source: https://docs.pelicanplatform.org/install/linux-binary

Downloads the latest Pelican version and unpacks it into the default user binary location (~/.local/bin/). Includes a command to verify the installation.

```bash
wget -O - "https://dl.pelicanplatform.org/latest/pelican_$(uname -s)_$(uname -m).tar.gz" | tar zx -C ~/.local/bin/ --strip-components=1
```

```bash
pelican --version
```

--------------------------------

### Accessing Data with Pelican Command Line Client

Source: https://docs.pelicanplatform.org/getting-started

This section explains how to interact with data using the Pelican command line client. It provides a quick tutorial for referencing objects using `pelican://`-schemed URLs.

```bash
pelican://your-object-name
```

--------------------------------

### Pelican Origin Serve Output Example

Source: https://docs.pelicanplatform.org/federating-your-data/origin

This is an example of the output when starting a Pelican Origin server for the first time, indicating that the admin interface is not initialized and providing a code for initialization.

```bash
$ pelican origin serve
 
Pelican admin interface is not initialized
To initialize, login at https://localhost:8444/view/initialization/code/ with the following code:
551220
```

--------------------------------

### Example Pelican RPM Installation

Source: https://docs.pelicanplatform.org/install/rhel

An example command to install Pelican version 7.5.8 RPM package on an X86_64 machine.

```bash
sudo yum install -y https://github.com/PelicanPlatform/pelican/releases/download/v7.5.8/pelican-7.5.8-1.x86_64.rpm
```

--------------------------------

### Manual Pelican Binary Download and Extraction

Source: https://docs.pelicanplatform.org/install/linux-binary

Provides steps to manually download a specific Pelican binary (e.g., for x86_64 or ARM64) from the Pelican download page, extract it to ~/.local/bin/, and includes an example for an x86_64 machine.

```bash
wget <replace-with-the-link-you-copied>
mkdir -p ~/.local/bin
tar -zxvf -C ~/.local/bin/ --strip-components=1 pelican_Linux_$(uname -m).tar.gz
```

```bash
$ wget https://dl.pelicanplatform.org/latest/pelican_Linux_x86_64.tar.gz
$ mkdir -p ~/.local/bin
$ tar -zxvf -C ~/.local/bin/ --strip-components=1 pelican_Linux_x86_64.tar.gz
```

--------------------------------

### Pelican YAML Configuration Example

Source: https://docs.pelicanplatform.org/install/docker

This is an example of a 'pelican.yaml' file that sets the logging level to 'debug'. This file can be mounted into the Pelican container.

```yaml
Logging:
  Level: debug
```

--------------------------------

### HTTPS URL Example

Source: https://docs.pelicanplatform.org/faq

Provides a concrete example of an HTTPS URL, breaking down its scheme, hostname, and path.

```URL
https://docs.pelicanplatform.org/parameters
```

--------------------------------

### Pelican YAML Configuration Example

Source: https://docs.pelicanplatform.org/parameters

An example of a Pelican configuration file in YAML format, demonstrating key-value pairs, nested structures, and lists for configuration parameters.

```yaml
IssuerKeysDirectory: /some/directory

OIDC:
  ClientIDFile: /etc/pelican/oidc-client-id

Registry:
  Institutions:
    - id: 0
      name: institution0
    - id: 1
      name: institution1
```

--------------------------------

### Install Pelican Server Executable (Ubuntu)

Source: https://docs.pelicanplatform.org/install

Provides instructions for installing the Pelican server executable on Ubuntu systems using the .deb package manager for x86_64 architecture.

```bash
sudo dpkg -i pelican-server_7.19.0.rc.2-1_amd64.deb
```

--------------------------------

### Install Pelican Executable (Ubuntu)

Source: https://docs.pelicanplatform.org/install

Provides instructions for installing the Pelican executable on Ubuntu systems using the .deb package manager for x86_64 architecture.

```bash
sudo dpkg -i pelican_7.19.0.rc.2-1_amd64.deb
```

--------------------------------

### Example: Download Public File from OSDF

Source: https://docs.pelicanplatform.org/getting-data-with-pelican/client

Provides a concrete example of downloading a public file ('hello-world.txt') from the OSDF's `/pelicanplatform/` namespace using the `pelican://` scheme. The downloaded file is saved as 'downloaded-testfile.txt'.

```bash
pelican object get pelican://osg-htc.org/pelicanplatform/test/hello-world.txt downloaded-testfile.txt
```

--------------------------------

### Serve Pelican Origin

Source: https://docs.pelicanplatform.org/monitoring-pelican-services/grafana

This command starts the Pelican Origin server, making it available for connections. It specifies the stash path and namespace for the server. Ensure Pelican is installed and the origin server is running before proceeding.

```bash
pelican origin serve -v /tmp/stash:/test-namespace -f "osg-htc.org"
```

--------------------------------

### Install Pelican Executable (Linux)

Source: https://docs.pelicanplatform.org/install

Provides instructions for installing the Pelican executable on Linux systems. This includes downloading the appropriate tarball for x86_64 architecture.

```bash
wget https://example.com/pelican_Linux_x86_64.tar.gz
tar -xzf pelican_Linux_x86_64.tar.gz
```

--------------------------------

### Install Pelican OSDF Compat Executable (Ubuntu)

Source: https://docs.pelicanplatform.org/install

Provides instructions for installing the Pelican OSDF compat executable on Ubuntu systems using the .deb package manager for x86_64 architecture.

```bash
sudo dpkg -i pelican-osdf-compat_7.19.0.rc.2-1_amd64.deb
```

--------------------------------

### Standard URL Structure Example

Source: https://docs.pelicanplatform.org/faq

Illustrates the general format of a URL, comprising a scheme, hostname, and path.

```URL
<scheme>://<hostname>/<path>
```

--------------------------------

### Pelican URL Example

Source: https://docs.pelicanplatform.org/faq

Demonstrates a URL using the 'pelican' scheme to access an object from a specific federation.

```URL
pelican://osg-htc.org/some/object
```

--------------------------------

### Install Pelican Server Executable (Linux)

Source: https://docs.pelicanplatform.org/install

Provides instructions for installing the Pelican server executable on Linux systems. This includes downloading the appropriate tarball for x86_64 architecture.

```bash
wget https://example.com/pelican-server_Linux_x86_64.tar.gz
tar -xzf pelican-server_Linux_x86_64.tar.gz
```

--------------------------------

### Lotman Policy Configuration Example

Source: https://docs.pelicanplatform.org/parameters

An example of a Lotman policy definition named 'my-policy'. This configuration specifies how Lotman should manage data lots, including purge order, prefix discovery, merging local and discovered configurations, and defining individual lots with their storage attributes and paths.

```yaml
Lotman:
  EnabledPolicy: "my-policy"
  PolicyDefinitions:
  - PolicyName: "my-policy"
    DivideUnallocated: true
    PurgeOrder: ["del", "exp", "opp", "ded"]
    DiscoverPrefixes: true
    MergeLocalWithDiscovered: true
    Lots:
    - LotName: "/foo/bar"
      Owner: "https://registry.com/api/v1.0/registry/foo/bar"
      Paths:
        Path: "/foo/bar"
        Recursive: true
      ManagementPolicyAttrs:
        DedicatedGB: 100
        OpportunisticGB: 100
        MaxNumObjects: 1000
        CreationTime: 1614556800
        ExpirationTime: 1614556800
        DeletionTime: 1614556800
    - LotName ... <additional lots>
```

--------------------------------

### Download Test File using Pelican

Source: https://docs.pelicanplatform.org/install

This command demonstrates how to download a test file ('hello-world.txt') from an OSDF location using the Pelican client. It shows the progress and completion of the download.

```bash
$ pelican object get pelican://osg-htc.org/pelicanplatform/test/hello-world.txt .
hello-world.txt 27.00b / 27.00b [=============================================================================================] Done!
```

--------------------------------

### Install Pelican Server Executable (RHEL)

Source: https://docs.pelicanplatform.org/install

Provides instructions for installing the Pelican server executable on RHEL-based systems using the .rpm package manager for x86_64 architecture.

```bash
sudo rpm -ivh pelican-server-7.19.0.rc.2-1.x86_64.rpm
```

--------------------------------

### Hierarchical Namespace Example (Directory Structure)

Source: https://docs.pelicanplatform.org/federating-your-data/choosing-namespaces

This example illustrates a hierarchical directory structure for a whale tracking project, demonstrating how to organize data by organization, project, ocean, year, and month. This structure facilitates predictable naming conventions for data retrieval and management.

```Shell
CoolScienceOrg/
└── WhaleTrackingProject/
    ├── Atlantic/
    │   ├── 2023/
    │   │   ├── Jan/
    │   │   │   ├── image1.jpg
    │   │   │   └── ...
    │   │   ├── Feb
    │   │   └── ...
    │   └── 2024
    ├── Pacific
    └── ...
```

--------------------------------

### Install Pelican Executable (Alpine Linux)

Source: https://docs.pelicanplatform.org/install

Provides instructions for installing the Pelican executable on Alpine Linux using the .apk package manager for x86_64 architecture.

```bash
apk add pelican_7.19.0_rc.2-r1_x86_64.apk
```

--------------------------------

### Start and Verify Grafana Server (Bash)

Source: https://docs.pelicanplatform.org/monitoring-pelican-services/grafana

These commands are used to start the Grafana server service and then check its status on a Linux system using systemd. Ensure Grafana is installed before running these commands.

```bash
sudo systemctl daemon-reload && \
    sudo systemctl start grafana-server
```

```bash
sudo systemctl status grafana-server
```

--------------------------------

### Pelican URL Example

Source: https://docs.pelicanplatform.org/about-pelican/core-concepts

An example of a Pelican URL, illustrating the structure that includes the federation, namespace, and object path.

```Pelican
pelican://osg-htc.org/demo/testfile.txt
```

```Pelican
pelican://osg-htc.org/pelicanplatform/test/hello-world.txt
```

--------------------------------

### Install Pelican OSDF Compat Executable (RHEL)

Source: https://docs.pelicanplatform.org/install

Provides instructions for installing the Pelican OSDF compat executable on RHEL-based systems using the .rpm package manager for x86_64 architecture.

```bash
sudo rpm -ivh pelican-osdf-compat-7.19.0.rc.2-1.x86_64.rpm
```

--------------------------------

### Install Pelican Executable (RHEL)

Source: https://docs.pelicanplatform.org/install

Provides instructions for installing the Pelican executable on RHEL-based systems using the .rpm package manager for x86_64 architecture.

```bash
sudo rpm -ivh pelican-7.19.0.rc.2-1.x86_64.rpm
```

--------------------------------

### Install Pelican DEB Package

Source: https://docs.pelicanplatform.org/install/debian

Installs the Pelican DEB package by downloading it using wget and then installing it using dpkg. It specifies the filename based on the system architecture (amd64 or arm64).

```bash
wget <replace-with-the-link-you-copied>
sudo dpkg -i pelican_7.5.8-1_amd64.deb
```

```bash
wget https://github.com/PelicanPlatform/pelican/releases/download/v7.5.8/pelican_7.5.8-1_amd64.deb
sudo dpkg -i pelican_7.5.8-1_amd64.deb
```

--------------------------------

### Launch Pelican Registry

Source: https://docs.pelicanplatform.org/operating-a-federation/registry

Command to start the Pelican registry service. After launching, the registry provides an initialization URL and code for setting up the admin interface.

```bash
pelican registry serve
```

--------------------------------

### Install Pelican OSDF Compat Executable (Alpine Linux)

Source: https://docs.pelicanplatform.org/install

Provides instructions for installing the Pelican OSDF compat executable on Alpine Linux using the .apk package manager for x86_64 architecture.

```bash
apk add pelican-osdf-compat_7.19.0_rc.2-r1_x86_64.apk
```

--------------------------------

### Namespace Prefix to Directory Mapping Example

Source: https://docs.pelicanplatform.org/federating-your-data/choosing-namespaces

This example demonstrates how Pelican namespace prefixes can be mapped to specific directories within a Posix filesystem. It shows two different scoping strategies: mapping individual detector directories or mapping the entire physics directory.

```Shell
/my-namespace/detector1 —> /physics/detector1  
/my-namespace/detector2 —> /physics/detector2
```

```Shell
/my-namespace —> /physics
```

--------------------------------

### Pelican Environment Variable Configuration Example

Source: https://docs.pelicanplatform.org/parameters

Demonstrates how to set Pelican configuration parameters using environment variables. This example shows setting the logging level to 'Debug'.

```bash
export PELICAN_LOGGING_LEVEL=Debug
```

--------------------------------

### Get Object from Pelican Federation

Source: https://docs.pelicanplatform.org/getting-started/accessing-data

This command retrieves a file from a specified Pelican URL and saves it locally. It requires the Pelican client to be installed and configured. The output shows a progress bar and confirms successful download.

```bash
pelican object get pelican://osg-htc.org/pelicanplatform/test/hello-world.txt downloaded-test.txt
$ pelican object get pelican://osg-htc.org/pelicanplatform/test/hello-world.txt downloaded-test.txt
downloaded-test.txt 27.00 b / 27.00 b [==============================================================================] Done!
$ ls
downloaded-test.txt
$ cat downloaded-test.txt
If you are seeing this message, getting an object from OSDF was successful.
```

--------------------------------

### Install Pelican Debug Executable (RHEL)

Source: https://docs.pelicanplatform.org/install

Provides instructions for installing the Pelican debug executable on RHEL-based systems using the .rpm package manager for x86_64 architecture.

```bash
sudo rpm -ivh pelican-debug-7.19.0.rc.2-1.x86_64.rpm
```

--------------------------------

### Pull Pelican Docker Image with Specific Version

Source: https://docs.pelicanplatform.org/install/docker

This example shows how to pull a Pelican Docker image with a specific version tag instead of the 'latest' tag, ensuring a particular release is used.

```bash
docker pull hub.opensciencegrid.org/pelican_platform/origin:v7.6.4
```

--------------------------------

### File URL Example

Source: https://docs.pelicanplatform.org/faq

Shows a typical 'file:///' URL used for accessing local files, highlighting the triple slash.

```URL
file:///some/path/to/file.pdf
```

--------------------------------

### Pelican Object URL Example

Source: https://docs.pelicanplatform.org/federating-your-data/choosing-namespaces

This example shows the format of a Pelican object URL, which includes the federation name and the path to the object. This URL structure is crucial for Pelican clients to locate and access data within the federation.

```URL
pelican://osg-htc.com/this/is/an/object
```

--------------------------------

### Check Pelican Installation

Source: https://docs.pelicanplatform.org/getting-data-with-pelican/client

Verifies if the Pelican client is installed and accessible in the system's PATH. This command is crucial for ensuring the client is ready for use.

```bash
which pelican
```

--------------------------------

### Test Pelican Installation After PATH Update

Source: https://docs.pelicanplatform.org/install/linux-binary

Executes the 'pelican --version' command after updating the PATH to confirm the Pelican binary is accessible and displays its version information.

```bash
$ pelican --version

Version: 7.12.0
Build Date: 2025-01-14T21:33:23Z
Build Commit: 57748c37af7574ec182e5a21db741c4c5a1e61a8
Built By: goreleaser
```

--------------------------------

### Install Pelican RPM Package

Source: https://docs.pelicanplatform.org/install/rhel

Installs the Pelican RPM package using yum. Replace the placeholder with the actual download link for the Pelican RPM.

```bash
sudo yum install -y <replace-with-the-link-you-copied>
```

--------------------------------

### Launch Pelican Cache

Source: https://docs.pelicanplatform.org/operating-a-federation/cache

Command to start a Pelican cache as a daemon process. It requires specifying the federation URL to join.

```bash
pelican cache serve -f <federation>
```

--------------------------------

### Run Pelican Binary from Downloaded Folder (Windows)

Source: https://docs.pelicanplatform.org/install/windows

This snippet shows how to navigate to the extracted Pelican Windows binary directory and execute the Pelican binary to check its version. It's a temporary way to run Pelican before adding it to the PATH.

```Windows PowerShell
rem Go to the downloaded Pelican folder
$ cd D:\Downloads\pelican_Windows_x86_64

rem Run Pelican binary
$ pelican.exe --version

Version: 7.5.8
Build Date: 2024-03-01T18:13:00Z
Build Commit: d260a07d3b057d19b7fdd36125f91a8768531258
Built By: goreleaser
```

--------------------------------

### Check Pelican Installation

Source: https://docs.pelicanplatform.org/getting-started/accessing-data

Verifies if the Pelican client is installed and accessible in your system's PATH. If the command returns no output, it indicates that Pelican is not installed or not configured correctly.

```bash
which pelican
```

--------------------------------

### Configure QDL Location

Source: https://docs.pelicanplatform.org/parameters

Specifies the installation directory for the QDL language and its associated scripts. This path is used to locate and execute QDL programs.

```Go
// Issuer.QDLLocation specifies the location of the QDL language and scripts install on the system.
// Default: /opt/qdl
QDLLocation string
```

--------------------------------

### Run Pelican Origin Server with Docker

Source: https://docs.pelicanplatform.org/install/docker

This snippet shows how to run the Pelican origin server using its Docker image. It specifies the image name and tag from the Open Science Grid Docker Hub.

```bash
docker run -d -p 8080:8080 hub.opensciencegrid.org/pelican_platform/origin:latest
```

--------------------------------

### Enable and Start Pelican Origin as a Systemd Service

Source: https://docs.pelicanplatform.org/federating-your-data/origin

This command enables and starts the Pelican Origin as a background service using systemd. It assumes the user has a basic understanding of systemd and is recommended for advanced users.

```bash
systemctl enable --now pelican-origin
```

--------------------------------

### Get Public Object using pelican://

Source: https://docs.pelicanplatform.org/getting-data-with-pelican/client

Demonstrates how to retrieve a public object from a federation using the `pelican://` URL scheme with the `pelican object get` command. It specifies the federation URL, namespace, object path, and local destination.

```bash
pelican object get pelican://<federation-url></namespace-prefix></path/to/file> <local/path/to/file>
```

--------------------------------

### Client Preferred Caches Configuration Example

Source: https://docs.pelicanplatform.org/parameters

Demonstrates how to configure preferred caches for the Pelican client. It shows the format for specifying a list of caches and the behavior when a '+' is included to indicate fallback to Director-discovered caches.

```yaml
Client:
  PreferredCaches: ["https://cache1.com:8443", "https://cache2.com:8443", "+"]
```

--------------------------------

### Pelican Director Configuration Response

Source: https://docs.pelicanplatform.org/faq

Example JSON response from querying the .well-known/pelican-configuration path, detailing the federation's director endpoint and other service URIs.

```json
{
  "director_endpoint": "https://osdf-director.osg-htc.org",
  "namespace_registration_endpoint": "https://osdf-registry.osg-htc.org",
  "jwks_uri": "https://osg-htc.org/osdf/public_signing_key.jwks"
}
```

--------------------------------

### Create Pelican Configuration File

Source: https://docs.pelicanplatform.org/install/docker

This command creates an empty YAML file named 'pelican.yaml' on the host machine, which will be used to configure the Pelican server.

```bash
touch pelican.yaml
```

--------------------------------

### Verify Pelican Installation on Windows

Source: https://docs.pelicanplatform.org/install

This command checks if the Pelican executable is available in the system's PATH on Windows. Successful execution will output the path to the Pelican executable.

```powershell
where pelican
```

--------------------------------

### Run Pelican Registry Server with Docker

Source: https://docs.pelicanplatform.org/install/docker

This command launches the Pelican registry server in a Docker container. It publishes port 8444 for the admin website and utilizes the designated Docker image with the serve command, necessitating further configuration for federation discovery.

```docker
docker run -it -p 8444:8444 --name=pelican-registry hub.opensciencegrid.org/pelican_platform/registry:latest serve -f <federation>
```

--------------------------------

### Verify Pelican Installation on Linux/macOS

Source: https://docs.pelicanplatform.org/install

This command checks if the Pelican executable is available in the system's PATH on Linux and macOS. Successful execution will output the path to the Pelican executable.

```bash
which pelican
```

--------------------------------

### OSDF URL Transformation Example

Source: https://docs.pelicanplatform.org/faq

Illustrates how a 'pelican' URL can be transformed into an 'osdf' URL by removing the redundant hostname.

```URL
pelican://osg-htc.org/some/object —> osdf:///some/object
```

--------------------------------

### Run Pelican Executable and Verify Version (macOS)

Source: https://docs.pelicanplatform.org/install/macos

After extracting the Pelican executable, this command navigates into the created directory and runs the Pelican executable with the --version flag to display its version information.

```shell
cd pelican-7.10.5
./pelican --version
```

--------------------------------

### Configure UI Activation Code File

Source: https://docs.pelicanplatform.org/parameters

Sets the file path for the activation code required to configure the server's web UI if it hasn't been set up yet. This file contains the necessary credentials for initial UI setup.

```Go
// Server.UIActivationCodeFile specifies the file path for the activation code to configure the server's web UI.
// Default: $ConfigBase/server-web-activation-code
UIActivationCodeFile string
```

--------------------------------

### Recursive Download of a Collection using ?recursive

Source: https://docs.pelicanplatform.org/getting-data-with-pelican/client

Illustrates how to perform a recursive download of a collection by adding the '?recursive' query to the object get command.

```bash
pelican object get pelican://<federation-url></namespace-prefix></path/to/collection>?recursive <local/path/to/file>
```

--------------------------------

### Run Pelican Registry Server with Docker

Source: https://docs.pelicanplatform.org/install/docker

This snippet shows how to run the Pelican registry server using its Docker image. It specifies the image name and tag from the Open Science Grid Docker Hub.

```bash
docker run -d -p 8080:8080 hub.opensciencegrid.org/pelican_platform/registry:latest
```

--------------------------------

### Configure Pelican for a Single S3 Bucket

Source: https://docs.pelicanplatform.org/federating-your-data/s3-backend

This configuration example shows how to set up Pelican to serve a single S3 bucket. It includes the storage type, S3 service URL, region, and URL style. The example also specifies the S3 bucket name, federation prefix, and paths to access and secret key files for authentication. Additionally, it configures origin capabilities like read and write access.

```YAML
Origin:
  StorageType: "s3"
  S3ServiceUrl: "https://my-s3.com"
  S3Region: "us-west-2"
  S3UrlStyle: "path"
 
  FederationPrefix: /my/namespace
  S3Bucket: "my-bucket"
  S3AccessKeyfile: "/path/to/access.key"
  S3SecretKeyfile: "/path/to/secret.key"
 
  # Set up origin capabilities that are also applied to the bucket
  EnableWrites: false
  EnableReads: true
  EnableListings: false
  EnableDirectReads: true
```

--------------------------------

### Pelican Object URL Example

Source: https://docs.pelicanplatform.org/about-pelican/core-concepts

This snippet shows an example of a full Pelican object URL, combining the federation hostname and the object's path within that federation. Pelican objects are treated as immutable, and their access is often facilitated by caches powered by XRootD.

```text
/pelicanplatform/test/hello-world.txt
```

--------------------------------

### Verify Pelican Binary Availability

Source: https://docs.pelicanplatform.org/install/linux-binary

Checks if the 'pelican' command is available in the current terminal's PATH.

```bash
command -v pelican
```

--------------------------------

### Posix Filesystem Structure for Federation

Source: https://docs.pelicanplatform.org/federating-your-data/choosing-namespaces

This example presents a Posix filesystem directory tree for physics data, organized by detector and year. This structure serves as a basis for administrators to define Pelican namespace prefixes and map them to underlying data repositories.

```Shell
physics/
├── detector1/
│   ├── 2023/
│   │   ├── raw/
│   │   │   └── event.csv
│   │   └── processed/
│   │       └── event.csv
│   └── 2024/
│       └── ...
└── detector2/
    └── ...
```

--------------------------------

### Run Docker Container with YAML Configuration File

Source: https://docs.pelicanplatform.org/install/docker

This command shows how to run a Pelican Docker container, mounting a local 'pelican.yaml' file to the container's configuration directory. It also maps ports and mounts a data volume.

```bash
docker run -it -p 8444:8444 -p 8443:8443 -v /path/to/your/data/:/tmp/pelican -v $PWD/pelican.yaml:/etc/pelican/pelican.yaml --name=pelican-origin hub.opensciencegrid.org/pelican_platform/origin:latest serve -v /tmp/pelican:/foo/bar -f <federation>
```

--------------------------------

### Download and Extract Pelican Executable (macOS)

Source: https://docs.pelicanplatform.org/install/macos

This snippet shows how to download the Pelican executable using curl and extract it using tar. It assumes you have copied the correct download link from the Pelican website.

```bash
curl -LO <replace-with-the-link-you-copied>
tar -zxvf <name-of-downloaded-file>
```

```bash
curl -LO https://github.com/PelicanPlatform/pelican/releases/download/v7.10.5/pelican_Darwin_arm64.tar.gz
tar -zxvf pelican_Darwin_arm64.tar.gz
```

--------------------------------

### OSDF URL Scheme Format

Source: https://docs.pelicanplatform.org/getting-data-with-pelican/client

Illustrates the format for using the `osdf:///` scheme, which automatically loads federation metadata for accessing the Open Science Data Federation (OSDF). The hostname is omitted, and the URL starts with the namespace prefix.

```bash
pelican object get osdf:///<namespace-prefix></path/to/file> <local/path/to/file>
```

--------------------------------

### Run Pelican Cache Server with Docker

Source: https://docs.pelicanplatform.org/install/docker

This snippet demonstrates how to run the Pelican cache server using its Docker image. It specifies the image name and tag from the Open Science Grid Docker Hub.

```bash
docker run -d -p 8080:8080 hub.opensciencegrid.org/pelican_platform/cache:latest
```

--------------------------------

### Configure XRootD MaxStartupWait

Source: https://docs.pelicanplatform.org/parameters

Defines the maximum duration Pelican will wait for XRootD daemons to start successfully, preventing prolonged initialization delays.

```XRootd
MaxStartupWait: 10s
```

--------------------------------

### Configure Startup Timeout

Source: https://docs.pelicanplatform.org/parameters

Sets the maximum time the Pelican server will wait for its components and services to start up. If the timeout is reached before all components are ready, the server will shut down.

```Go
// Server.StartupTimeout is the amount of time the pelican server will wait for its components and services to startup.
// If the timeout is hit while waiting on a component, the server will shutdown.
// Default: 10s
StartupTimeout string
```

--------------------------------

### Run Pelican Director Server with Docker

Source: https://docs.pelicanplatform.org/install/docker

This snippet illustrates how to run the Pelican director server using its Docker image. It specifies the image name and tag from the Open Science Grid Docker Hub.

```bash
docker run -d -p 8080:8080 hub.opensciencegrid.org/pelican_platform/director:latest
```

--------------------------------

### Pelican Federation URL Example

Source: https://docs.pelicanplatform.org/federating-your-data/origin

This snippet demonstrates the format of a Pelican URL used to access data from a specific federation, including the federation URL and a namespace path.

```URL
pelican://osg-htc.org/some/namespace/path
```

--------------------------------

### Add Pelican Binary to PATH (Current Terminal)

Source: https://docs.pelicanplatform.org/install/linux-binary

Temporarily adds the ~/.local/bin/ directory to the PATH environment variable for the current terminal session, allowing the 'pelican' command to be executed.

```bash
export PATH="$HOME/.local/bin/:$PATH"
```

--------------------------------

### Download Publicly Accessible Data

Source: https://docs.pelicanplatform.org/federating-your-data/origin

Demonstrates how to download a file from a publicly readable Pelican Origin using the `pelican object get` command. It specifies the full path to the data within the federation namespace.

```bash
pelican object get pelican://osg-htc.org/my/namespace/super-cool-data.csv downloaded.txt
```

--------------------------------

### Run Pelican Cache Server with Docker

Source: https://docs.pelicanplatform.org/install/docker

This command initiates the Pelican cache server within a Docker container. It exposes ports 8444 for the admin website and 8442 for object transfer. The command utilizes the specified Docker image and includes the serve command with a federation discovery URL.

```docker
docker run -it -p 8444:8444 -p 8442:8442 --name=pelican-cache hub.opensciencegrid.org/pelican_platform/cache:latest serve -f <federation>
```

--------------------------------

### Accessing Data with Pelican Command Line Client

Source: https://docs.pelicanplatform.org/faq

This section describes how to access data using the Pelican command-line client. It outlines the basic commands and usage patterns for interacting with Pelican federations.

```bash
pelican get <object_path>
pelican put <local_file> <object_path>
```

--------------------------------

### Run Docker Container with Environment Variable Configuration

Source: https://docs.pelicanplatform.org/install/docker

This command demonstrates how to run a Pelican Docker container and configure its logging level using an environment variable. It maps ports, mounts a volume for data, and specifies the image to use.

```bash
docker run -it -e PELICAN_LOGGING_LEVEL=debug -p 8444:8444 -p 8443:8443 -v /path/to/your/data/:/tmp/pelican --name=pelican-origin hub.opensciencegrid.org/pelican_platform/origin:latest serve -v /tmp/pelican:/foo/bar -f <federation>
```

--------------------------------

### Run Pelican Director Server with Docker

Source: https://docs.pelicanplatform.org/install/docker

This command deploys the Pelican director server using a Docker container. It maps port 8444 for the admin interface and uses the specified Docker image with the serve command, requiring additional configuration for federation discovery.

```docker
docker run -it -p 8444:8444 --name=pelican-director hub.opensciencegrid.org/pelican_platform/director:latest serve -f <federation>
```

--------------------------------

### Configure Server Modules

Source: https://docs.pelicanplatform.org/parameters

Defines a list of modules to be enabled when running Pelican in `pelican serve` mode. This allows customization of server functionality.

```Go
// Server.Modules is a list of modules to enable when running pelican in `pelican serve` mode.
// Default: 
Modules []string
```

--------------------------------

### Upload Directory with Compression using ?pack

Source: https://docs.pelicanplatform.org/getting-data-with-pelican/client

Shows how to upload a local directory and have Pelican compress it into a tarball using the '?pack=tar.gz' query parameter.

```bash
pelican object put <local/path/to/directory> pelican://<federation-url></namespace-prefix></path/to/collection.tar.gz>?pack=tar.gz
```

--------------------------------

### Install Pelican APK Package (Alpine Linux)

Source: https://docs.pelicanplatform.org/install/alpine

This snippet shows how to download and install the Pelican APK package on an Alpine Linux system. It includes commands for both x86_64 and ARM64 architectures, emphasizing the need to replace placeholder links with actual download URLs.

```Shell
wget <replace-with-the-link-you-copied>
sudo apk add --allow-untrusted pelican_7.5.8_p1_x86_64.apk
```

```Shell
wget https://github.com/PelicanPlatform/pelican/releases/download/v7.5.8/pelican_7.5.8_p1_x86_64.apk
sudo apk add --allow-untrusted pelican_7.5.8_p1_x86_64.apk
```

--------------------------------

### Accessing Data with Pelican Command Line Client

Source: https://docs.pelicanplatform.org/about-pelican

This section details how to access data using Pelican's command-line client. It outlines the necessary commands and their usage for interacting with federated data sources.

```bash
pelican get <source> <destination>
```

--------------------------------

### Director: Get Namespace Prefix

Source: https://docs.pelicanplatform.org/api-docs

A non-UI facing API for the Director server to get the longest matched namespace prefix for a given path.

```REST
GET /director/namespaces/prefix/{path}
```

--------------------------------

### Run Pelican Origin Server with Docker

Source: https://docs.pelicanplatform.org/install/docker

This command runs the Pelican origin server in a Docker container. It maps ports 8444 and 8443 for admin and object transfer endpoints respectively, and mounts a host directory for data storage. The command specifies the Docker image and the serve command with arguments for data binding and federation discovery.

```docker
docker run -it -p 8444:8444 -p 8443:8443 -v /path/to/your/data/:/tmp/pelican --name=pelican-origin hub.opensciencegrid.org/pelican_platform/origin:latest serve -v /tmp/pelican:/foo/bar -f <federation>
```

--------------------------------

### Download Public Object with Pelican

Source: https://docs.pelicanplatform.org/getting-data-with-pelican/client

This command is used to download objects from origins, including those that support CILogon authentication. If it's the first time, a token wallet will be created and require a password.

```bash
pelican object get pelican://<federation-url></namespace-prefix></path/to/file> <local/path/to/file>
```

--------------------------------

### Verify Pelican Installation After PATH Update (Windows)

Source: https://docs.pelicanplatform.org/install/windows

After permanently adding the Pelican binary directory to the system's PATH environment variable, this command is used in a new PowerShell window to verify that Pelican is accessible globally.

```Windows PowerShell
rem Run Pelican binary
$ pelican --version

Version: 7.5.8
Build Date: 2024-03-01T18:13:00Z
Build Commit: d260a07d3b057d19b7fdd36125f91a8768531258
Built By: goreleaser
```

--------------------------------

### Uninstall Pelican

Source: https://docs.pelicanplatform.org/install/rhel

Uninstalls the Pelican package using dnf on Red Hat-based systems.

```bash
sudo dnf remove pelican
```

--------------------------------

### Director: Get Federation Token

Source: https://docs.pelicanplatform.org/api-docs

An API endpoint for the Director to obtain a token signed by the federation's issuer.

```REST
GET /director/getFedToken
```

--------------------------------

### Configure Xrootd Macaroons Key File

Source: https://docs.pelicanplatform.org/parameters

Specifies the file path for the Macaroons key used for Xrootd authorization setup.

```yaml
Xrootd.MacaroonsKeyFile: "/path/to/macaroons.key"
```

--------------------------------

### Download Tarball with Auto-Unpack using ?pack

Source: https://docs.pelicanplatform.org/getting-data-with-pelican/client

Demonstrates how to download a tarball and have the Pelican client automatically unpack it by appending the '?pack=tar.gz' query to the federation URL.

```bash
pelican object get pelican://<federation-url></namespace-prefix></path/to/file/file.tar.gz>?pack=tar.gz <local/path/to/file>
```

--------------------------------

### Configure Scitokens Server Location

Source: https://docs.pelicanplatform.org/parameters

Defines the installation path for the scitokens server. This is important for services that use scitokens for authentication and authorization.

```Go
// Issuer.ScitokensServerLocation specifies the location of the scitoken server installation.
// Default: /opt/scitokens-server
ScitokensServerLocation string
```

--------------------------------

### Create Test File

Source: https://docs.pelicanplatform.org/federating-your-data/origin

This command creates a simple text file named 'testfile.txt' in the specified directory, which will be used to test the Origin's ability to serve files.

```bash
echo "This is a test file." > /tmp/demo/testfile.txt
```

--------------------------------

### Uninstall Pelican on Debian or Ubuntu

Source: https://docs.pelicanplatform.org/install/debian

Removes the Pelican package from a Debian or Ubuntu system using the apt-get remove command.

```bash
sudo apt-get remove pelican
```

--------------------------------

### Configure Tomcat Location

Source: https://docs.pelicanplatform.org/parameters

Specifies the installation location of the system's Tomcat server. This is relevant for integrations or services that rely on a Tomcat environment.

```Go
// Issuer.TomcatLocation specifies the location of the system tomcat installation.
// Default: /opt/tomcat
TomcatLocation string
```

--------------------------------

### Stop Pelican Systemd Service

Source: https://docs.pelicanplatform.org/install/rhel

Stops the Pelican server's systemd service. This command assumes the service is named 'grafana'.

```bash
sudo systemctl stop grafana
```

--------------------------------

### Recursive Upload of a Directory using ?recursive

Source: https://docs.pelicanplatform.org/getting-data-with-pelican/client

Explains how to upload a local directory recursively by appending the '?recursive' query to the object put command.

```bash
pelican object put <local/path/to/directory> pelican://<federation-url></namespace-prefix></path/to/collection>?recursive
```

--------------------------------

### Serve a Pelican Registry

Source: https://docs.pelicanplatform.org/operating-a-federation

Instructions on how to serve a Pelican Registry component, which is a central service for coordinating origins and caches in a data sharing ecosystem.

```bash
# Example command to serve a Pelican Registry (specific command not provided in text)
# pelican registry serve --config /path/to/registry.yaml
```

--------------------------------

### Uninstall Pelican (Alpine Linux)

Source: https://docs.pelicanplatform.org/install/alpine

This command demonstrates how to remove the Pelican package from an Alpine Linux system using the apk del command.

```Shell
sudo apk del pelican
```

--------------------------------

### Retrieve Test File via Pelican Federation

Source: https://docs.pelicanplatform.org/federating-your-data/origin

This command retrieves the 'testfile.txt' from the Pelican Origin using the provided federation URL and namespace prefix. It requires navigating to the home directory first.

```bash
cd ~
pelican object get pelican://<federation URL>/<namespace_prefix>/testfile.txt .
```

--------------------------------

### Collections: Manage Collection Metadata

Source: https://docs.pelicanplatform.org/api-docs

APIs for managing metadata associated with collections, including getting, setting, and deleting metadata key-value pairs.

```REST
GET /origin_ui/collections/{id}/metadata
PUT /origin_ui/collections/{id}/metadata/{key}
DELETE /origin_ui/collections/{id}/metadata/{key}
```

--------------------------------

### Pelican Command Line Client Usage

Source: https://docs.pelicanplatform.org/federating-your-data

Demonstrates basic usage of the Pelican command-line client for accessing federated data. This is a foundational tool for interacting with Pelican services.

```bash
pelican get /my-origin/foo/object.txt
```

--------------------------------

### Set Director Advertisement URL

Source: https://docs.pelicanplatform.org/parameters

Specifies the URL to which director advertisements should be sent. This can be different from the client-facing URL in high-availability setups. If not set, `Server.ExternalWebUrl` is used.

```yaml
Director:
  AdvertiseUrl: "http://director.example.com:8080"
```

--------------------------------

### Registry UI: Get Institutions and Topology

Source: https://docs.pelicanplatform.org/api-docs

APIs for the Registry server's Web UI to retrieve institution names and the OSDF namespace topology.

```REST
GET /registry_ui/institutions
GET /registry_ui/topology
```

--------------------------------

### Enable Origin Web UI

Source: https://docs.pelicanplatform.org/parameters

Determines whether the origin should enable its web-based user interface for management and monitoring.

```Python
origin.EnableUI = True
```

--------------------------------

### Configure Drop Privileges

Source: https://docs.pelicanplatform.org/parameters

A boolean flag that determines if the server should drop root privileges after starting. This is a security measure to run the server with minimal necessary permissions.

```Go
// Server.DropPrivileges determines if the server should drop root privileges after starting.
// Default: false
DropPrivileges bool
```

--------------------------------

### Direct Download bypassing Cache using ?directread

Source: https://docs.pelicanplatform.org/getting-data-with-pelican/client

Demonstrates how to download an object directly from the origin, bypassing any caches, by using the '?directread' query parameter.

```bash
pelican object get pelican://<federation-url></namespace-prefix></path/to/file>?directread <local/path/to/file>
```

--------------------------------

### Pelican Python FSSpec Example

Source: https://docs.pelicanplatform.org/federating-your-data

Shows how to use the Pelican Python FSSpec implementation to access federated data programmatically. This allows integration with Python-based data analysis workflows.

```python
from fsspec.implementations. Pelican import PelicanFileSystem
fs = PelicanFileSystem()
with fs.open('/my-origin/foo/object.txt', 'rb') as f:
    content = f.read()
```

--------------------------------

### Configure PssSetOpt Logging Level

Source: https://docs.pelicanplatform.org/parameters

Configures the logging level for the XRootD Proxy System Service Set Options (PssSetOpt), providing detailed information on configuration and operational settings. Accepted values range from 'trace' to 'panic'.

```string
Logging.Cache: error
```

--------------------------------

### Copy Object with Pelican (Deprecated)

Source: https://docs.pelicanplatform.org/getting-data-with-pelican/client

This command is a deprecated method for copying objects, functioning similarly to 'get' and 'put' operations. It can be used for both downloading and uploading files.

```bash
pelican object copy pelican://<federation-url></namespace-prefix></path/to/file> <local/path/to/file>
```

```bash
pelican object copy <path/to/local/file> pelican://<federation-url></namespace-prefix></path/to/destination> -t </path/to/token/file>
```

--------------------------------

### Director UI: Get Federation Contact and Downtimes

Source: https://docs.pelicanplatform.org/api-docs

APIs for the Director server's Web UI to retrieve support contact information and downtime entries for servers.

```REST
GET /director_ui/contact
GET /director_ui/downtimes
```

--------------------------------

### Serve a Pelican Director

Source: https://docs.pelicanplatform.org/operating-a-federation

Instructions on how to serve a Pelican Director component, responsible for directing client requests to the proper storage server and managing namespace registration.

```bash
# Example command to serve a Pelican Director (specific command not provided in text)
# pelican director serve --config /path/to/director.yaml
```

--------------------------------

### Calculate Pelican Server Uptime with PromQL

Source: https://docs.pelicanplatform.org/monitoring-pelican-services/prometheus

This PromQL query calculates the duration in seconds that a Pelican server process has been running. It subtracts the process start time from the current time.

```PromQL
time() - process_start_time_seconds
```

--------------------------------

### Enable Lotman for Cache Storage Management

Source: https://docs.pelicanplatform.org/parameters

Enables the LotMan library for managing storage space within the cache.

```configuration
Cache.EnableLotman = true
```
Tokens:
Raw