Server Manual: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Undo revision 54131 by Ciastuuś (talk))
(Replaced content with "Image:mtapl.jpg")
Line 1: Line 1:
__TOC__
[[Image:mtapl.jpg]]
 
==Getting started==
It is much easier than it looks to get a server up and running for your internet or LAN buddies; follow this wiki article and you will hopefully be on your way to hosting your own MTA:SA server in no time!
 
==Installing the server==
The dedicated server application is available in different flavours depending on the platform of the server.
 
===Linux installation===
There are different ways of getting a Linux server up and running:
* [https://linux.mtasa.com Getting a precompiled package]
* [[Installing and Running MTASA Server on GNU Linux]]
* [[Building MTASA Server on GNU Linux]]
 
 
Should you have any problems with errors when starting the server some common problems and solutions are listed here:
* [[Building MTASA Server on GNU Linux#Troubleshooting]]
 
===FreeBSD installation===
 
You can run MTA:SA under FreeBSD using Linux emulation.
* Enable [https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/linuxemu-lbc-install.html Linux binary compatibility]
* Install following packages or compile them from ports: hs-terminfo, linux_base-f10, linux-f10-sqlite3
* Install [https://linux.mtasa.com/ Linux precompiled package]
 
===Windows installation===
Installation of the MTA:SA server on Windows is easy as pie.
*Go to the [https://mtasa.com/ download page] and download the installer.
*Once the installer is downloaded, open it.
*Select a folder where you want to install the server.
*Click Install.
*Done!
 
''For a full explanation of acl.xml (access control list) read: [[Access_Control_List|Access Control List]]''<br/><br/>
 
==Configuring your server==
The Multi Theft Auto dedicated server is initially configurable through it's console window, from within the game, and from a webbrowser. In order to make use of the two last options, it is necessary to add at least one administrator user to your configuration file.
 
===General configuration===
All general configuration options can be found in the 'mods/deathmatch/[[Server_mtaserver.conf|'''mtaserver.conf''']]' file and can be opened by any regular text editor.
 
This file is fairly straightforward; every variable has a [[Server_mtaserver.conf|description of what to do with it and how to change it]].
 
===Port forwarding===
If you run your server on your own private computer, and you have an router between the internet and your computer. You need to forward 3 ports.
 
First of all open the file 'mods/deathmatch/[[Server_mtaserver.conf|'''mtaserver.conf''']]' and search for the next lines:
<syntaxhighlight lang="xml">
<serverport>22003</serverport>
<httpport>22005</httpport>
</syntaxhighlight>
 
The ports are needed to setup the server correctly. We explain later how to set them, but first if you want your server to appear in the server browser there is another port we need, and that is the ASE port.
(quick example for how to turn ASE on or off):
<syntaxhighlight lang="xml">
<ase>1</ase> <!-- 0 = off, 1 = on -->
</syntaxhighlight>
 
Now we going to forward the ports in your router, which is not needed if you already have all ports open, or if you don't have a router with a firewall. If so, skip this part.
 
If you don't know how port forwarding works in your router, go to the [https://portforward.com/ Port Forward website], find your router model there, and follow the instructions there.
 
In almost every router you can set the port type: UDP or TCP. The following list will explain which port type is needed for what:
 
 
Main server port: UDP
 
HTTP Port: TCP
 
ASE Port: UDP (this is needed if you want your server to appear in the server list)
 
 
The ASE port is also simple to get:
 
ASE port = Main server port + 123
 
So, if you have the main server port set to 22003, then the ASE port will be 22126.
 
Good luck!
 
''In the latest version of the server, you can check the port status by using the server command [[Server_Commands#openports|openports]].''
 
===Client Checks===
 
The MTA server can be configured to disable the anti-cheat. It can also allow specific or all files to be modified (e.g. carmods.dat), and make sure clients are of a minimum version.
 
All of these settings are within the file 'mods/deathmatch/[[Server_mtaserver.conf|'''mtaserver.conf''']]'. See the [[Anti-cheat_guide|Anti-cheat guide]] for more details.<br/>
 
If you want to force a minimum client version, search for the following line:
<syntaxhighlight lang="xml">
<minclientversion></minclientversion>
</syntaxhighlight>
Accepted values look like: 1.1.1-9.02320
 
===Adding administrators===
It is strongly recommended to add at least one administrator to your server in order to make use of the built-in webserver to easily maintain and configure your server. This administrator will then also be able to log-in from within the game and control the server.
 
To add an administrator to your server, follow these steps:<br>
<ol>
<li>While the server is running, add a new account by typing '''[[Server_Commands#addaccount|addaccount name password]]''' into the server window. For example, to add user BennyLava you could type:
<div style="margin: 10px 10px 10px 10px;">
<syntaxhighlight lang="xml">
addaccount BennyLava 123password
</syntaxhighlight>
</div>
<div style="margin: 10px 10px 10px 20px;">
''Note: If you do not have access to the server window, and the 'admin' resource is running, you can add  the example account by issuing the client console (F8) command '''register BennyLava 123password'''''
</div>
<li>The server should display a message confirming the account has been added.
<li>Next, shutdown the server by typing '''shutdown''' into the server window.
<li>Make sure your server is stopped; if your server is still running, the following changes you make will be overwritten</li>
<li>Open the file 'mods/deathmatch/acl.xml' with any text editor</li>
<li>Add the account to the ''Admin'' group by using the XML-syntax below
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<acl>
  ...
  <group name="Admin">
    <acl name="Admin"/>
    ...
    <object name="user.BennyLava" />
  </group>
  ...
</acl>
</syntaxhighlight>
</div>
 
You're done! You can add as many administrators or users as you want this way, take a look at some of the other groups and ACLs for example. The ACL is also accessible through the [[Access_Control_List|Lua scripting engine]].<br>
 
It is recommended to take a look at the web interface, we will explain how to do this below.
</li>
</ol>
'''Note''': There are also ways to add accounts and edit rights for the server while it's running. "[[Server_Commands#addaccount|addaccount <user> <password>]]" is an internal command to add accounts, but you will have to use the web interface to add these accounts to specific groups/ACLs!<br />
 
===Using the web interface===
The dedicated server comes with a few Lua [[resources]] that provide a nice little web interface to your server. This can be used to easily maintain your server, as it allows you to add users, start/stop resources, and more.
 
The web interface resources are enabled by default and are served through the built-in HTTP web server. To make sure the built-in HTTP web server runs on a port you like (22005 by default), follow these steps:
<ol>
<li>Make sure your server is stopped
<li>Open the file 'mods/deathmatch/[[Server_mtaserver.conf|'''mtaserver.conf''']]' with any text editor</li>
<li>Verify that the HTTP server is enabled:
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<httpserver>1</httpserver>
</syntaxhighlight>
</div>
</li>
<li>Change the HTTP server port to your liking:
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<httpport>22005</httpport>
</syntaxhighlight>
</div>
</li>
<li>Save and close the configuration file</li>
<li>Start your server</li>
<li>If you happened to have changed the start-up resources in your configuration file, make sure the following resources are started:
 
# resourcebrowser
# resourcemanager
# webadmin
# webmap
 
These are automatically started in the default configuration file, in case you just installed your server.
</li>
<li>Open a web browser (Internet Explorer 6 or 7 are NOT supported; use [https://www.mozilla.com/firefox Mozilla Firefox], [https://www.google.com/chrome Google Chrome], [https://www.apple.com/safari/download Apple Safari], [https://www.opera.com Opera] or others) and navigate to the HTTP server URL: '''http://server:port/'''. For example, If you are running a local server on HTTP port 22005, use '''http://127.0.0.1:22005/'''.</li>
<li>Enter the username and password of the administrator you added in the previous section.</li>
</ol>
 
<br />
You should now be able to maintain your server from the web interface.
 
=== Configuring an external web server ===
 
The built-in web server is also used to serve files that are required by resources running on your server to any player that is connected to your server. For example, if you are running a game script with a scripted graphical user interface, or custom models, these need to be transferred to every connected player in order to function properly. This is done by either the built-in web server, or an external web server (that is usually a bit faster) but needs to be set up separately.
 
For performance or consistency reasons during the game, you could choose to make use of such an external web server if you have one set up. The external web server needs to be accessible for the public, so any client will be able to download the necessary client-side files in order to join and play on your server.
 
To enable downloading off an external web server, you should configure the [[Server_mtaserver.conf#httpdownloadurl|httpdownloadurl]] tag in your server configuration:
 
<div style="padding: 10px">
<syntaxhighlight lang="xml">
<httpdownloadurl>http://www.myserver.tld/directory/here</httpdownloadurl>
</syntaxhighlight></div>
 
When you launch the server, the directory '''<SERVER>/mods/deathmatch/resource-cache/http-client-files''' will contain the correct client files for hosting on an external web server. If the web server is on the same machine, you can simply link the appropriate web server directory to '''http-client-files'''. If the web server is on a separate machine, ensure it has access to '''http-client-files''' via a network path, or maintain a remote copy using synchronization software.
 
'''Note 1''': Please try to avoid any special characters (e.g. ~, !) in your download URLs.<br />
'''Note 2''': Please do not use a trailing slash in your download URL (e.g. ''<nowiki>http://www.myserver.tld/directory</nowiki>'' rather than ''<nowiki>http://www.myserver.tld/directory/</nowiki>'')<br />
'''Note 3''': The web server must use 'ContentType: application/octet-stream' for Lua files. Most web servers will do this by default, or you can add the following line to the .htaccess file:<br />
<div style="padding: 10px">
<syntaxhighlight lang="xml">AddType application/octet-stream .lua
</syntaxhighlight></div>
 
Instructions on how to install and configure Nginx as an external web server for MTA is here: [[Installing and Configuring Nginx as an External Web Server]]
 
==Starting your server==
Begin by making sure that you have finished all configuration of your server, starting your server is the last stage so everything must be ready!
 
To start your server double click on MTA Server.exe, make sure you allow it through any firewalls and forward ports where necessary.
 
==Installing/Updating resources on your server==
Resources can come in two formats, either a ZIP format or just a normal folder with the script files inside it. The MTA:SA server supports both these methods.
 
# Move or copy the new resource to your <SERVER>\mods\deathmatch\resources folder.
# In the server window type in the command [[Server_Commands#refresh|refresh]], this will re-scan the resources folder and update the live resources where necessary.
 
==Uninstalling resources==
Resources can easily be removed from your server if you no longer want them.
 
# Delete the ZIP file or the folder of the resource you wish to uninstall
# In the server window type in the command "refresh" (without the quotes), this will re-scan the resources folder and update the live resources where necessary.
 
==Administrating your server==
You can start resources by typing the command "start resourcename" in the server console, or stop ones with "stop resourcename".
 
It's also possible to execute these and other admin commands from the in-game console (which you can bring up with the ` key or F8); for this to work, you first need to log in with the command "[[Server_Commands#login|login username password]]". Additionally, you can press the p key to bring up the admin panel: this is a graphical interface which allows you to easily kick or ban misbehaving players, among others.
 
For further commands, type [[Server_Commands#help|help]] in a console.
 
==Starting a map/gamemode==
See the commands section of the documentation for [[Resource:Map manager|mapmanager]] for more information.
 
==Useful Notes==
 
# You may also update the resources while in-game as long as you have the correct access levels by typing "refresh" in the clients console or "/refresh" in the chat window. This may cause a second of lag if you have many resources.
# In the above instructions, <SERVER> is the path to your server's main directory. In most cases this is C:\Program Files\MTA San Andreas\server
# You can choose a different config file for the server to use by passing it in the command line after a --config argument, e.g. mtaserver.exe --config anotherconfig.cfg.
# Do not be alarmed by the warning regarding the parsing of the settings.xml file. This happens because your server installation is still clean and unused.
 
====Need further help?====
Why not pop over to our [https://forum.mtasa.com/ Forums] or join us on [irc://irc.multitheftauto.com/mta IRC] (irc.multitheftauto.com #mta - [https://www.mirc.com mIRC])
 
[[es:Manual del Servidor]]
[[de:Server Anleitung]]
[[it:Manuale del Server]]
[[nl:Server Manual]]
[[ru:Server Manual]]
[[pl:Server Manual]]
[[pt-br:Manual do Servidor]]
[[hu:Server Manual]]
 
[[Category:Support]]

Revision as of 12:43, 16 August 2018

File:Mtapl.jpg

Retrieved from "https://wiki.multitheftauto.com/wiki/Server_Manual?oldid=58183"