pterodactyl / documentation

Pterodactyl's documentation is open source! This repository contains the documentation for installing and updating both the panel and the daemon.
MIT License
152 stars 1k forks source link

Request: Definite firewall/port requirements in documentation #540

Closed lowland3r closed 1 day ago

lowland3r commented 1 year ago

Please consider adding a section to the Panel and Wings installation guide that includes the ports required for each component to work (as well as what ports can be access-restricted)

zvikasdongre commented 1 year ago

There is a section in which the diagram of all services are shown in docs. Please have a look at Pterodactyl Terminology (Advanced Setup Diagram)

image

lowland3r commented 1 year ago

Indeed, though this doesn't fully clarify what ports on the wings node must be accessible to the panel vs accessible to the world.

I know that tcp/2022 must be reachable by end users, but what about tcp/8080?

zvikasdongre commented 1 year ago

Technically you don't need to make tcp/8080 public, but it would be necessary if you want to monitor the wings on a server. And making the port tcp/8080 accessible only by the panel's ip will cause the node list to show red heart because the request to node is made from the user's browser, not from the panel, other than that, I think it should be fine.

Also, yeah I agree this information needs to be included docs.

MinerPL commented 1 year ago

Both ports (tcp/8080 and tcp/2022) must be accessible by the end user. Port tcp/8080 is responsible for WebSocket communications as well as downloading files.

zvikasdongre commented 1 year ago

Oh yeah, sorry my bad, forgot about websockets and file download connections. 😅

rowansc1 commented 1 month ago

To be honest, I think that the terminology in the docs does a pretty good job.

I don't personally think this needs any further explanation. Please feel free to elaborate if you disagree.

Perhaps, it may be worth including a link in the installation guide to make it easier to find? I'm open to suggestions!

rowansc1 commented 1 day ago

Closing due to inactivity.