Docker compose support

[Humberd]

Docker Compose

There is also a way of running the server + database at once using docker-compose.
By default it:

• Creates a database named forgottenserver.
• Executes schema.sql file, so that you don't have to manually import it.
• Saves all the database files inside a ./db local directory.

Preparation:

1. Update your configu.lua.dist with these values, so that server properly connects to the database:

-- MySQL
mysqlHost = "db"
mysqlUser = "forgottenserver"
mysqlPass = "<your_db_password>"
mysqlDatabase = "forgottenserver"
mysqlPort = 3306
mysqlSock = ""

2. Change your database user password by replacing
   <your_db_password> with your password of choice.
   Remember to also update it in docker-compose.yml.

3. Change your database root password by replacing
   <your_root_password> in docker-compose.yml.

Start:

docker-compose up -d

Stop:

docker-compose down

Rebuild container after source code changes:

docker-compose up -d --build

Created services:

1. The Forgotten Server - localhost:7171, localhost:7172.
2. Database - direct connection hidden to the outside world.
3. Database explorer - localhost:8080. Allows viewing what's inside the database.

Docker-compose issues:

1. During startup the server container is created after database, however, the database might not be initially available.
   This is why the server will restart a couple of times before it successfully establishes the connection.

2. If you are using Docker Toolbox for Windows and it uses VirtualBox,
   then the server and database explorer address host name will be 192.168.99.100 insead of localhost.

[ghost]

are those changes on config.lua.dist really necessary?

[DSpeichert]

See #2687

[Humberd]

@EPuncker yea, you are right. Will remove it later today

[Humberd]

@DSpeichert my changes are simpler and dont require additional scripts

[Humberd]

@EPuncker I reverted all the changes from config.lua.dist. User now has to configure database connection by himself. What is more I added detailed description what to edit in the README.

[Humberd]

Bump

[soul4soul]

This project don't use the repo for documentation. This project uses the wiki feature of github for documentation. Consider undoing the changes to the readme.md. Update the OP to include code blocks with the any documentation you have written. Promise you will update the wiki with the new docker documentation if these changes are merged.

I don't think anyone would object to you adding a 3rd bullet point under the Getting Started header which links directly to a new docker wiki page.

[Humberd]

@soul4soul Removed documentation from README. To add new wiki page I would need some permissions.

[Znote]

https://github.com/otland/forgottenserver/wiki/Docker-Compose

[DSpeichert]

Try MYSQL_RANDOM_ROOT_PASSWORD: '1'

[ranisalt]

I would use MYSQL_RANDOM_ROOT_PASSWORD instead. It does not need a root account at all, and the less privileges, the better.

[DSpeichert]

Instead of that, try running both containers in the same network namespace and run a script that allows no password from localhost for the user.

Alternatively, try sharing a unix socket and using https://mariadb.com/kb/en/authentication-plugin-unix-socket/

[ranisalt]

@DSpeichert that's not trivial with Docker, and I think he wants the password to be used in this "adminer" container below - I didn't even Google it, but it looks like phpMyAdmin.

[DSpeichert]

Sharing unix socket may not be easy due to uid mapping but sharing network namespaces is very easy with docker-compose:

...
services:
  db:
    ...
  pma:
    network_mode: "service:db"
    ...
...

[Xaekai]

I'd move this up a line, because compiling and docker are in a similar sphere related to service deployment, whereas scripting is in the sphere of dataset content creation.

[ranisalt]

I would use MYSQL_RANDOM_ROOT_PASSWORD instead. It does not need a root account at all, and the less privileges, the better.

[ranisalt]

I would use a volume here, instead of relying on the host file system.

[DSpeichert]

It's unusually hard to fish the files out of a docker-managed volume and the point here is for the data to persist, so I think this is the easy to understand option here.

[ranisalt]

Why would you want to extract raw files from a database storage? It's not like you can do anything more with them out of the container.

[DSpeichert]

You can back them up and run a server out of them, see mariabackup etc.

[ranisalt]

You can do the very same with volumes, just prepend docker exec to the same mysqldump -u <user> -p <password> <db> you would run.

[ranisalt]

@DSpeichert that's not trivial with Docker, and I think he wants the password to be used in this "adminer" container below - I didn't even Google it, but it looks like phpMyAdmin.

[gesior]

I think we should also change:

RUN cmake .. && make

to:

RUN cmake .. && make -j $(nproc)

in Dockerfile or make it use shared build folder, to do not recompile all files, after every little change in .cpp file.

[DSpeichert]

Closing this as abandoned, but it could use a refresh and maybe make its way into the wiki instead.
There seems to be so many ways of running TFS, it may not be worth adding each method to the source repo.