diff options
author | Trond B. Krokli <38162891+illfated@users.noreply.github.com> | 2021-01-17 16:33:19 +0100 |
---|---|---|
committer | Shauren <shauren.trinity@gmail.com> | 2022-03-06 00:26:01 +0100 |
commit | d67788a44d47e5cb359f210f9f003256fd4681ef (patch) | |
tree | fe084b318098cc20de6b28e314af2c9752eb2f25 /contrib/Docker/README.md | |
parent | c2068bd4232c7e88037ee9f7590cf817fc6ac0c0 (diff) |
Docker/Readme: codestyle cleanup (9af6bf1 follow-up) (#25864)
* Docker/Readme: codestyle cleanup
Changes proposed:
- Simplify MD back tick usage in stand-alone horizontal strings.
- Sentence grammar improvements/adjustments (might->may etc.)
- Punctuation: Add a period dot at the end of proper sentences.
- Punctuation: Add Oxford commas for natural readability.
- Punctuation: Add colon at the end of sentence introducing command examples.
- Reduce indentation level for bullet point annotation from second level to first level.
- Spell Linux with a capital L (proper noun, from "Linus + UNIX").
- UNIX is a proper noun with all its letters in uppercase.
- Remove a stray double quote character from the start of a command.
- Replace HTML entity . with its ASCII representation, a period dot.
Whitespace changes:
- add editorial blank line below H1 (page title) and H2 headings
- add editorial blank line below MD code block fences (codestyle)
* Lowercase 'pch' job name
- "PCH" -> pch
* Revert HTML entity change in README dot md
- Revert README.md to its original `README.md` spelling to avoid coding issues.
* Update contrib/Docker/README.md
Co-authored-by: Trond B. Krokli <38162891+illfated@users.noreply.github.com>
Co-authored-by: Giacomo Pozzoni <giacomopoz@gmail.com>
(cherry picked from commit 3a61fe3c31b3fc61d3b881196319ccd96d69c7e4)
Diffstat (limited to 'contrib/Docker/README.md')
-rw-r--r-- | contrib/Docker/README.md | 64 |
1 files changed, 36 insertions, 28 deletions
diff --git a/contrib/Docker/README.md b/contrib/Docker/README.md index 8250cf72592..79dd6853f05 100644 --- a/contrib/Docker/README.md +++ b/contrib/Docker/README.md @@ -1,31 +1,37 @@ # Docker -Circle CI linux pch job uses the Dockerfile contained in the same folder as this README to create an image with the binaries built for linux and store that in the job artifacts. - -The instructions below expect basic knowledge about how to configure TrinityCore and how to use Docker: -1. Click on the green ✔ next to each commit -1. Scroll to "ci/circleci: pch" and click on "Details" -1. Login to Circle CI if necessary. You might have to repeat again the previous steps after logging in to reach the correct page -1. Click on "Artifacts" tab in Circle CI website -1. Download the docker.tar.gz archive containing the docker image -1. Load the image into your Docker host using + +The Circle CI Linux pch job uses the Dockerfile contained in the same folder as this README to create an image with the binaries built for Linux, and stores that in the job artifacts. + +The instructions below expect a basic knowledge of how to configure TrinityCore and how to use Docker: +1. Click the green tick ✔ next to each commit. +1. Scroll to "ci/circleci: pch" and click "Details". +1. Log in to Circle CI if necessary. You may have to repeat the previous steps after logging in, to reach the correct page. +1. Click the "Artifacts" tab in the Circle CI website. +1. Download the docker.tar.gz archive containing the docker image. +1. Load the image into your Docker host, using the following command: ``` docker load -i docker.tar.gz ``` -1. Copy the .conf and .pem files from TrinityCore GitHub repository to a local folder that will be passed as mapped volume to docker -1. Set the MySQL host in the .conf files to use the unix socket of MySQL, i.e.: ``".;/var/run/mysqld/mysqld.sock;username;password;database`` -1. Set the "DataDir" config in worldserver.conf to ``"/trinity/data"`` -1. Start bnetserver or worldserver as desired, mapping the required volumes - - bnetserver - ``` - docker run --entrypoint=bnetserver -it --volume=/host/path/to/configs:/home/circleci/project/bin/check_install/etc --volume=/var/run/mysqld/mysqld.sock:/var/run/mysqld/mysqld.sock -p=1119:1119 -p 8081:8081 "image name" - ``` - - worldserver - ``` - docker run --entrypoint=worldserver -it --volume=/host/path/to/configs:/home/circleci/project/bin/check_install/etc --volume=/var/run/mysqld/mysqld.sock:/var/run/mysqld/mysqld.sock --volume=/path/to/data/directory:/trinity/data -p=8085:8085 -p 8086:8085 "image name" - ``` - Change the ports and other parameters as needed. Consult Docker documentation for additional details about possible configuration settings. + +1. Copy the .conf and .pem files from the TrinityCore GitHub repository to a local folder which will be passed on as a mapped volume to docker. +1. Set the MySQL host in the .conf files to use the UNIX socket of MySQL, i.e.: `".;/var/run/mysqld/mysqld.sock;username;password;database"` +1. Set the "DataDir" config in worldserver.conf to `"/trinity/data"` +1. Start bnetserver or worldserver as desired, mapping the required volumes: + +- bnetserver + ``` + docker run --entrypoint=bnetserver -it --volume=/host/path/to/configs:/home/circleci/project/bin/check_install/etc --volume=/var/run/mysqld/mysqld.sock:/var/run/mysqld/mysqld.sock -p=1119:1119 -p 8081:8081 "image name" + ``` + +- worldserver + ``` + docker run --entrypoint=worldserver -it --volume=/host/path/to/configs:/home/circleci/project/bin/check_install/etc --volume=/var/run/mysqld/mysqld.sock:/var/run/mysqld/mysqld.sock --volume=/path/to/data/directory:/trinity/data -p=8085:8085 -p 8086:8086 "image name" + ``` + +Change the ports and other parameters as needed. Consult Docker documentation for additional details about possible configuration settings. ## Content + The image contains: - bnetserver - mapextractor @@ -39,16 +45,18 @@ You can explore the image using ``` docker run --entrypoint=/bin/bash -it "image name" ``` -Note that the WORKDIR is set to /home/circleci and by default all logs will be saved in that folder. You can export the logs from the container with + +Note that the WORKDIR is set to /home/circleci and all logs will be saved to that folder by default. You can export the logs from the container with ``` docker cp "container name":/home/circleci/name.log name.log ``` -For more instructions please check docker official documentation. +For more instructions, please check the official docker documentation. ## Limitations: -- Database connection: the instructions provided expect MySQL to run on the host machine. Change ``docker run`` parameters and .conf settings to fit your scenario + +- Database connection: The instructions provided expect MySQL to run on the host machine. Change `docker run` parameters and .conf settings to fit your scenario. - To import TDB using the autoupdater: - 1. Download the TDB sql file from GitHub - 1. Map it with ``--volume=/path/to/TDB_full_name.sql:/home/circleci/TDB_full_name.sql`` added to the commands specified in the main steps above - 1. Run the container + 1. Download the TDB sql file from GitHub. + 1. Map it with `--volume=/path/to/TDB_full_name.sql:/home/circleci/TDB_full_name.sql` added to the commands specified in the main steps above. + 1. Run the container. |