Skip to content

Commit

Permalink
Documentation for user installation of the Pelican Client
Browse files Browse the repository at this point in the history
First draft of user installation guide. Accepting any and all feedback since I am not too experienced in documentation.
  • Loading branch information
joereuss12 committed Oct 17, 2023
1 parent 327a2df commit 2bf86ef
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Installing the Pelican Platform
===============================

This document explains how a user can download and install the Pelican client.

Installation Steps:
--------------------

### Install the Pelican Platform Binary
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.

Our versions are built like so:
For example: 7.1.2
- 7 represents the latest major version release
- 1 represents feature releases
- 2 represents a bug fix/patch release

### Extract the Binary
Once the package has finished downloading, place it in your workspace and extract the binary

### Test Functionality of the Pelican Platform
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:

```console
./pelican -f osg-htc.org object copy /osgconnect/public/osg/testfile.txt .
testfile.txt 36.00 b / 36.00 b [=============================================================================================] Done!
```

You should now notice a file **testfile.txt** now in your directory.

Congrats on making your first Pelican Object Copy!

0 comments on commit 2bf86ef

Please sign in to comment.