Overview

1. Install prerequisites

2. Clone the project

3. Run the application

---

Install prerequisites

This project has been created for (Linux/MacOS).

Requisites:

• Git
• Docker
• Docker Compose

Check if docker-compose is already installed by entering the following command:

which docker-compose

On Ubuntu and Debian these are available in the meta-package build-essential. On other distributions, you may need to install the GNU C++ compiler separately.

sudo apt install build-essential

This project uses the following ports:

Server	Port
MySQL database server	3306
PHPMyAdmin	8080
Nginx web server	80
Game server	53595

---

Clone the project

Install Git, then clone the project:

git clone https://github.com/Marwolf/Open-RSC-Docker.git

Go to the project directory:

cd Open-RSC-Docker

---

Run the application

1. Start the Docker application:

   sudo make start
   

   Please wait this might take a several minutes...

   sudo make logs # Follow log output
   

2. Clone the required git repositories:

   sudo make clone
   

3. Import the required databases:

   sudo make import
   

4. Open your favorite browser:

   • http://localhost
   • http://localhost:8080 PHPMyAdmin (username: root, password: root)

5. Backup your databases:

   sudo make backup
   

6. Restore your databases:

   sudo make restore
   

7. Get help:

   sudo make help
   

8. Stop the application:

   sudo make stop
   

---

Additional commands

Name	Description
clone	Clone the git repository folders
pull	Get the latest git repository updates
start	Create and start containers
stop	Stop all containers
restart	Restart all containers
logs	Display log output
import	Import all databases from git repositories
backup	Create backup of all local databases
restore	Restore backup of all local databases
flush	Delete local git repository folders

---

Optional: configure Nginx With SSL Certificates

You can change the host name by editing the .env file.

If you modify the host name, do not forget to add it to the /etc/hosts file.

1. Configure Nginx:

   Do not modify the Website/etc/nginx/default.conf file, it is overwritten by Website/etc/nginx/default.template.conf

   Edit nginx file Website/etc/nginx/default.template.conf and uncomment the SSL server section :

   # server {
   #     server_name ${NGINX_HOST};
   #
   #     listen 443 ssl;
   #     fastcgi_param HTTPS on;
   #     ...
   # }
   

2. Copy your server.pem and server.key files in to the Website/etc/nginx/ssl folder and restart the application. (Lets Encrypt can register SSL certs for free)

   sudo make restart