github.com/pelicanplatform/pelican@v1.0.5/docs/pages/install.mdx (about) 1 # Installing the Pelican Platform 2 3 This document explains how a user can download and install the Pelican client. 4 5 ## Installation Steps: 6 7 8 ### 1. Install the Pelican Platform Binary 9 Navigate to the [Pelican release page](https://github.com/PelicanPlatform/pelican/releases/). Download the proper binary for the system you are running on and select which version you would like to install. If you do not know which binary to install, below is a chart that may help: 10 11 | Package Name | Description | 12 |--------------------------------|------------------------------------------------------------------------| 13 | `pelican-7.1.2-1.arm64.rpm` | RPM package for ARM64 architecture on Linux systems. | 14 | `pelican-7.1.2-1.ppc64le.rpm` | RPM package for little endian PowerPC architecture on Linux systems. | 15 | `pelican-7.1.2-1.x86_64.rpm` | RPM package for x86_64 (64-bit) architecture on Linux systems. | 16 | `pelican-7.1.2-1_amd64.deb` | Debian package for AMD64 (x86_64) architecture on Debian-based Linux systems. | 17 | `pelican-7.1.2-1_arm64.deb` | Debian package for ARM64 architecture on Debian-based Linux systems. | 18 | `pelican-7.1.2-1_ppc64le.deb` | Debian package for little-endian PowerPC architecture on Debian-based Linux systems. | 19 | `pelican_amd64.apk` | APK package for AMD64 (x86_64) architecture. | 20 | `pelican_arm64.apk` | APK package for ARM64 architecture. | 21 | `pelican_Darwin_arm64.tar.gz` | Tarball for macOS systems running on ARM64 architecture (Apple Silicon). | 22 | `pelican_Darwin_x86_64.tar.gz` | Tarball for macOS systems with x86_64 architecture. | 23 | `pelican_Linux_arm64.tar.gz` | Tarball for Linux systems with ARM64 architecture. | 24 | `pelican_Linux_ppc64le.tar.gz` | Tarball for Linux systems with little-endian PowerPC architecture. | 25 | `pelican_Linux_x86_64.tar.gz` | Tarball for Linux systems with x86_64 (64-bit) architecture. | 26 | `pelican_ppc64le.apk` | APK package for little-endian PowerPC architecture, suitable for some PowerPC-based systems or specific Linux distributions. | 27 | `pelican_Windows_x86_64.zip` | ZIP archive for Windows systems with x86_64 (64-bit) architecture. **Note:** Pelican on Windows is still experimental and you may run into issues. | 28 29 ##### RPM, APK, or DEB? 30 ###### RPM (Red Hat Package Manager): 31 You want to install a `.rpm` package if you are using a Red Hat-based Linux distribution system such as: Red Hat Enterprise Linux, CentOS, Fedora, or openSUSE. 32 33 ###### APK (Alpine Package Keeper): 34 You want to install a `.apk` package if you are using an Alpine Linux system. 35 36 ###### DEB (Debian Package): 37 You want to install a `.deb` package if you are using a Linux distribution system such as: Debian, Ubuntu, or something similar. 38 39 ##### What about tar and zip? 40 If you want a more manual setup, you can download the `.tar.gz` or `.zip` files and extract the binary where you need it. However, the above packages are recommended for more inexperienced users. 41 42 ##### What version should I download? 43 Our versions are built like so: 44 For example: 7.1.2 45 - 7 represents the major version release 46 - 1 represents feature releases 47 - 2 represents a bug fix/patch release 48 49 We recommend you to use the latest feature or major release version so it includes the latest bug fixes and features. 50 51 ### 2. Extract the Binary 52 Once the package has finished downloading, place it in your workspace 53 54 ##### RPM: 55 To install RPM packages, you can use the dnf or yum package manager. Just make sure you have sudo access if you are not root: 56 ```console 57 sudo yum install pelican-7.1.2-1.x86_64.rpm 58 ``` 59 Replace 'yum' with 'dnf' for dnf install 60 61 ##### DEB: 62 To install Debian packages, you can use apt or dpkg package manager: 63 ```console 64 sudo dpkg -i pelican-7.1.2-1_amd64.deb 65 sudo apt-get install -f 66 ``` 67 Or 68 ```console 69 sudo apt install ./pelican-7.1.2-1_amd64.deb 70 ``` 71 72 ##### APK: 73 To install APK packages on Alpine Linux, you can use the apk package manager: 74 ```console 75 apk add pelican_amd64.apk 76 ``` 77 78 ##### Tarballs*: 79 To install `.tar.gz` packages, you can extract with tar: 80 ```console 81 tar -xzf pelican_Darwin_x86_64.tar.gz 82 ``` 83 84 ##### Zip*: 85 To install `.zip` packages, you can use [7zip](https://www.7-zip.org/) or other programs to unzip your file. Simply right click on the `.zip` file and extract all contents to a directory of your choice 86 87 88 >**\*Note:** If you install a tarball or zipfile, you don't actually *install* Pelican, you just extract the binary. It's covered below how you can still use Pelican with the binary, but if you would like to have similar functionality as the other packages, you need to add Pelican to your PATH manually. 89 90 ### 3. Test Functionality of the Pelican Platform 91 ##### For rpm, deb, and apk 92 If you downloaded this way, Pelican should automatically be added to the path. You can check this by: 93 ```console 94 which pelican 95 ``` 96 and make sure you get an output. You can then check functionality by running a simple **object copy** command: 97 ```console 98 pelican -f osg-htc.org object copy /osgconnect/public/osg/testfile.txt . 99 testfile.txt 36.00 b / 36.00 b [=============================================================================================] Done! 100 ``` 101 102 ##### For tarballs and zip, using the binary itself: 103 Once extracted, make sure you are in the same directory as the **Pelican** executable. To test if everything works, we can do a simple **object copy** command: 104 105 ```console 106 ./pelican -f osg-htc.org object copy /osgconnect/public/osg/testfile.txt . 107 testfile.txt 36.00 b / 36.00 b [=============================================================================================] Done! 108 ``` 109 110 You should now notice a file **testfile.txt** now in your directory. Congrats on making your first Pelican Object Copy!