Getting Help
For a general overview of the Pelican Platform, check out the main website at pelicanplatform.org .
Documentation
If you’re looking for documentation about Pelican, you’re in the right place!
The documentation is split into different sections, navigable using the left-hand side bar. Search for keywords using the search bar in the top right corner. A table of contents for the current page is given in the right-hand side bar.
We also provide a few specific guides to assist users:
- FAQs - answers to frequently asked questions.
- Troubleshooting - common errors and how to troubleshoot them.
If you have feedback about the documentation, use one of the following links at the bottom of the table of contents (right-hand side):
- The link
Question? Give us feedbackwill open a new GitHub issue for the current page. - The link
Edit this page on GitHubwill open the GitHub editor for the current page.
GitHub
Pelican Platform software is published on GitHub under the PelicanPlatform organization . The majority of the functionality is published in the PelicanPlatform/pelican repository . The software is open source under an Apache 2.0 license .
Bug reports
You can report bugs that you encounter via GitHub.
-
For a specific bug, create a new bug report in the corresponding repository. In most cases, that will typically be the
PelicanPlatform/pelicanrepository: Open Bug Report . -
For general issues, or if you’re not sure where to file your bug report, you can start a new discussion in the PelicanPlatform organization . Existing discussions can be found at github.com/orgs/PelicanPlatform/discussions .
Before reporting a bug, we recommend that you
- Check the FAQs and Troubleshooting pages to see if the behavior is expected.
- Search the existing issues (typically in PelicanPlatform/pelican ) to see if we are already aware of the problem.
Feature requests
Features can be requested in a similar manner to reporting bugs.
-
To request a specific feature, open a new issue in the corresponding repository.
-
To request a general feature or functionality, or if you aren’t sure where to request one, you can open a new discussion in the PelicanPlatform organization .
Contact us
Generally, the best way to get in touch with the development team is to open a discussion or issue on GitHub, as described above. This is a public forum, however.
For email support, see pelicanplatform.org/contact .
For security issues, see our security policy on GitHub .
OSDF
For assistance with the OSDF, from downloading data to integrating with your storage, please see the main website at osg-htc.org/services/osdf .