Aurora-Sim/Installation
De DigiWiki.
This section covers how to startup and run aurora post compile, if you wish to compile Aurora-Sim, see Development and Developer Documentation.
Install Requirements
Firstly ensure you have the basics, which are outlined in detail at Requirements
- For Windows NET Framework 3.51 must be installed.
- Linux / Mac OS Operating Systems must have MONO Version 2.4.3 (Minimum) or Version 2.10.x Recommended
Downloading Aurora-Sim
Releases and Source Code are complete for running either Grid Mode or Standalone modes, out of the box.
Releases are listed under the Download Packages. Releases
- These are compiled and ready to run with minimal configuration.
- Note: these Releases do not have any extra modules
GIT Master Source Code Git Repository Source
- Requires using Git Software to pull, compile and run.
- Extra modules should be added prior to compile.
ZIP Master Source Code Zip Source
- This is raw source code and does not require the use of Git Software(s).
- Extra modules should be added prior to compile.
Running Grid , Standalone OR Standalone with External Access
Standalone with External Access
Pre-Startup
- Either extract or copy the archive to an appropriate location. An appropriate location not being within a compressed Archive, and somewhere not easily forgettable.
- Configure the appropriate database, by default Aurora will use a version of SQLite packaged with the simulator. In order to change from the default see "<install folder>/Configuration/Data/Data.ini" and select from the list the database type you wish to install by removing the ';' from the database you wish to use, which is in this format "<install folder>/Configuration/Data/<database type>.ini", and putting a ';' in front of the SQLite database. If you do not wish to change the database configuration, go on to the next step.
Grid Configuration
Before running Aurora it is advisable to setup the type of grid connection and configure your network/firewall appropriately, by default Aurora is configured to run "standalone". In standalone mode your sims will not be directly connected to any external grid services. However if you wish to connect to external services or visa versa, you must ensure the relevant ports are open. If you do not wish to connect to external services then ensure these are closed.
Default External Port | Service | Config Location |
8002 | Login | <install folder>/bin/AuroraServerConfiguration/Main.ini |
8003 | Asset | <install folder>/bin/AuroraServerConfiguration/Main.ini |
8005 | MapService | <install folder>/bin/AuroraServerConfiguration/Main.ini [MapService] config |
8007 | CAPS Service | <install folder>/bin/AuroraServerConfiguration/Main.ini |
9000 | Region | <install folder>/bin/Regions/*.ini |
9001 | SSL | <install folder>/bin/AuroraServerConfiguration/Modules/Advanced.ini |
External/Internal Address and Ports
- The external address set in <install folder>/Regions/Regions.ini is used for determining the location of your region, such as with grid services you would use your external IP/domain name.
- External ports are used to facilitate communication with external hosts/clients.
- Internal ports are used for communication between grid components, it is recommended one unique port per internal region.
- Internal IP is used for communication between grid components, using the network IP (0.0.0.0) for all regions as a basic setup should be fine.
Allowing external access to standalone
- If your public ip is not statically assigned, it may be optimal to use a dynamic dns service so to reduce the amount of reconfiguration if/when your IP changes.
- Ensure you have all the external ports mentioned above opened.
- Create a login/avatar from the aurora console for intended visitors.
create user Test User password
- give visitors your uri. <(router)external address/domain name>:default port
Router Support List
NOTE: This is not a comprehensive or all inclusive listing. These are known good & known bad routers (ones that won't work with Aurora-Sim).
General Router/Modem info
To operate Aurora-Sim through a Router / Modem, the device must support NAT Loopback. While many makes & models do have Loopback support, there are just as many that do not. Due to the amount of Brands, Models and variants, it's virtually impossible to cover them all. Many DSL routers/modems prevent loopback connections as a security feature.
For Microsoft Windows, there is a Loopback Adapter Driver which can be installed if your modem / router is not cooperative. This is not a complete solution but may work in some instances.
Router / Modem Table
Make | Model | Status | Notes |
Belgacom BBox-2 | BBox-2 Docs | Works | Also known as SAGEM 3464. BBox-1 work.
BBox-2 Method 1: flash the firmare (in this case we lose the guarantee provider). |
Dlink | DGL-4500 | Works | [1] |
Dlink | DGL-4300 | Works | [2] |
Dlink | DI-524 | Works | [3] |
Dlink | DIR-600 | Works | [4] |
Dlink | DIR-601 | Works | [5] |
Dlink | DIR-635 | Works | [6] |
Dlink | DIR-655 | Works | [7] |
Draytek | Vigor120 | Works | |
Draytek | Vigor2710 | Works | [8] firmware 3.2.4.3 (or higher). |
Netgear | WNR834M | Works | |
Netgear | WNR2000 | Works | With firmware 1.2.3.7 Loop back now enabled 'out of the box' |
Netgear | WGR614 | Works | confirmed to work out of the box |
Netgear | RP614 | Works | Version 3 or better |
Netgear | DG834G | Works | v1, v2, v3 & v4 are end of line in most markets. The v3 & v4 are proven good performers. |
Linksys/Cisco | RT31P2 | Works | [9] |
Linksys/Cisco | AG241 | Works | [10] |
Linksys/Cisco | WAG200G | Works | [11] Firmware Version: 1.01.09 or better |
Linksys/Cisco | WRT54G | Works | [12] |
Linksys/Cisco | WAG160N | Works | [13] |
Linksys/Cisco | WAG54G v3 | Works | |
Linksys/Cisco | E3000 | Works | [14] |
Linksys/Cisco | WAG54G v2 - NZ/AU | Works | |
3Com / HP | 3CRWDR100A-72 | Works | [15] |
3Com / HP | 3CRWDR101A-75 | Works | [16] |
Arris | TM502b | Works | [17] |
2wire | 2701hg-s | Not Working | |
2wire | 2701hg-B | Works | [18] |
2wire | 2701hg-D | Works | [19] |
Thomson SpeedTouch | TG585 | Works | [20] new ver. Only |
Thomson SpeedTouch | ST-585i | Works | [21] |
Thomson SpeedTouch | ST-780 | Works | [22] |
Thomson SpeedTouch | ST-516 | Works | [23] |
AVM | FRITZ!Box | Works | [24] Except 3790 VDSL Router (old stock) |
Ubee | DDW2600 | Works | [25] Cable Router |
BT | BT Home Hub V2 | Works | [26] |
BT | BT2700HGV | Works | [ http://portforward.com/routergui/BT/BT2700HGV/index.htm] |
Netgear | Pro Safe VPN FVS318 | Not Working | [27] |
Netgear | WGR614 | Not Working | [28] does not work with ISP required gateway modems |
Asus | WL-520GC | Works | [29] |
SMC | SMC-7004VBR | Works | [30] |
Inventel / Livebox | DV42190WA | Works | Sold as Livebox 3420 by Orange/SFR in Europe. Set port forwarding for UDP and TCP separately |
Linksys/Cisco | BEFSR41 | Works | [31] |
Netgear | WNR3500 | Works | [32] NB restart after configuration |
Apple | AirPort Extreme | Works | |
Airlink | Airlink 101 Super G | Works | older model, search for reference |
Airlink | Airlink 101 802.11G wireless | Works | older model, search for reference |
Netgear | RP614v3 and Newer revisions | Works | [33] |
Actiontec | Verizon FiOS Router Model # 424WR | Works | [34] Set TCP and UDP separately |
Netgear | WNDR3700 | Works | [35] |
Actiontec | GT701-WG | Works | [36] |
Cisco | RV042 | Works | |
Scientific Atlanta | WebSTAR-DPR2320 | Works | [37] Google for more info |
Attaching to Aurora-Sim (SPLIT OUT)
N.B. Make sure to check you have permission to attach your sim to whichever grid before attempting to do so.
- Edit <install folder>/bin/Configuration/Main.ini to be like the following, please note the lack of ; at the start of Include-Grid and the ; at the start of Include-Standalone.
[Architecture] ;;If you would like to use Aurora in standalone, select this file. ;Include-Standalone = Configuration/Standalone/StandaloneCommon.ini ;;If you would like to use Aurora in grid mode, select this file. Include-Grid = Configuration/Grid/AuroraGridCommon.ini
After changing which Grid configuration file is loaded, it is important to edit the <install folder>/Grid/GridCommon.ini file. Ensure to replace the relevant URIs (probably all) with the relevant URI, for example;
[GridService] ;; ALL change this to your grid-wide grid server ;; GridServerURI = "http://127.0.0.1:8003" GridServerURI= "http://grid.aurora-sim.org:8003" ;AllowHypergridMapSearch = true
After configuring the relevant .ini files and ensuring the right ports on the firewall are open;default. 9000 If you are behind a NAT (router) that the relevant services are port forwarded to your computer. At this point in time it is also optimal to check and ensure your computer either has a static IP address or the DHCP server in your router will assign/reserve the same IP address for the computer you wish to run Aurora-sim from.
It is always best to check which "locations" are "avaliable" on a grid before attempting to attach a sim (or more), as you may have the same location set in <install folder>/Regions/Regions.ini as someone else may have, therefore creating a collision.
And finally, in <install folder>/Aurora.ini, ensure that your IP or DNS name is set up to the same IP or DNS name that you set up for a region in the previous step.
[Network] ;; 127.0.0.1 should be your IP address or DNS Define-<HostName> = http://127.0.0.1
Infinite Regions
What are Infinite Regions? Infinite Regions
Optional Modules
See Optional Modules