This repository has been archived by the owner on Aug 19, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsetup_reciever.txt
65 lines (40 loc) · 2.82 KB
/
setup_reciever.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
====== Requirements ======
<WRAP center round important 60%>
:!::!: __//**This guide is considered deprecated and is only kept for technical reasons.**//__:!::!:
</WRAP>
The reciever is not allowed to be run with a user which is member of an administrative group. Create an unprivileged user.
====== Install reciever ======
* Download a stable release from https://github.com/apx-simracing/reciever/releases
* Unpack the contents **IN AN EMPTY DIRECTORY**
* Run reciever.bat to install everything, write down port and secret
* Run reciever.bat to launch the reciever
===== Unpack contents =====
After unpacking, you will most likely have a folder with this contents:
{{::apx_release.png?600|}}
Make sure the folder itself is named "reciever". On the same level, all other components will be placed:
{{::apx_folders.png?400|}}
You can locate them anywhere you want, but just make sure you have all four folders be placed besides each other, like in the screenshots. This bundle will be needed per server instance. An example of folder structures for two concurrent servers:
<code>
C:\server1\reciever
C:\server1\build
C:\server1\steamcmd
C:\server1\server
C:\server2\reciever
C:\server2\build
C:\server2\steamcmd
C:\server2\server
</code>
<WRAP center round info 60%>
WTF why is that needed?
APX follows an isolated approach. That means that each reciever has a defined, controllable folder structure besides it. Also, this makes bootstrapping more easy and lightweight. This won't be changed.
</WRAP>
===== Configure and run =====
Please consider the [[security_considerations|Security considerations]] before running in an productive environment.
<WRAP center round info 100%>
At first launch, the start may fail with UIAutomation.dll is missing. In this case, just try it a second time. It will work then. This is a known bug.
</WRAP>
On the first launch, APX will create the other folders (build, server, steamcmd). As you might assume, the rFactor 2 server will be installed into //server//, steamcmd will be automatically placed in //steamcmd//.
After execution, you will have everything installed and you will get the settings for using with CLI or wizard will be displayed (note especially the port and the secret). Check the generated configuration in the server.json. Especially check for the correct root folder. The root folder should point to the folder containing the folders reciever, server, build. Espeecially check if the root_path matches the parent path where the reciever is running tinto (e. g. when// reciever.bat// is located in //C:\servers\whatever\reciever\//, the value should be //C:\servers\whatever//).
If everything is fine, just execute reciever.bat.
Inside the wizard app, add the secret and the reachable URL into the form. The URL for example http://<ipoftheserver>:<choosedport>.
{{::apx_server_add.png?direct&800|}}