Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rexlmanu/pterodactyl-upload-action
A GitHub Action for efficient multi-server file uploads to Pterodactyl with proxy support.
https://github.com/rexlmanu/pterodactyl-upload-action
artifacts deployment github-actions pterodactyl upload
Last synced: 2 months ago
JSON representation
A GitHub Action for efficient multi-server file uploads to Pterodactyl with proxy support.
- Host: GitHub
- URL: https://github.com/rexlmanu/pterodactyl-upload-action
- Owner: rexlManu
- License: mit
- Created: 2023-05-28T02:24:22.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-15T02:53:30.000Z (about 1 year ago)
- Last Synced: 2024-11-29T16:02:21.526Z (2 months ago)
- Topics: artifacts, deployment, github-actions, pterodactyl, upload
- Language: JavaScript
- Homepage:
- Size: 585 KB
- Stars: 19
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pterodactyl Upload Action
This GitHub Action allows you to upload files to multiple Pterodactyl servers with just one action, featuring socket support.
## Usage
## Api Key
You have to create a client api key in the pterodactyl panel. You can do this in the panel under `Account` -> `API Credentials`.
### Inputs
1. `panel-host`: (**Required**) The host URL of the Pterodactyl panel.
2. `api-key`: (**Required**) The API key for the Pterodactyl panel.
3. `server-id`: ID of the target server.
4. `server-ids`: IDs of the target servers (multiline).
5. `source`: Source file to be uploaded.
6. `sources`: Source files to be uploaded (multiline).
7. `target`: Destination of the file on the server. Can be a file name (for a single source) or a directory name ending with a slash (for multiple files).
8. `proxy`: Proxy to be used for upload (username:password@host:port).
All file inputs support glob patterns.
### Example Workflow Configuration
```yaml
jobs:
deploy:
runs-on: ubuntu-latest
name: Deploy to Pterodactyl
steps:
- name: Checkout
uses: actions/checkout@v3
- run: echo "Hello world" > hello.txt
- uses: rexlmanu/[email protected]
with:
panel-host: ${{ secrets.PANEL_HOST }}
api-key: ${{ secrets.API_KEY }}
server-id: "5f095019"
# server-ids: |
# 5f095019
# 7f095019
source: "hello.txt"
# sources: |
# hello.txt
# hello2.txt
target: "./"
# If you want to restart the servers after successful upload
# restart: true
# If you want to decompress the files after successful upload
# decompress-target: true
```
## File Decompression
`decompress-target` allows decompression of archive files (`.zip, .tar, .tar.gz, .tgz, .rar`) after they are uploaded to the server. If you have multiple targets, it will decompress all valid compressed ones. If this option is not provided or set to false, files will be uploaded as is, without decompression.
The archive will be deleted after decompression.
### Multiple File/Server Example
Uncomment lines for `server-ids`, `sources`, and `proxy` in the above example as necessary.
## Configuration File
An optional `.pterodactyl-upload.json` file can be created in the root of your repository to define server(s), source file(s), and the target.
### Example Configuration File
```json
{
"server": "5f095019",
"servers": ["5f095019", "7f095019"],
"source": "hello.txt",
"sources": ["hello.txt", "hello2.txt"],
"target": "./"
}
```
#### Multiple different targets
If you need different targets for each file, you can provide a list of targets.
```json
{
"targets": {
"source": "hello.txt",
"target": "./"
}
}
```
## License
Pterodactyl Upload Action is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.