Skip to content

Commit 824ffb3

Browse files
authored
Update README.md
1 parent a3f91ac commit 824ffb3

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@ With this servermod you can easily send script commands or SQF code via a POST r
55
# Hello there!
66
This is an robust and fast ArmA 3 Servermod that runs on 32 bit and 64 bit Windows (Sooner or later also Linux but i have no machine to test or compile)! It listens on a specified port for incoming requests and returns a JSON-Array with a response code and the return of the executed script. The servermod consists of a pbo and 6 DLLs (2 ArmA extension DLLs and 4 library DLLs for OpenSSL).
77

8+
89
This is still under development, so you may encounter bugs, please create an issue on the github page explaining your bug and it will get fixed ASAP!)
910
Inspired by <a href=https://github.com/dylanplecki/sqf-rcon>this</a>
1011

1112

1213
# For Developers
1314
This is built in VS2019 (vc-142) using the <a href=https://github.com/ipkn/crow>crow webserver</a>, the boost library from nuget (vc141, version 1.69 (all above 1.69 will cause compiler issues)) It also uses the openssl-vc142 package from nuget for https support for crow.
1415

16+
1517
If you have knowledge in linux development, please help me :3
1618

1719

@@ -22,23 +24,23 @@ I would also recommend to use "-autoInit" as a startparameter so you can use it
2224

2325

2426
# How to use
25-
Send a POST request to "{IP}:{PORT}/send" with the parameters "user", "pass" and "execute", where "user" represents the username, "pass" the password and "execute" the SQF Code you want to execute
27+
Send a POST request to "{IP}:{PORT}/send" with the parameters "user", "pass" and "execute", where "user" represents the username, "pass" the password and "execute" the SQF Code you want to execute.
28+
29+
If you use HTTPS you need to get a SSL Certificate, you can just generate a self signed certificate from a website like <a href=https://www.selfsignedcertificate.com/>this</a>, add your domain/IP, download the .key and .cert file and paste it in the mod folder. Remember to edit the config.
2630

2731

2832
# Config File
2933
The Config File is pretty self explanatory
3034
<img src=https://i.imgur.com/wZOOfdv.png></img>
3135

36+
3237
<b>Fields:</b><br />
3338
host (string, default: "127.0.0.1"): A hostname (or IP-Address) <br />
34-
port (string, default: "6601"): Port <br /><br />
35-
36-
https (boolean, default: true): If you want to use HTTPS or not <br /><br />
37-
39+
port (string, default: "6601"): Port <br />
40+
https (boolean, default: true): If you want to use HTTPS or not <br />
3841
SSL_Key (string, default: "@sqfremoteexecute\ssl.key"): Path to your ssl.key file (only needed if using https) <br />
39-
SSL_Cert (string, default: "@sqfremoteexecute\ssl.cert"): Path to your ssl.cert file (only needed if using https) <br /><br />
40-
41-
users (array that contains an array of credentials, default user is "foo" with pass of "bar" (you need to hash the password with the SHA256 algorithm), <b>1337 is the maximum number of user accounts!</b> <br /><br />
42+
SSL_Cert (string, default: "@sqfremoteexecute\ssl.cert"): Path to your ssl.cert file (only needed if using https) <br />
43+
users (array that contains an array of credentials, default user is "foo" with pass of "bar" (you need to hash the password with the SHA256 algorithm), <b>1337 is the maximum number of user accounts!^^</b>
4244

4345

4446
# Safety Reminder

0 commit comments

Comments
 (0)