Difference between revisions of "Installation"

From GExtension Wiki
Jump to navigation Jump to search
 
(37 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
== Web ==
 
== Web ==
First, you have to install GMOD Web.  
+
First, you have to install the GExtension webpanel (GMOD Web).  
#Download the installation files from [https://scriptfodder.com/scripts/download/2899 ScriptFodder]
+
<ol>
#Edit config.php
+
<li>Download the installation files from [https://www.gmodstore.com/market/view/2899/download GmodStore]</li>
##'''Protocol''': 'http' or 'https'. Only use 'https' if you have a valid SSL certificate.
+
<li>Edit config.php</li>
##'''SteamAPI''': Key: Get your API Key from [http://steamcommunity.com/dev/apikey Steam]
+
    <ul>
##'''Timezone''': Select the correct timezone from [http://php.net/manual/en/timezones.php this site]
+
      <li>'''Protocol''': 'http' or 'https'. Only use 'https' if you have a valid SSL certificate.</li>
##'''MySQL''': Insert ''IP'', ''port'', ''user'', ''password'' and ''database''
+
      <li>'''SteamAPI''': Key: Get your API Key from [http://steamcommunity.com/dev/apikey Steam]</li>
##'''SMTP''' (optional): Insert ''mailserver'', ''port'', ''username'', ''password'', ''alias'', ''security'' and ''method''. You can use [https://outlook.live.com outlook.com] if you do not have your own mailserver.
+
      <li>'''Timezone''': Select the correct timezone from [http://php.net/manual/en/timezones.php this site]</li>
#Upload the files to your webserver
+
      <li>'''MySQL''': Insert ''IP'', ''port'', ''user'', ''password'' and ''database''</li>
#Set directory permissions (Linux)
+
      <li>'''SMTP''' (optional): Insert ''mailserver'', ''port'', ''username'', ''password'', ''alias'', ''security'' and ''method''. You can use [https://outlook.live.com outlook.com] if you do not have your own mailserver.</li>
#Open the directory on your webserver using a browser
+
    </ul>
#Press '''"Retrieve"''' to get your license key
+
  </li>
#Press '''"Start"'''
+
  <li>Upload the files to your webserver</li>
 +
  <li>'''(LINUX, self hosted)''' Set directory permissions: Your webserver needs read/write permissions for every GExtension file or folder. (Commands may differ per system)<br/>
  
'''Linux Only'''
+
For default PHP:<br/>
*You need to allow apache to access (read/write) the GExtension directory. You may use this command:
+
<pre>chown -R www-data:www-data /path/to/gextension/
cd path/to/gextension
+
chmod -R 770 /path/to/gextension/</pre>
  chown -R www-data:www-data *
+
 
chmod -R 777 *
+
For PHP FastCGI/FPM:<br/>
 +
  <pre>chown -R <CGI-USER>:www-data /path/to/gextension/<br/>
 +
chmod -R 770 /path/to/gextension/</pre>
 +
 
 +
</li>
 +
 
 +
  <li>Open the directory on your webserver using a browser</li>
 +
  <li>Press '''"Retrieve"''' to get your license</li>
 +
  <li>Press '''"Start"'''</li>
 +
</ol>
  
 
===Troubleshooting===
 
===Troubleshooting===
'''"Could not update" + permission error'''
+
[[Troubleshooting]]
*Permissions are not set up correctly. Repeat step 4.
 
'''"Access denied for user 'mysqluser'@'123.12.31.123' (using password: YES)"'''
 
*You are using a MySQL user that doesn't has access. This is caused by wrong password, not whitelisted IP or insufficient permissions to the database.
 
  
 
== Lua ==
 
== Lua ==
 +
Attention: Your players may lose their groups if you do not follow the instructions under "Groups and Bans"
 +
 
After installing the web part, you can now install the Lua addon.
 
After installing the web part, you can now install the Lua addon.
#Open GMOD Web with your webbrowser
+
#Open the GExtension webpanel (GMOD Web) with your webbrowser
 
#Click on the '''bullhorn (further named "Admin") -> Settings -> Update'''
 
#Click on the '''bullhorn (further named "Admin") -> Settings -> Update'''
 
#Click on the "Lua" button and save the ZIP file
 
#Click on the "Lua" button and save the ZIP file
#Extract the files to a folder and navigate to ''"gextension/lua/config/gextension"''
+
#Extract the files to a '''local''' folder and navigate to ''"gextension/lua/gextension/config/"''
 
#Edit ''sh_config.lua'' to your needs. Required: WebURL
 
#Edit ''sh_config.lua'' to your needs. Required: WebURL
 
#Edit ''sv_config.lua'' and insert your MySQL data (same that you used for GMOD Web)
 
#Edit ''sv_config.lua'' and insert your MySQL data (same that you used for GMOD Web)
 
#Upload the folder into your server's addon folder
 
#Upload the folder into your server's addon folder
#Restart your server
+
#[[MySQL|Install MySQLoo]]
 +
#Restart your server and connect
  
 
The Lua installation is now finished and you should see that GExtension has connected to the database in the console.
 
The Lua installation is now finished and you should see that GExtension has connected to the database in the console.
Line 46: Line 56:
 
#After five seconds, you can see in the console, that the server found the bundle
 
#After five seconds, you can see in the console, that the server found the bundle
  
===Import users/bans from ULX or ServerGuard===
+
===Groups and Bans===
 +
Go to '''Admin -> Settings -> Groups''' and create all groups you have in GMOD with the EXACT SAME name.
 +
====Import users/bans from ULX or ServerGuard====
 
Make these steps before players connect to your server.
 
Make these steps before players connect to your server.
 
[[Import:ULX-ServerGuard]]
 
[[Import:ULX-ServerGuard]]
  
 
===Troubleshooting===
 
===Troubleshooting===
'''"Access denied for user 'mysqluser'@'123.12.31.123' (using password: YES)"'''
+
[[Troubleshooting#Lua]]
*You are using a MySQL user that doesn't has access. This is caused by wrong password, not whitelisted IP or insufficient permissions to the database.
 
'''GExtension is not initialized/Could not initialize'''
 
*Take a look in the SERVER-console for errors. You may forgot to assign your server to a serverbundle.
 
'''I lost my rank on the server'''
 
*You most likely forgot to also set you a rank for the serverbundle. Navigate to '''Search -> Your Pofile''' and click on the pencil. '''Please note that the name of the web and gmod groups has to be the same (case sensitive!!!).
 
'''
 

Latest revision as of 19:10, 11 April 2020

This article will lead you through the installation process of GExtension.

Web

First, you have to install the GExtension webpanel (GMOD Web).

  1. Download the installation files from GmodStore
  2. Edit config.php
    • Protocol: 'http' or 'https'. Only use 'https' if you have a valid SSL certificate.
    • SteamAPI: Key: Get your API Key from Steam
    • Timezone: Select the correct timezone from this site
    • MySQL: Insert IP, port, user, password and database
    • SMTP (optional): Insert mailserver, port, username, password, alias, security and method. You can use outlook.com if you do not have your own mailserver.
  3. Upload the files to your webserver
  4. (LINUX, self hosted) Set directory permissions: Your webserver needs read/write permissions for every GExtension file or folder. (Commands may differ per system)
    For default PHP:
    chown -R www-data:www-data /path/to/gextension/
    chmod -R 770 /path/to/gextension/

    For PHP FastCGI/FPM:

    chown -R <CGI-USER>:www-data /path/to/gextension/<br/>
    chmod -R 770 /path/to/gextension/
  5. Open the directory on your webserver using a browser
  6. Press "Retrieve" to get your license
  7. Press "Start"

Troubleshooting

Troubleshooting

Lua

Attention: Your players may lose their groups if you do not follow the instructions under "Groups and Bans"

After installing the web part, you can now install the Lua addon.

  1. Open the GExtension webpanel (GMOD Web) with your webbrowser
  2. Click on the bullhorn (further named "Admin") -> Settings -> Update
  3. Click on the "Lua" button and save the ZIP file
  4. Extract the files to a local folder and navigate to "gextension/lua/gextension/config/"
  5. Edit sh_config.lua to your needs. Required: WebURL
  6. Edit sv_config.lua and insert your MySQL data (same that you used for GMOD Web)
  7. Upload the folder into your server's addon folder
  8. Install MySQLoo
  9. Restart your server and connect

The Lua installation is now finished and you should see that GExtension has connected to the database in the console. But to work correctly, you now need to assign your server to a serverbundle.

  1. Open GMOD Web with your webbrowser
  2. Navigate to Admin -> Settings -> Servers
  3. Create a new serverbundle with a fitting name (for example "TTT") and select your server
  4. After five seconds, you can see in the console, that the server found the bundle

Groups and Bans

Go to Admin -> Settings -> Groups and create all groups you have in GMOD with the EXACT SAME name.

Import users/bans from ULX or ServerGuard

Make these steps before players connect to your server. Import:ULX-ServerGuard

Troubleshooting

Troubleshooting#Lua