Difference between revisions of "Web Launcher Quick Start"

From Legends of Aria Admin and Modding Wiki
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
This is a quick and dirty guide to accessing web launcher to setup and run a simple cluster of region servers. This guide assumes you have not yet used web launcher at all. For in-depth details and configuration of web launcher see [[Web_Launcher_Reference|Web Launcher  Reference]]
 
This is a quick and dirty guide to accessing web launcher to setup and run a simple cluster of region servers. This guide assumes you have not yet used web launcher at all. For in-depth details and configuration of web launcher see [[Web_Launcher_Reference|Web Launcher  Reference]]
 +
 +
'''''NOTE:''''' By default a fresh web launcher setup is configured to launch all regions that make up the world. This will require a single server with at least 32gb of RAM to not crash and run into issues. Make sure you have a powerful enough machine, or turn off some regions! Optimal setups for production servers are essentially 2+ dedicated machines, with as high of a single core clock speed as possible, 32+ GB ram each, and SSD disk drive.
  
 
===Step I Login to Web Launcher===
 
===Step I Login to Web Launcher===
Line 5: Line 7:
  
 
===Step II Add a Machine Entry===
 
===Step II Add a Machine Entry===
* Click the Add Machine button in the top left. A machine entry will appear that is grey color. Hit the setup button and download setup.
+
* Click the Add Machine button in the top left. A machine entry will appear that is grey color.  
 +
* For most installs you can just hit the setup button and download the automated setup. However, if you are running a custom node.js installation you will want to perform the '''Manual Setup''' option and follow the steps presented carefully. More information about manual install can be found [[Web_Launcher_Reference#My_machine_failed_to_setup_locally.2C_with_an_error_that_npm_isn.27t_found.3F|here.]]
  
 
===Step III Install Machine To Host===
 
===Step III Install Machine To Host===

Latest revision as of 17:36, 14 April 2019

This is a quick and dirty guide to accessing web launcher to setup and run a simple cluster of region servers. This guide assumes you have not yet used web launcher at all. For in-depth details and configuration of web launcher see Web Launcher Reference

NOTE: By default a fresh web launcher setup is configured to launch all regions that make up the world. This will require a single server with at least 32gb of RAM to not crash and run into issues. Make sure you have a powerful enough machine, or turn off some regions! Optimal setups for production servers are essentially 2+ dedicated machines, with as high of a single core clock speed as possible, 32+ GB ram each, and SSD disk drive.

Step I Login to Web Launcher

Step II Add a Machine Entry

  • Click the Add Machine button in the top left. A machine entry will appear that is grey color.
  • For most installs you can just hit the setup button and download the automated setup. However, if you are running a custom node.js installation you will want to perform the Manual Setup option and follow the steps presented carefully. More information about manual install can be found here.

Step III Install Machine To Host

  • Create a new directory somewhere on the physical machine that will host your region servers, move the downloaded file into that directory and run it. This will install all needed software and dependencies. You will need administrator access to install missing dependencies.
  • Once this process has completed you can delete the downloaded setup executable.
  • Your machine entry in the web launcher website should now show up as green and online. If not consult the Web Launcher Reference's troubleshooting section or seek support in the community admin discord channel.

Step IV Install Shards Server Software

  • With your new web launcher machine entry created and online no shards server software has yet been installed locally, only the files needed to run the local client portion of web launcher. Click the Update Available! button and click the Install button to install the latest shard server distribution. Wait for the installation to complete, and the machine entry should now show that it has Shard Server software of the given version installed.

Step V Create Cluster Configuration

  • In the top right corner click the + button, and click the Create Cluster button along with the Confirm Create Cluster button.

Step VI Setup Cluster Provider and Cluster Server Software

  • In the top left corner click the Menu button and click My Cluster to open the cluster configuration page.
  • Inside the Cluster Control entry Provider will be set to nil. Click on nil and select the Citadel Cluster option. An Update Available! button will than appear. Click the button, and click Install to install the cluster software to the selected Citadel Cluster server.
  • Once installation is complete, close the dialog.

Step VII Start Your Cluster of Servers:

  • You are now ready to start up your fresh cluster of region servers. Make sure you are not running any other Shard Server or Standalone Server processes on your physical host machine and simply hit the START SERVER button. The Cluster Control should startup go green, and then each region will startup and come online.

Step VIII Login to Your Cluster

  • By default your cluster's visibility is set to false so you will not see it under the community servers list in the Legends of Aria client, and will need to connect to it via IP. The IP of your cluster is shown under the Cluster Control entry while the cluster is up and running. e.g cluster1.shardsonline.com:5XXX this is the IP and port you will use to connect directly to your cluster.


Congratulations, you have now setup a new cluster of servers on web launcher. See the Web Launcher Reference for detailed information about how to configure every option available.