summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBenjamin Jackson <38561765+heyitsbench@users.noreply.github.com>2022-12-28 16:39:23 -0500
committerGitHub <noreply@github.com>2022-12-28 22:39:23 +0100
commit4b2781737ab0e256758731d50a2341f42a7f77f3 (patch)
treeb0b2e28c0084ac21f8757d01e0f27a7fb079b08a /docs
parentfb0a05e4831ea6661d157b4834def691e9b94e11 (diff)
downloadwiki-4b2781737ab0e256758731d50a2341f42a7f77f3.tar.gz
wiki-4b2781737ab0e256758731d50a2341f42a7f77f3.tar.bz2
wiki-4b2781737ab0e256758731d50a2341f42a7f77f3.zip
Fix a bunch of small things with how-to-restart-and-debug. (#848)
Diffstat (limited to 'docs')
-rw-r--r--docs/how-to-restart-and-debug.md44
1 files changed, 22 insertions, 22 deletions
diff --git a/docs/how-to-restart-and-debug.md b/docs/how-to-restart-and-debug.md
index 61d8a7e..d218eee 100644
--- a/docs/how-to-restart-and-debug.md
+++ b/docs/how-to-restart-and-debug.md
@@ -4,39 +4,39 @@ tableofcontents: 1
# How to restart and debug
-AzerothCore is composed by 2 services: authserver and worldserver.
+AzerothCore is composed of two services: authserver and worldserver.
Authserver only acts as an authenticator and a router for your realms redirecting your authorized client connections to the selected realm address.
-the Worldserver instead handles all connections related to the game mechanics and it's the single source of truth for everything related to a single realm.
+The worldserver instead handles all connections related to the game mechanics and it is the single source of truth for everything related to a single realm.
-Authserver and Worldservers can be placed to different environment, however, in the following guide we will explain you how to run them together on same environment.
+Authserver and worldservers can be placed on different environments. However, in the following guide we will explain how to run them together on the same environment.
-## how to start the services
+## How to start the services
-both authserver and worldserver can be started by simply run the compiled binaries after [completing the installation](https://www.azerothcore.org/wiki/Installation).
+Both authserver and worldserver can be started by simply running the compiled binaries after [completing the installation](https://www.azerothcore.org/wiki/Installation).
-## how to configure a restarter
+## How to configure a restarter
-Restarting and debugging an application works in many different way depending on your operating system. That's why we always suggest to use our docker solution that is fully supported on all platforms.
+Restarting and debugging an application works in many different ways depending on your operating system. That is why we always suggest to use our Docker solution that is fully supported on all platforms.
-However, if you need to keep your server up and running after a crash and checking what's going on with your code, you can do it using a restarter and a debugger.
+However, if you need to keep your server up and running after a crash and checking what is going on with your code, you can do it using a restarter and a debugger.
-Below are going to explain how to use our integrated restarter scripts and the [GDB](https://www.gnu.org/software/gdb/) debugger utility also to generate crash-dumps
+Below is an explanation on how to use our integrated restarter scripts and the [GDB](https://www.gnu.org/software/gdb/) (GNU Project Debugger) utility as well to generate crash-dumps.
### Restarter using acore dashboard (only for bash)
-You can use `./acore.sh run-worldserver` and `./acore.sh run-authserver`
+You can use `./acore.sh run-worldserver` and `./acore.sh run-authserver`.
They both work out of the box when you compile with the dashboard.
-**NOTE**: To enable GDB you can use `AC_RESTARTER_WITHGDB=true` as an environment variable or by adding this to your `/conf/config.sh` file.
-After enabled GDB, if the server crashes, you will find the crashdump file (gdb.txt) within the /env/ folder. **Keep in mind that you should compile your code with one of the following compilation types: Debug or RelWithDebInfo, otherwise GDB won't work properly**
+**NOTE**: To enable GDB, you can use `AC_RESTARTER_WITHGDB=true` as an environment variable or by adding it to your `/conf/config.sh` file.
+If the server crashes after enabling GDB, you will find the crashdump file (gdb.txt) within the /env/ folder. **Keep in mind that you should compile your code with one of the following compilation types: Debug or RelWithDebInfo, otherwise GDB will not work properly**
-### Using docker (crossplatform)
+### Using Docker (cross-platform)
-Our docker system integrates the scripts above within the docker-compose. It means that enabling the GDB works exactly in the same way in docker too.
+Our Docker system integrates the scripts above within the docker-compose. It means that enabling GDB works exactly in the same way in Docker too.
Moreover our docker-compose uses the [restart-policy feature](https://docs.docker.com/config/containers/start-containers-automatically/) to keep the containers up and running.
-For more information please refer to the [Install-with-Docker](install-with-docker.md) documentation.
+For more information, please refer to the [Install-with-Docker](install-with-docker.md) documentation.
You will also find a guide on how to debug your code by using VSCode combined with its Remote Docker extension.
### Advanced restarter (only for bash)
@@ -47,7 +47,7 @@ Here you can find the restarters for linux/bash environments: https://github.com
Those scripts are automatically copied after the compilation to the `/dist` directory if you're using our `./acore.sh` dashboard
-You can copy the `conf.sh.dist` and create a `conf-world.sh` file to customize those documented configurations (do the same for the `conf-auth.sh`). In this way, you have both restarter and gdb pre-configured to create a `gdb.txt` (crashdump) file when the core crashes. Make sure to use `RelWithDebInfo` or `Debug` compilation (in your CMake command) in order to get meaningful crash reports.
+You can copy the `conf.sh.dist` and create a `conf-world.sh` file to customize those documented configurations (do the same for the `conf-auth.sh`). This way you will have both the restarter and GDB pre-configured to create a `gdb.txt` (crashdump) file when the core crashes. Make sure to use `Debug` or `RelWithDebInfo` compilation (in your CMake command) in order to get meaningful crash reports.
Then copy the `restarter-world.sh` and the `restarter-auth.sh` from the "examples" beside your conf file and in the same folder of the "run-engine" file.
@@ -55,12 +55,12 @@ Eventually you will have something like this:
[![example][1]][1]
-Run those 2 restarter script to have both authserver and worldserver restarters with gdb support.
+Run those two restarter scripts to have both authserver and worldserver restarters with GDB support.
### Manual way (crossplatform)
-Always make sure to use **RelWithDebInfo** or **Debug** compilation (in your CMake command) in order to get meaningful crash reports.
+Always make sure to use **Debug** or **RelWithDebInfo** compilation (in your CMake command) in order to get meaningful crash reports.
Create a file called `gdb.conf` with this inside:
@@ -72,21 +72,21 @@ Create a file called `gdb.conf` with this inside:
info thread
thread apply all backtrace full
-Then, to debug or create a crashdump you can just use the gdb command as described in its documentation:
+To debug or create a crashdump, you can then use the GDB command as described in its documentation:
```
gdb -x gdb.conf --batch ./worldserver
```
-This command should be enough to both attach your IDE to debug your code and also generate a crashdump when the server crashes
+This command should be enough to both attach your IDE to debug your code and also generate a crashdump when the server crashes.
-For an "universal" and more advanced restarter, Personally I'm using [PM2][2]
+For a more advanced and "universal" restarter, personally I'm using [PM2][2].
```
pm2 start "gdb -x gdb.conf --batch ./worldserver"
```
-It should be enough to automatically restart, monitoring and gdb your server
+It should be enough to automatically restart, monitor, and utilize GDB with your server.
[1]: https://i.stack.imgur.com/EyIi7.png