Skip to content

Commit

Permalink
doc: improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Yehonal committed Oct 22, 2022
1 parent baa1c8a commit 6a487be
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 45 deletions.
72 changes: 27 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,86 +30,68 @@ To open a terminal inside a specific folder in your operating system check [this
Now run this magic command sequence inside the downloaded folder to have everything up and running (with an interactive worldserver terminal):

```
docker compose pull
docker compose up -d ac-authserver
docker compose run --rm --service-ports ac-worldserver
docker compose up
```

**NOTE 1: The first installation will take a while because it needs to download the images from the docker hub and create the entire database before running the server**
**Wait for few minutes and you have an up and running AzerothCore!**

**NOTE 2: The commands above should not be used if you want to keep your server up and running. Please, follow the steps below to proper setup your environment**

Do you need a **game client**? check [this page](https://www.azerothcore.org/wiki/client-setup)!
The first installation will take a while because it needs to download the images from the docker hub and create the entire database before running the server**

## Step by step installation
### How to run in background

### Pull the latest images
If you need to run them in background instead you can use the following command:

```Bash
docker compose pull
```

This command will pull latest images from the docker hub

### Setup the database

```Bash
docker compose up ac-db-import
docker compose up -d
```

It runs the db-assembler tool to import all needed sql inside the mysql container
NOTE: this service is executed automatically by the auth and world server
**IMPORTANT:**

### Start services
* If the application crashes, docker will automatically restart the container for you

```Bash
docker compose up
```
## Access the worlserver console and create an account

To startup your authserver and worlserver
With **docker compose up** we have an up and running worldserver as well, but you need to access its interactive shell to
run commands on the worldserver.

**CONGRATULATIONS! now you have an up and running AzerothCore. You can already login with a compatible client**

NOTE: If you need to run them in background instead you can use the following command:
Open another terminal and use this command to access the worldserver console

```Bash
docker compose up -d
docker attach acore-docker-ac-worldserver-1
```

### Access the worlserver console and create an account
Now you can use the worlserver console to run azerothcore commands.

With **docker compose up** we have an up and running worldserver as well, but you need to access its interactive shell to
run commands on the worldserver.
To create an account you can use: `account create <user> <password> <confirm password>`

Run the following command to get the ID of the worlserver container:
NOTE: you can detach from a container and leave it running using the CTRL-p CTRL-q key sequence.

```Bash
docker compose ps
```
The list of GM commands is available [here](https://www.azerothcore.org/wiki/GM-Commands)

You will see a list of docker services. The worlserver service will have a name that ends with **_ac-worldserver_1**
Use that name together with the following command:
Do you need a **game client**? check [this page](https://www.azerothcore.org/wiki/client-setup)!

```Bash
docker attach <your-service-name>
```
## Ask for support

Now you can use the worlserver console to run azerothcore commands, including the "account create <user> <password>".
If you need support about the docker installation, use one of the following channels:

NOTE: you can detach from a container and leave it running using the CTRL-p CTRL-q key sequence.
* Join our discord community: https://discord.gg/mMgdcx37bA
* Report an issue on github: https://github.com/azerothcore/acore-docker/issues

If your issue is about the server or you want to report a bug, check our page on [How to ask for help](https://www.azerothcore.org/wiki/how-to-ask-for-help)

The list of GM commands is available [here](https://www.azerothcore.org/wiki/GM-Commands)

### Stop or restart the services
## Stop or restart the services

There are several commands to stop or restart the services, depending on your needs:

* **docker compose ps**: list all the running containers
* **docker compose stop** : just stops the current running services
* **docker compose restart** : restarts the current running services
* **docker compose down --remove-orphans** : stops and removes the containers.
* **docker compose down --rmi all -v --remove-orphans** : ⚠️ stops, removes, and deletes EVERYTHING. Including the volumes with the associated database ⚠️

### Update your services with latest images
## Update your services with latest images

You just need to combine the following commands:

Expand Down
1 change: 1 addition & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ services:
retries: 20

ac-worldserver:
container_name: acore-docker-ac-worldserver-1 # fixed container name to simplify the attach process
<<: *ac-shared-conf
stdin_open: true
tty: true
Expand Down

0 comments on commit 6a487be

Please sign in to comment.