Setting up a server - Revision history

Maze2: /* First time using Nginx? */ mention future

2024-07-05T09:06:38Z

First time using Nginx?: mention future

Maze2: /* Secure connection over HTTPS */ Added detailed instructions for nginx

2024-07-05T08:54:42Z

Secure connection over HTTPS: Added detailed instructions for nginx

Maze: Add instructions for https

2022-09-15T09:17:27Z

Add instructions for https

Maze: Remove database dependency

2022-08-14T20:56:56Z

Remove database dependency

Maze: better username example

2021-05-17T13:22:32Z

better username example

Maze: who doesn't use g++

2020-02-23T00:35:38Z

who doesn't use g++

imported>Maze at 16:42, 25 October 2019

2019-10-25T16:42:55Z

imported>Maze: /* Running server without MySQL */

2019-10-05T16:34:21Z

Running server without MySQL

imported>Maze: Created page with " You'll need these things installed: * git * g++ (or another c++ compiler) * [https://nodejs.org/en/ Node.js] * [https://www.npmjs.com/get-npm npm] * [https://www.mysql.com/..."

2019-09-30T12:12:56Z

Created page with " You'll need these things installed: * git * g++ (or another c++ compiler) * [https://nodejs.org/en/ Node.js] * [https://www.npmjs.com/get-npm npm] * [https://www.mysql.com/..."

New page

You'll need these things installed:

* git
* g++ (or another c++ compiler)
* [https://nodejs.org/en/ Node.js]
* [https://www.npmjs.com/get-npm npm]
* [https://www.mysql.com/ MySQL] (not mandatory)

If you're going to use MySQL,
[https://www.digitalocean.com/community/tutorials/how-to-install-mysql-on-ubuntu-14-04 set up]
your database.
It is needed for storing account data.
Helpful commands:
<pre>
$ mysql -u root -p
> create database aagrinder;
> create user 'maze'@'localhost' identified by 'some_password';
> grant all privileges on aagrinder.* to 'maze'@'localhost';
> flush privileges;
> quit
</pre>

Then run the following commands:
<pre>
$ git clone https://gitlab.com/MRAAGH/aagrinder.git
$ cd aagrinder
$ npm install
$ git clone https://gitlab.com/MRAAGH/aagrinder-terrain.git
$ cd aagrinder-terrain
$ make
$ cd ..
$ npm start
</pre>

A server.properties file will be created.
In that file, you set the database name, host, user and password.
Then restart the server.

Now, anyone who can access your computer via internet can easily connect to your aagrinder server.

== Running server without MySQL ==

WARNING: if you run a server without a database, players will not be able to protect their accounts with passwords.
If you are going to play alone or only on the local network, this could be totally fine.

Open your server.properties file.
Change "insecure_mode":false to "insecure_mode":true.
Then restart the server.

@@ Line 93: / Line 93: @@
 === First time using Nginx? ===
-Here are more detailed instructions:
+Here are more detailed instructions.
 # acquire a domain name which points to your server's IP address. For hosting AAGRINDER, poke Maze and you might get a subdomain of aagrinder.xyz for free.

@@ Line 80: / Line 80: @@
      listen 80;
-     listen [::]:80;
+     listen [::]:80;**
+}
 </pre>
@@ Line 88: / Line 88: @@
 # certbot certonly --nginx -d aagrinder.xyz
 </pre>

← Older revision		Revision as of 09:17, 15 September 2022
Line 1:		Line 1:
		+
	Currently, there are only instructions for setting up a server on Linux. Feel free to add instructions for other platforms.		Currently, there are only instructions for setting up a server on Linux. Feel free to add instructions for other platforms.

Line 39:		Line 40:

	Now, anyone who can [[wikipedia:port forwarding\|access your computer]] via internet can easily connect to your aagrinder server.		Now, anyone who can [[wikipedia:port forwarding\|access your computer]] via internet can easily connect to your aagrinder server.
		+
		+	== Secure connection over HTTPS ==
		+
		+	The AAGRINDER server by itself exposes a HTTP website. For better security, HTTPS is preferred. To achieve this, an additional software component needs to be involved as a [[wikipedia:Reverse proxy\|reverse proxy]]. In this guide, we use [[wikipedia:Nginx\|Nginx]].
		+
		+	A Nginx configuration for proxying AAGRINDER might look like this:
		+	<pre>
		+	server {
		+	server_name aagrinder.xyz;
		+
		+	location / {
		+	proxy_pass http://localhost:8926;
		+	}
		+
		+	location ~* /.io {
		+	proxy_pass http://localhost:8926;
		+	proxy_set_header X-Forwarded-For $remote_addr;
		+	proxy_set_header X-Real-IP $remote_addr;
		+	proxy_set_header X-NginX-Proxy false;
		+	proxy_set_header Host $host;
		+	proxy_redirect off;
		+	proxy_http_version 1.1;
		+	proxy_set_header Upgrade $http_upgrade;
		+	proxy_set_header Connection "upgrade";
		+	}
		+
		+	listen [::]:443 ssl;
		+	listen 443 ssl;
		+	ssl_certificate /etc/letsencrypt/live/aagrinder.xyz/fullchain.pem;
		+	ssl_certificate_key /etc/letsencrypt/live/aagrinder.xyz/privkey.pem;
		+	include /etc/letsencrypt/options-ssl-nginx.conf;
		+	ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;
		+	}
		+
		+	server {
		+	return 302 https://$host$request_uri;
		+
		+	server_name aagrinder.xyz;
		+
		+	listen 80;
		+	listen [::]:80;
		+	}
		+	</pre>
		+
		+	Here, AAGRINDER is running on port 8926 and is accessible from the outside on port 443 (https) through Nginx. The HTTPS certificate, located at ''/etc/letsencrypt/live/aagrinder.xyz'' was acquired from [[wikipedia:Let's Encrypt\|Let's Encrypt]] using ''certbot''. For reference, the specific command used to acquire this certificate was:
		+	<pre>
		+	# certbot certonly --nginx -d aagrinder.xyz
		+	</pre>

@@ Line 11: / Line 11: @@
 * [https://nodejs.org/en/ Node.js]
 * [https://www.npmjs.com/get-npm npm]
-If you're going to use MySQL,
+Acquire the AAGRINDER server software:
 <pre>
 $ git clone https://gitlab.com/MRAAGH/aagrinder.git
@@ Line 50: / Line 35: @@
-A [[server properties|server-properties.json]] file will be created.
+A [[server properties|config.json]] file will be created.
-In that file, you set the database name, host, user and password.
+You can change the server configuration, although the defaults should already be functional.
 Now, anyone who can [[wikipedia:port forwarding|access your computer]] via internet can easily connect to your aagrinder server.

@@ Line 21: / Line 21: @@
 $ mysql -u root -p
 > create database aagrinder;
-> create user 'maze'@'localhost' identified by 'some_password';
+> create user 'aagrinder_user'@'localhost' identified by 'some_password';
-> grant all privileges on aagrinder.* to 'maze'@'localhost';
+> grant all privileges on aagrinder.* to 'aagrinder_user'@'localhost';
 > flush privileges;
 > quit

@@ Line 1: / Line 1: @@
 You'll need these things installed:
@@ Line 22: / Line 27: @@
 </pre>
+Then, acquire the AAGRINDER server software:
 <pre>
 $ git clone https://gitlab.com/MRAAGH/aagrinder.git
 $ cd aagrinder
 $ npm install
 $ git clone https://gitlab.com/MRAAGH/aagrinder-terrain.git
 $ cd aagrinder-terrain
 $ make
 $ cd ..
 $ npm start
 </pre>
-A server.properties file will be created.
 In that file, you set the database name, host, user and password.
-Then restart the server.
+Then [[administration tips#restart the server|restart the server]].
-Now, anyone who can access your computer via internet can easily connect to your aagrinder server.
+Now, anyone who can [[wikipedia:port forwarding|access your computer]] via internet can easily connect to your aagrinder server.
 == Running server without MySQL ==
@@ Line 46: / Line 61: @@
 If you are going to play alone or only on the local network, this could be totally fine. [[Running in insecure mode|More about insecure mode]]
-Open your server.properties file.
+Open your server-properties.json file.
 Change "insecure_mode":false to "insecure_mode":true.
-Then restart the server.
+Then [[administration tips#restart the server|restart the server]].