19321d575f
* Create DevelopmentServer.md This guide focuses on helping people try out their projects on a dedicated server so a more realistic test can be performed to see if everything works correctly. This focuses on the free/trial aspect from the chosen providers and tries to make it very clear to readers that "free" is relative and Mirror can not be held responsible if they go above the providers limits. It is mainly a guide on setting up the dedicated server through different providers to test your Mirror project. Question: Should I put it all under each other or should each provider/possibility be a different page like synchronization/GameObjects? For example: Overview AWS Azure Google * Make dedicated servers a submenu * Add files via upload * Move AWS inside it's own folder * Update index.md Changed the imgur links to the github images in the AWS folder so offline access is possible * Update index.md As suggestion from SoftwareGuy from suggestion: https://github.com/vis2k/Mirror/pull/1365#discussion_r361819820 I have made this in a bullet point so it's more clearly visible * Update index.md * Update index.md * Update index.md Added the changes as SoftwareGuy mentioned * Update index.md Another update to the formatting. Changed some parts to titles so it's easier to navigate through the right hand side on github pages. Some more formatting done * Update index.md Changed the titles from the 7 steps to include the step number for easier following * Update index.md Forgot this one: https://github.com/vis2k/Mirror/pull/1365#discussion_r361819874 Co-authored-by: Paul Pacheco <paulpach@gmail.com>
3.3 KiB
Development Servers
During this guide we will set up a dedicated server and place the server build of our project on the dedicated server.
IMPORTANT: Before we begin, there are some potential problems you may face, as no server is truly 'free':
1. Service providers are NOT free.
2. Most of the time you can start with free trials for a limited time, after x amount of time or x amount of used resources the trial will end and you might incur payment.
3. Always read the providers free trial limitations.
4. Some providers require a payment method for using a Windows instance, however as long as you do not go over the limitations the provider should not bill you.
Take note that Mirror is not affiliated and can not be held responsible for any charges or fees associated with service providers like AWS, Microsoft Azure, Google Compute Engine and others...
Introduction
During your development with Mirror you will need to test your project as a client and as a server. There are a few possible ways to test your project:
- Default build => Host/client as one and connecting with another build/editor to the host locally on 1 computer.
- Server build => Server is a separate executable. You can place it on your computer run it and connect to it as a client.
- Dedicated Server => Same as the server build but placed on an external machine, you connect to it with the computer's external ip.
This guide will focus on the "Dedicated Server" option. There are multiple providers and even self hosted dedicated machines. All possibilities still go through the same process to ensure connectivity to clients. A few requirements for a dedicated server:
- Port forwarding (Not strictly necessary but makes everything a lot easier without needing NAT punchthrough)
- Firewall exceptions
- Computer/machine that stays online and accessible whenever you need it.
In the upcoming sections we will go through setting up a provider with the free tier.
Please always double check when in doubt that you do not select a paid feature as this is purely meant as a short term period to test out basic functionality during development of your project.
Microsoft Azure
Microsoft Azure (as of time of writing) allows setting up a windows instance during the free trial without an active payment method.
To be added
Google Compute Engine
Google Compute Engine (as of time of writing) does NOT allow setting up a windows instance during the free trial without an active payment method.
To be added
Self Hosted Dedicated Server
A self hosted dedicated server is the same as the other providers but you provide the hardware, internet connection and costs for running the computer. Most of the time this is the "cheapest" option during development if you already have an extra machine. Preferably you would put the machine on a different network (to simulate the conditions as the other providers). This would mean you could connect to the machine and put your server build on whenever you need and have access to the router and security settings of the machine for port forwarding and firewall exceptions.
In essence, this is the simplest set up but does require extra hardware