H-O-O-T-S/Open-RSC-Docker-Home
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Major website overhaul

Browse Source
This commit is contained in:
Marwolf
2018-08-03 23:24:48 -04:00
parent 94ee33c14e
commit 8b1bf24555
79 changed files with 5444 additions and 292 deletions
Download Patch File Download Diff File Expand all files Collapse all files

111
README.md
View File

@@ -1,34 +1,67 @@
# Open RSC Docker Home [![Build Status](https://travis-ci.org/Open-RSC/Docker-Home.svg?branch=master)](https://travis-ci.org/Open-RSC/Docker-Home)
An easy to run RSC private server environment using Docker that works in Windows, Mac, and Linux.
![Death](https://i.imgur.com/tzLgEwV.png)
# 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)
___
## Operating systems supported
## Default Credentials <a name="credentials"></a>
* Windows 10 x64 (Not Windows 7)
#### 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 18.04 x64
* Ubuntu Linux 18.04 (or a derivative like Mint Linux)
* Fedora Linux 28 x64
* Fedora Linux 28
* CentOS 7 x64
[Return to top](#top)
___
## Choice 1: Download the zip, extract it, and open the "Docker-Home" folder
## 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
## Choice 2: Clone the project with git
#### Option 2: Clone the project with git
Install [Git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git), then clone the project:
@@ -36,17 +69,19 @@ Install [Git](http://git-scm.com/book/en/v2/Getting-Started-Installing-Git), the
git clone https://github.com/Open-RSC/Docker-Home.git
```
[Return to top](#top)
___
## Important for Windows users!
## Required Step For Windows Users <a name="windows"></a>
Open Docker and make your drives available to your Docker containers:
![Shared drives setting](https://i.imgur.com/6YsGkoZ.png)
[Return to top](#top)
___
## Run the scripts
## Setup Process <a name="setup"></a>
1. Perform the first time setup:
@@ -112,43 +147,36 @@ ___
Windows: "Stop_Game_Windows.cmd"
```
[Return to top](#top)
___
## Ready to host a public version on your own VPS?
## Steps to Host on a VPS <a name="vps"></a>
You will need to edit:
* PHPMyAdmin's MySQL users
#### PHPMyAdmin MariaDB SQL users
* Create a new user in PHPMyAdmin, grant permissions, remove existing users.
* Secure your users by making them only accessible from specific hostnames
* Use % for the host associated with the user. Docker containers get fresh IPs, the setup script configures firewall to block external access to MariaDB and the Docker container for MariaDB is bound to localhost.
* Each Docker container will have it's own assigned internal IP address.
#### Launcher main.java
* Examples:
* openrsc_forum @ 172.18.0.3 (only accessible via Nginx Docker container)
* openrsc_game @ 172.18.0.1 (only accessible via locally running Open RSC game server)
* Marwolf @ 172.18.0.4 (only accessible via PHPMyAdmin Docker container)
* Avoid: % for any host (risks allowing remote brute force MySQL server attacks)
* Launcher's main.java
* Edit: /Docker-Home/Game/Launcher/src/Main.java
* Edit: "/Docker-Home/Game/Launcher/src/Main.java"
* Replace with your domain / IP: private static String URL = "http://localhost";
* Client's config.java
* Compile and copy result from "/Docker-Home/Game/Launcher/dist/Open_RSC_Launcher.jar" to "/Docker-Home/Website/downloads/Open_RSC_Launcher.jar"
* Edit: /Docker-Home/Game/client/src/org/openrsc/client/Config.java
#### Client config.java
* Edit: "/Docker-Home/Game/client/src/org/openrsc/client/Config.java"
* Replace with your domain / IP: public static String IP = "localhost";
* Server's config.xml
* Compile and compress "/Docker-Home/Game/Launcher/dist/Open_RSC_Launcher.jar" as "/Docker-Home/Game/Launcher/dist/client.zip" then copy "/Docker-Home/Game/Launcher/dist/client.zip" to "/Docker-Home/Website/downloads/client.zip"
#### Server config.xml
* Edit: /Docker-Home/Game/server/config/config.xml
@@ -156,28 +184,13 @@ You will need to edit:
* Replace with your newly created SQL user pass: <entry key="dbpass">root</entry>
* Website's board/config.php
* Edit: /Docker-Home/Website/board/config.php
* Replace with your newly created SQL username: $dbuser = 'root';
* Replace with your newly created SQL user pass: $dbpasswd = 'root';
* Website's client.zip file
* Compile changes for your client and compress "Open_RSC_Client.jar" as client.zip
* Location: /Docker-Home/Game/client/dist/Open_RSC_Client.jar
* Copy result to: /Docker-Home/Website/downloads/client.zip
* Website's downloads/hashes.txt
#### Website downloads/hashes.txt
* Edit: /Docker-Home/Website/downloads/hashes.txt
* Replace with updated md5sum hashes of your client.zip and cache.zip (likely you only will replace client.zip)
* Replace with updated md5sum hashes of client.zip and cache.zip (likely you only will replace client.zip's hash)
* Obtain MD5sum via md5sum *.zip
* Obtain MD5sum via command: "md5sum *.zip"
___
[Return to top](#top)