diff --git a/source/faq.rst b/source/faq.rst index 1d34e84..3888acc 100644 --- a/source/faq.rst +++ b/source/faq.rst @@ -24,11 +24,6 @@ Q: Where are the servers located? PufferPanel stores all the servers in ``/var/lib/pufferpanel/servers``. -Q: Can I migrate from v1 to v2? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -At this time, we do not have a migration path to v2. Due to the changing nature of v2, we do not want to have to deal with rewriting migrations if we have to make changes. Once v2 is more stable, we will have a migration tool to help move from v1 to v2. - Q: How do I disable user registration? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -48,19 +43,6 @@ Generic templates for "X" bot/bot library don't exist, each project works differ You'll need to create a template for them yourself, this is quite straight forward and there are plenty of `example templates `_ to work from. -Q: I am getting permission errors with my files -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Stop messing with your files outside of PufferPanel. PufferPanel does not run under a "special" user that ignores permissions on files. If you are mucking with them outside of the SFTP credentials provided by the panel, it *WILL* screw them up. - -To fix it, you can run ``chown -R pufferpanel:pufferpanel /var/lib/pufferpanel`` to fix the permissions once. If you run into this error again, re-read this entire block. - -Q: I am having a port conflict, how do I change the port? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Update the port in ``web.host`` in the panels config (``/etc/pufferpanel/config.json``). - - Note: The _only_ reason to ever do this, is for handling port conflicts. When you want to have your game panel exposed over the internet, you should **always** `use a reverse proxy to setup TLS `_, to ensure your server remains secure. Q: Where do I find my servers IP address? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/source/index.rst b/source/index.rst index 3c42b13..3945d43 100644 --- a/source/index.rst +++ b/source/index.rst @@ -10,6 +10,7 @@ PufferPanel - Open Source Game Server Management docker faq featuretour + troubleshooting .. toctree:: :maxdepth: 1 diff --git a/source/troubleshooting.rst b/source/troubleshooting.rst new file mode 100644 index 0000000..78d0f2c --- /dev/null +++ b/source/troubleshooting.rst @@ -0,0 +1,45 @@ +Troubleshooting +=============== + +How do I know what to do? +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Take a look at your logs and at the service, look for any unusual behavior to get a direction on where to look if you don't have one already. + + Logs are generally stored ``/var/log/pufferpanel/`` + + Service can be checked with ``systemctl status pufferpanel`` + + +I am getting permission errors with my files +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If the executable is showing a permission denied error, then it may be a problem with the template as the steamdownload may require you to set the executable permission, this can be done by adding ``chmod +x `` to the end of your install process + +However if the permission error is cause by you messing with PufferPanel files outside of the provided file editing options (web-based file editor, sftp) we highly advice against doing that. + +To fix it, you can run ``chown -R pufferpanel:pufferpanel /var/lib/pufferpanel`` to fix the permissions once. If you run into this error again, re-read this entire block. + + +I am having a port conflict, how do I change the port? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +It should be noted ports below 1024 can't be bound to by PufferPanel as those require root permissions which pufferpanel by design doesn't have due to them not being neccesary. + +Update the port in ``web.host`` in the panels config (``/etc/pufferpanel/config.json``). + + Note: The **only** reason to ever do this, is for handling port conflicts. **If** you want to have your game panel exposed over the internet, you should **always** `use a reverse proxy to setup TLS `_, to ensure your server remains secure. + + +I've setup PufferPanel at home, but my friend can't join. +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In this case we can't provide a universal solution but simply can tell you to forward the gameservers port via your router, as this process differs between models and manufacturers we advice to look at the routers manual. + + +I still have Problem XYZ, what should i do? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If all of the above didn't resolve your problem feel free to come to our Discord server in the support channel or create a discussion on Github (slower). Make a post with all the information you collected up until now and tell us more about your hosting environment as some providers may have secondary firewalls in place. + + Please note it may get embarrassing if you get sent a link to this page as an answer to your post