Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devtomatocake/pterodactyl-vsc
Pterodactyl server files in VS Code
https://github.com/devtomatocake/pterodactyl-vsc
open-vsx ptero pterodactyl vsc-extension vsc-filesystem vscode-extension vscode-filesystem
Last synced: about 1 month ago
JSON representation
Pterodactyl server files in VS Code
- Host: GitHub
- URL: https://github.com/devtomatocake/pterodactyl-vsc
- Owner: DEVTomatoCake
- License: mit
- Created: 2024-01-27T08:36:23.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-24T04:01:49.000Z (4 months ago)
- Last Synced: 2024-08-25T04:44:59.782Z (4 months ago)
- Topics: open-vsx, ptero, pterodactyl, vsc-extension, vsc-filesystem, vscode-extension, vscode-filesystem
- Language: TypeScript
- Homepage: https://open-vsx.org/extension/tomatocake/pterodactyl-vsc
- Size: 842 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pterodactyl server files in VS Code
## Usage
1. Install the extension from the [VS Code marketplace](https://marketplace.visualstudio.com/items?itemName=TomatoCake.pterodactyl-vsc), [Open VSX](https://open-vsx.org/extension/tomatocake/pterodactyl-vsc), as VSIX by building it yourself, or by downloading it from the [releases page](https://github.com/DEVTomatoCake/Pterodactyl-vsc/releases).
2. Open the command palette (default: `Ctrl + Shift + P`) and run `Pterodactyl: Connect to server`.
3. Enter the panel URL and your client (not application) API key from "Account Settings" -> "API Credentials" -> Enter description -> "Create".
4. Select the server you want to edit the files of.
5. Done!
## Configuration
- `pterodactyl-vsc.panelUrl`: The URL of the Pterodactyl panel.
- `pterodactyl-vsc.serverId`: Server ID of the server you want to edit the files of, found in the URL of the server's page.
- `pterodactyl-vsc.apiKey`: Client API key of a panel account which has access to the server and enough permissions to view, edit and delete files.
- `pterodactyl-vsc.proxyUrl`: The proxy URL used to circumvent CORS blocking `fetch` requests to the panel. Leave it at the default value unless you know what you're doing. See [CORS Proxy](#cors-proxy) for more information.
## CORS Proxy
By default the extension uses the proxy URL `https://pterodactyl-vsc.tomatocake.workers.dev/?url=`.
The proxy was created by me to circumvent CORS blocking requests to the panel.
There are several options available if you don't want to use the default proxy:
1. Use your own proxy using the following worker code, e.g. by using the following [Cloudflare Workers](https://workers.cloudflare.com) code:
```js
export default {
async fetch(request) {
if (request.method == "OPTIONS") return new Response(void 0, {
status: 204,
headers: {
"Access-Control-Allow-Origin": "*",
"Access-Control-Allow-Headers": "authorization, content-type, accept"
}
})
if (request.method != "GET" && request.method != "POST") return new Response(void 0, {
status: 405
})
const proxyUrl = new URL(request.url).searchParams.get("url")
if (!proxyUrl) return new Response("Missing url param", { status: 400 })
let res = await fetch(proxyUrl, request)
if (request.headers.has("Origin")) {
res = new Response(res.body, res)
res.headers.set("Access-Control-Allow-Origin", "*")
res.headers.set("Access-Control-Allow-Credentials", "true")
}
return res
}
}
```
2. If you have access to the domain owning the panel, you can overwrite CORS headers to the panel's responses, e.g. using Cloudflares [Transform Rules](https://developers.cloudflare.com/rules/transform/#transform-rules):
> [!CAUTION]
> This will allow any website to access the panel's API using the credentials of the user who's logged in to the panel.
> If possible, always replace `*` with the hostname of the website the extension is used on, e.g. `vscode.dev`.
- Open the "Transform Rules" tab of your domain and create a new response header overwrite.
- Select "Custom filter".
- Select "Hostname" and enter the hostname (e.g. panel.example.com) of your panel.
- Select URI path with "Starts with" and enter `/api/client/servers/`.
- Add a new static response header with the key `Access-Control-Allow-Origin` and the value `*`.
3. If you want to build the extension yourself and you're only using it locally in the VS Code Desktop app, you can disable the web build of it by removing the `browser` property in the package.json. This works because only web-enabled extensions have to use the JavaScript Fetch API, which is affected by CORS.
## Credits
- Base from [microsoft/vscode-extension-samples](https://github.com/microsoft/vscode-extension-samples/tree/main/fsprovider-sample)
- Most of the logic from [kowd/vscode-webdav](https://github.com/kowd/vscode-webdav)