Skip to content

Commit c41cdab

Browse files
et-niket-nik
committed
update documentation
1 parent 15c5647 commit c41cdab

12 files changed

+253
-57
lines changed

‎en/gameap_configure/dedicated_servers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Dedicated Servers
33
layout: default
44
lang: en
55
category: Panel settings
6-
order: 10
6+
order: 300
77
---
88

99
* This will become a table of contents (this text will be scraped).

‎en/gameap_configure/game_servers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Game Servers
33
layout: default
44
lang: en
55
category: Panel settings
6-
order: 20
6+
order: 310
77
---
88

99
* This will become a table of contents (this text will be scraped).

‎en/gameap_configure/games.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Games
33
layout: default
44
lang: en
55
category: Panel settings
6-
order: 30
6+
order: 320
77
---
88

99
* This will become a table of contents (this text will be scraped).

‎en/gameap_daemon.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: GameAP Daemon
33
layout: default
44
lang: en
55
category: GameAP Daemon
6-
order: 50
6+
order: 400
77
---
88

99
* This will become a table of contents (this text will be scraped).

‎en/gameap_daemon_spec.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: GameAP Daemon specifications
33
layout: default
44
lang: en
55
category: GameAP Daemon
6-
order: 60
6+
order: 401
77
---
88

99
GameAP Daemon components specification. Any component named as "server" in that document!

‎en/get_started.md

+15-17
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Get Started
2+
title: Getting Started
33
layout: default
44
lang: en
55
category: Main
@@ -15,14 +15,20 @@ To get started, it is desirable to have two dedicated or virtual servers. On one
1515

1616
If you have Linux, have CURL packages and you don't want to figure installation details out. Execute command:
1717
```bash
18-
curl -sLO http://packages.gameap.ru/installer.sh && bash installer.sh
18+
bash <(curl -s https://gameap.com/install.sh)
1919
```
2020

2121
## Panel Installation
2222

23-
The panel is installed on a dedicated server with PHP, a web server (Nginx, Apache, etc.) and a database (MySQL, PgSQL, SQLite, ...)
23+
The panel is installed on a dedicated server with PHP,
24+
a web server (Nginx, Apache, etc.), and a database (MySQL, PgSQL, SQLite, ...)
2425

25-
Installation ways:
26+
* [Installation on Linux](/en/install/install_on_linux.html)
27+
* [Installation on Windows](/en/install/install_on_windows.html)
28+
29+
### Outdated Installation Methods
30+
31+
The methods below are more complicated to install but are still relevant. Use them if there is a specific need, but remember that in most cases, it is better to use the methods described above.
2632

2733
* [Install on Linux with SSH (auto, easy)](/en/auto_install.html)
2834
* [Install on Linux with SSH (manual, difficult)](/en/manual_install.html)
@@ -32,10 +38,11 @@ Installation ways:
3238

3339
You can download and unpack archive on your hosting. Some installation methods don't required archive downloading.
3440

41+
* [gameap-3.1-shared.zip](https://packages.gameap.com/gameap/gameap-3.1-shared.zip)
3542
* [GitHub](https://github.com/et-nik/gameap)
36-
* [gameap_latest.zip](http://www.gameap.ru/gameap_latest.zip)
3743

38-
## Dedicated server adding
44+
45+
## Adding a Dedicated Server
3946

4047
Add a new dedicated server (VDS, VPS, Physical server). On a dedicated server, game servers will then start.
4148
Go to **"Administration"** -> **"Dedicated servers"** -> **"Create"**.
@@ -44,21 +51,12 @@ Follow the instructions.
4451

4552
![](/images/en/get_started/add_dedicated_server.gif)
4653

47-
For details see [dedicated servers](/en/gameap_configure/dedicated_servers.html) page.
54+
For more detailed information on installation and configuration, read the [Dedicated servers](/en/gameap_configure/dedicated_servers.html) page.
4855

4956
## Game server adding
5057

5158
Go to **"Administration"** -> **"Game servers"** -> **"Create"**.
5259

5360
![](/images/en/get_started/add_game_server.gif)
5461

55-
For details see [game servers](/en/gameap_configure/game_servers.html) page.
56-
57-
## Demo
58-
59-
Look GameAP features on the demo site.
60-
61-
[https://demo.gameap.ru](https://demo.gameap.ru)
62-
63-
* Login: demo
64-
* Password: demo
62+
For details see [game servers](/en/gameap_configure/game_servers.html) page.

‎en/install/install_on_linux.md

+103-2
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,106 @@ title: Install on Linux
33
layout: default
44
lang: en
55
category: Install GameAP
6-
order: 10
7-
---
6+
order: 100
7+
---
8+
9+
* This will become a table of contents (this text will be scraped).
10+
{:toc}
11+
12+
## Installation
13+
14+
Installation on Linux is performed with a single command:
15+
```shell
16+
bash <(curl -s https://gameap.com/install.sh)
17+
```
18+
19+
During the installation process, you will be prompted to enter some information.
20+
21+
### Installation Path
22+
23+
This is the path where the main panel files will be stored.
24+
The default is `/var/www/gameap`.
25+
26+
### Host
27+
28+
Specify the domain or IP address at which the panel will be accessible.
29+
30+
In the case of an IP address, it must be an address assigned to the network
31+
interface on the VDS. If your network uses NAT, do not specify
32+
the external IP, but rather the internal one, and then configure port
33+
forwarding.
34+
35+
Any domain can be specified, but do not forget to configure DNS.
36+
37+
Examples of correct values:
38+
* 10.182.104.8
39+
* 10.182.104.8:2080
40+
* example.com
41+
* http://example.com
42+
43+
### Web Server
44+
45+
The HTTP server that will accept and process incoming requests.
46+
[Nginx](https://www.nginx.com/) is recommended for use.
47+
48+
### Database
49+
50+
The database where data will be stored: users, information about servers, etc.
51+
You can use [MySQL](https://www.mysql.com/) and
52+
[SQLite](https://www.sqlite.org/).
53+
54+
MySQL is recommended in most cases. If the load on your server
55+
is expected to be low, and you do not plan to use more than 10 game servers,
56+
you can use SQLite.
57+
58+
Some distributions may have [MariaDB](https://mariadb.org/) installed.
59+
60+
## Completing the Installation
61+
62+
At the end of the installation, the access details for the panel
63+
will be displayed. Do not forget to save this information to access the panel.
64+
65+
![](/images/en/gameapctl/gameap_finished_installation.png)
66+
67+
## Additional Installation Options
68+
69+
### Develop Version
70+
71+
You can install a version that is under development by specifying
72+
additional flags `--github --branch=develop` during installation.
73+
The installation time will significantly increase in this case,
74+
as it will be performed from the sources.
75+
76+
```shell
77+
bash <(curl -s https://gameap.com/install.sh) \
78+
--github \
79+
--branch=develop
80+
```
81+
82+
### Non-Interactive Installation
83+
84+
This type of installation allows you to install the panel without
85+
entering any data during the process.
86+
You can add the `--path`, `--web-server`, `--database` flags,
87+
and in this case, the installer will not require any additional data from you.
88+
89+
```shell
90+
bash <(curl -s https://gameap.com/install.sh) \
91+
--path=/var/www/gameap \
92+
--web-server=nginx \
93+
--database=mysql \
94+
--host=http://127.0.0.1 \
95+
--port=80
96+
```
97+
98+
### Full Installation
99+
100+
To install the GameAP Daemon in addition to the panel itself,
101+
add the `--with-daemon` flag.
102+
103+
This method is recommended if you plan to host both the panel
104+
and game servers on the same VDS.
105+
106+
```Shell
107+
bash <(curl -s https://gameap.com/install.sh) --with-daemon
108+
```

‎en/install/install_on_windows.md

+95-2
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,98 @@ title: Install on Windows
33
layout: default
44
lang: en
55
category: Install GameAP
6-
order: 11
7-
---
6+
order: 101
7+
---
8+
9+
## Supported Versions
10+
11+
| Version | Supported | Note |
12+
|--------------|-----------|------------------------------------------------|
13+
| Server 2022 | ✔ | Last manual test (v0.9.1): March 2, 2024 |
14+
| Server 2019 | ✔ | Last manual test (v0.9.3): March 2, 2024 |
15+
16+
## Downloading GameAP Control
17+
18+
You need to download the GameAP Control utility (gameapctl)
19+
to manage the GameAP environment.
20+
21+
For this, go to the gameapctl release page on Github:
22+
[https://github.com/gameap/gameapctl/releases](https://github.com/gameap/gameapctl/releases)
23+
24+
Select the latest release and click on it.
25+
26+
![](/images/en/gameapctl/download.png)
27+
28+
After that, find the version suitable for you.
29+
The most popular architecture is Windows AMD64,
30+
so you will most likely need to download this archive:
31+
32+
![](/images/en/gameapctl/download_release_windows_amd64.png)
33+
34+
## Installing the Panel Using GameAP Control UI
35+
36+
After downloading the gameapctl archive, run it.
37+
38+
![](/images/en/gameapctl/exe_in_archive.png)
39+
40+
A browser window will open, in which you need to click "Install"
41+
in the Web/API section.
42+
43+
![](/images/en/gameapctl/ui_gameap_install_button.png)
44+
45+
### Installation Parameters
46+
47+
Specify the necessary data for installation.
48+
49+
![](/images/en/gameapctl/ui_gameap_installation.png)
50+
51+
#### Installation Path
52+
53+
This is the path where the main panel files will be stored.
54+
By default, it is `C:\gameap\web`, and this path cannot currently be changed.
55+
56+
#### Host
57+
58+
Specify the domain or IP address where the panel will be accessible.
59+
60+
In the case of an IP address, it must be the address assigned to
61+
the network interface on the VDS. If your network uses NAT,
62+
do not specify the external IP, but the internal one,
63+
then configure port forwarding.
64+
65+
Any domain can be specified, but do not forget to configure DNS.
66+
67+
Correct value examples:
68+
* 10.182.104.8
69+
* 10.182.104.8:2080
70+
* example.com
71+
* http://example.com
72+
73+
#### Web Server
74+
75+
The HTTP server that will accept and process incoming requests.
76+
[Nginx](https://www.nginx.com/) is recommended.
77+
78+
#### Database
79+
80+
The database where data will be stored: users, server information, etc.
81+
You can use [MySQL](https://www.mysql.com/)/[MariaDB](https://mariadb.org/)
82+
and [SQLite](https://www.sqlite.org/).
83+
84+
If the load on your server is expected to be low,
85+
and you do not plan to use more than 10 game servers,
86+
you can use SQLite.
87+
88+
#### Installing GameAP Daemon
89+
90+
In addition to the Web panel, you can also install
91+
the GameAP Daemon server part, which handles game server operations.
92+
93+
### Completion of Installation
94+
95+
Wait for the installation to finish.
96+
Some stages may take a considerable amount of time.
97+
98+
Do not forget to save the login data and database information that will be provided at the end.
99+
100+
![](/images/en/gameapctl/gameap_finished_installation.png)

0 commit comments

Comments
 (0)