212 lines
5.7 KiB
Markdown
212 lines
5.7 KiB
Markdown
# Open RSC Docker Home [](https://travis-ci.org/Open-RSC/Docker-Home)
|
|
|
|
|
|
|
|
# Table of contents <a name="top"></a>
|
|
1. [Project Introduction](#introduction)
|
|
1. [Default Credentials](#credentials)
|
|
2. [Minimum Requirements](#requirements)
|
|
3. [How to Obtain Open RSC](#obtain)
|
|
4. [Required Step For Windows Users](#windows)
|
|
5. [Setup Process](#setup)
|
|
6. [Steps to Host on a VPS](#vps)
|
|
|
|
|
|
## Project Introduction <a name="introduction"></a>
|
|
|
|
Choices:
|
|
|
|
1. Single player RSC game + basic database editing (PHPMyAdmin)
|
|
2. Game + Website + PHPMyAdmin
|
|
|
|
[Return to top](#top)
|
|
___
|
|
|
|
## Default Credentials <a name="credentials"></a>
|
|
|
|
#### Website
|
|
|
|
Username: admin@openrsc.com
|
|
|
|
Password: malwareinfection
|
|
|
|
|
|
#### Database
|
|
|
|
Username: root
|
|
|
|
Password: root
|
|
|
|
[Return to top](#top)
|
|
___
|
|
|
|
## Minimum Requirements (suggested use a VPS host or a VirtualBox VM) <a name="requirements"></a>
|
|
|
|
* Windows 10 (sorry, no Windows 7 due to Docker for Windows incompatibility)
|
|
|
|
* Mac OS X High Sierra
|
|
|
|
* Ubuntu Linux 16.04 and above (or a derivative like Mint Linux)
|
|
|
|
* Fedora Linux 28
|
|
|
|
* CentOS 7 x64
|
|
|
|
[Return to top](#top)
|
|
___
|
|
|
|
## How to Obtain Open RSC <a name="obtain"></a>
|
|
|
|
#### Option 1: Download the zip, extract it, and open the "Docker-Home" folder
|
|
|
|
https://github.com/Open-RSC/Docker-Home/archive/master.zip
|
|
|
|
#### Option 2: Clone the project with git
|
|
|
|
Install [Git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git), then clone the project:
|
|
|
|
```sh
|
|
git clone https://github.com/Open-RSC/Docker-Home.git
|
|
```
|
|
|
|
[Return to top](#top)
|
|
___
|
|
|
|
## Required Step For Windows Users <a name="windows"></a>
|
|
|
|
Open Docker and make your drives available to your Docker containers:
|
|
|
|
|
|
|
|
[Return to top](#top)
|
|
___
|
|
|
|
## Setup Process <a name="setup"></a>
|
|
|
|
1. Perform the first time setup:
|
|
|
|
```sh
|
|
Mac/Linux: ./Setup_Linux_Mac.sh
|
|
```
|
|
|
|
```sh
|
|
Windows: "Setup_Windows.cmd"
|
|
```
|
|
|
|
2. Open your favorite browser:
|
|
|
|
* [http://localhost](http://localhost)
|
|
* [http://localhost:9000](http://localhost:9000) PHPMyAdmin (default username: root, password: root)
|
|
* [http://localhost:8080](http://localhost:8080) Apache Tomcat webserver, used to serve files over HTTP
|
|
|
|
3. Start the game's Docker containers, then run the game server and client:
|
|
|
|
```sh
|
|
Mac/Linux: ./Start_Single_Player_Game_Linux_Mac.sh
|
|
```
|
|
|
|
```sh
|
|
Windows: "Start_Single_Player_Game_Windows.cmd"
|
|
```
|
|
|
|
4. Backup game databases:
|
|
|
|
```sh
|
|
Mac/Linux: ./Backup_Game_Databases_Linux_Mac.sh
|
|
```
|
|
|
|
```sh
|
|
Windows: "Backup_Game_Databases_Windows.cmd"
|
|
```
|
|
|
|
5. Restore game databases:
|
|
|
|
```sh
|
|
Mac/Linux: ./Restore_Game_Database_Backup_Linux_Mac.sh
|
|
```
|
|
|
|
```sh
|
|
Windows: "Restore_Game_Database_Backup_Windows.cmd"
|
|
```
|
|
|
|
6. Stop the game's Docker containers and shut down the game server:
|
|
|
|
```sh
|
|
Mac/Linux: ./Stop-Game-Linux_Mac.sh
|
|
```
|
|
|
|
```sh
|
|
Windows: "Stop_Game_Windows.cmd"
|
|
```
|
|
|
|
[Return to top](#top)
|
|
___
|
|
|
|
## Steps to Host on a VPS <a name="vps"></a>
|
|
|
|
* Execute "Setup_Linux_Mac.sh"
|
|
|
|
* Follow the steps to install needed programs
|
|
|
|
* Select "2. Deployment for a publicly hosted server"
|
|
|
|
* You will be prompted to edit specific files. Below is how to do each:
|
|
|
|
#### PHPMyAdmin MariaDB SQL users
|
|
|
|
* Create a new user in PHPMyAdmin, grant it all permissions, remove pre-existing users.
|
|
|
|
* Use % for the host associated with the new user. Docker containers do not have static IP addresses and we are using the PHPMyAdmin Docker container to connect to the MariaDB Docker container. Each has a unique internally assigned IP address that is not localhost. The Docker container port of tcp/3306 for MariaDB is bound to the server as localhost so there should be no threat of external connections.
|
|
|
|
#### .env
|
|
|
|
* This is located in "Docker-Home/.env"
|
|
|
|
* The main website is running through Ghost CMS. For the section starting with # Ghost:
|
|
|
|
* Edit: "URL=http://localhost"
|
|
|
|
* You will need to reload all docker containers. Shortcut command: "sudo make stop && sudo make start"
|
|
|
|
* Nginx has a hostname reference for localhost as "NGINX_HOST=localhost" under the # Nginx section. It can be safely left alone at this time.
|
|
|
|
* For the section starting with # MySQL:
|
|
|
|
* Set the username and password that have been granted root privileges in MariaDB SQL that you just created in the previous step with PHPMyAdmin where it reads "MYSQL_ROOT_USER=root" and "MYSQL_ROOT_PASSWORD=root"
|
|
|
|
#### Server config.xml
|
|
|
|
* Edit: /Docker-Home/Game/server/config/config.xml
|
|
|
|
* Replace with your newly created SQL username: <entry key="dblogin">root</entry>
|
|
|
|
* Replace with your newly created SQL user pass: <entry key="dbpass">root</entry>
|
|
|
|
### Website config import:
|
|
|
|
* Visit http://localhost/ghost
|
|
|
|
* If it wants to set up a first user, go for it.
|
|
|
|
* If it already has Open RSC news articles, login with admin@openrsc.com / malwareinfection
|
|
|
|
* Either way, click on "Labs" once logged in
|
|
|
|
* Click "Browse" beside "Import content" and select ""/Docker-Home/website_backup.json"
|
|
|
|
#### Run_Production_Linux_Game_Server.sh
|
|
|
|
* Compiles client, launcher, and server.
|
|
|
|
* Copies "Docker-Home/Game/client/cache.zip" to "Docker-Home/Website/downloads/cache.zip"
|
|
|
|
* Copies "Docker-Home/Game/Launcher/Open_RSC_Launcher.jar" to "Docker-Home/Website/downloads/Open_RSC_Launcher.jar"
|
|
|
|
* Compresses then copies "Docker-Home/Game/client/client.zip" to "Docker-Home/Website/downloads/client.zip"
|
|
|
|
* Md5sums client.zip and cache.zip in "Docker-Home/Website/" and outputs to hashes.txt
|
|
|
|
* Starts the game server in a detached screen console. Access via "screen -r", return via "Ctrl + A + D", exit via "Ctrl + C"
|
|
|
|
[Return to top](#top)
|