Feature/environment configuration #116

thmsndk · 2024-02-24T12:01:39Z

The following PR aims to move more configurations out into configuration files that are not comitted to git, this way you have more control on the specific server installation.

Fixes an issue where api/characters_and_servers would return a hardcoded 192.168.1.125 ip when running in SDK mode
- This allows headless (caracAL, ALClient) / custom clients that rely on that api response to connect to the websocket to connect properly
Added new environment.py
- you can configure game_name, appengine_id, live_domain, sdk_domain
- The hardcoded IP_TO_SUBDOMAIN has also been moved here.
DISCORD
- Moved some hardcoded links to #welcome into environment.py
- You can now customize your discord bot token and channels in variables.js
- You can now enable discord in sdk mode
  - discord integration is disabled by default in template.variables.js
You can now override values in server.js mode
- this allows you to disable the drm_check that causes the authfail debuff
- you can also disable / enable the notverified_debuff
- any property inside mode can be changed / adjusted

closes #94

-WARNING: This PR will require the live servers to update their config file(s)

secrets.py the discord url for the welcome invite needs to be supplied
variables.js make sure to configure the discord section to be ENABLED, the bot TOKEN and the EVENT_CHANNELS
- discord_url has been replaced in the config with a discord section
add the new environment.py the IP_TO_SUBDOMAIN should be untouched, if running in SDK mode, make sure to map REQUEST_IP_TO_HOSTNAME properly

thmsndk · 2024-02-24T21:05:52Z

I currently can't think of other things I want to add to this PR, reviews will be much appreciated. I have tested it on my local dev server, and everything works as expected as far as I can tell.

Telokis

Thank you for this PR!
I left a few comments and questions.
I feel like some auto-formatting happened in the HTML files, that was probably not on purpose.

More important, this is a very big and deep change. I think it's very important that you also provide an extensive migration guide to make sure @kaansoral has a reference to follow.
I can't ever merge this myself due to the big deployment implications, it should probably be at a time where you are both available to live debug/migrate as it is being put in place and deployed.

api.py

htmls/contents/guide.html

htmls/contents/section_buttons.html

htmls/page.html

Telokis · 2024-04-12T18:28:18Z

js/game.js

 	var query=args.secret&&"desktop="+(!is_comm&&1||"")+"&secret="+args.secret||undefined;
 	if(location.protocol=="https:") window.socket=io('wss://'+server_addr+':'+server_port,{secure:true,transports:['websocket'],query:query});
-	else window.socket=io(server_addr+':'+server_port,{transports:['websocket'],query:query});
-	add_log("Connecting to the server.");
+	else window.socket=io('ws://'+server_addr+':'+server_port,{transports:['websocket'],query:query});


Why does it now explicitely need the protocol but didn't before?

To be able to connect via caracAL to the server on http, the protocol was required for a correct websocket / socket.io connection to be established.

Telokis · 2024-04-12T18:31:17Z

useful/template.secrets.py

+# Discord
+DISCORD = {
+    "URL": {
+        "WELCOME": "https://discord.gg/44yUVeU"


This should probably be named DISCORD_INVITE_LINK instead of WELCOME, for clarity.

I agree, was just an easy name to represent it as the welcome link i think the welcome name made sense in context of where it was used, I'd have to verify it again though

Telokis · 2024-04-12T18:31:45Z

useful/template.variables.js

+	fast_sdk: 0,
+	DISCORD: {
+		ENABLED: false,
+		TOKEN: "NDXXXXXXXXXXX", // Your discord applications bot token


Shouldn't this go into secrets instead?

Secrets is for python.
This is for the node servers

Telokis · 2024-04-12T18:32:40Z

useful/template.live_variables.js

+	apple_token: "acXXXXXXXX...",
+	steam_key: "8aXXXXXXXXX...",
+	steam_web_key: "B4XXXXXXX...",
+	steam_partner_key: "F9XXXXXXX...",


Same, those tokens can probably move to secrets, is there a reason not to?

Telokis · 2024-04-12T18:33:10Z

useful/template.live_variables.js

+	character_limit: 3,
+	DISCORD: {
+		ENABLED: false,
+		TOKEN: "NDXXXXXXXXXXX",


Duplicated token? Why is this here as well? (Maybe you don't even know)

The live variables is used as part of the deploy process on the official servers as far as I understand, there is a script that copies this and some other folders into the deployed directory.

Telokis · 2024-04-12T18:34:44Z

node/server_functions.js

@@ -3266,27 +3266,34 @@ function appengine_call(method, args, on_success, on_error) {
 }

 function discord_call(message) {
+	// TODO: should it not post to the channel either way? I vote to remove this return


I'd argue that the new variables.DISCORD.ENABLED configuration option has indeed made this check obsolete.

I think standard, hardcore and test servers are run from the same directory though. So they all share the same variables.js file.

Should the test server actually post to the same channels as the live servers? The same question is true for hardcore servers.

I kinda feel they perhaps need their own configuration as theese two servers are a special kind of servers.

Telokis · 2024-04-19T11:44:58Z

@thmsndk Since this PR is big and I've left several comments, I'll let you tell me when you consider it ready for me to take another look at it.
Please write a small word after each of my open conversations to let me know how you've addressed it so I can better keep track.

useful/template.environment.py

game_name,appengine_id,domain name can also be configured

discord url can be configured in secrets.py

…er changing internal ip at will

…er container using actual_ip

thmsndk · 2024-09-17T06:03:46Z

I'm unsure if my latest commit will break the live production servers as I've been messing around with how "https_mode" is utilized
8c20b82

More research and testing is needed, but server_eval is now fixed on my local docker environment.

thmsndk mentioned this pull request Feb 24, 2024

initial support for connecting to other server than adventure.land numbereself/caracAL#12

Draft

thmsndk marked this pull request as ready for review February 24, 2024 21:03

thmsndk marked this pull request as draft February 25, 2024 13:45

thmsndk marked this pull request as ready for review February 25, 2024 13:49

thmsndk mentioned this pull request Mar 31, 2024

Add way to play on self hosted server with steam client #128

Open

Telokis reviewed Apr 12, 2024

View reviewed changes

thmsndk force-pushed the feature/environment-configuration branch 2 times, most recently from 71f6cb3 to eacd64a Compare April 22, 2024 19:41

Telokis reviewed Jul 26, 2024

View reviewed changes

useful/template.environment.py Show resolved Hide resolved

thmsndk force-pushed the feature/environment-configuration branch from eacd64a to bba14b9 Compare July 27, 2024 07:03

thmsndk added 10 commits August 13, 2024 22:19

move hardcoded ip in sdk mode to environment config file like secrets

e9d0dc7

game_name,appengine_id,domain name can also be configured

discord token and channels can now be configured in variables.js

dfa0122

discord url can be configured in secrets.py

Access python array the proper way

21c3bc1

You can now enable the discord integration in sdk mode

a82e2ef

fixed some hardcoded invite links to the #welcome channel

1912709

allow overriden mode in server.js via variables.js

eaa7629

revert formatting changes

17c7a16

removed hardcoded ip in sdk mode, solved by environment.py

2be5f4d

remove commented out code

6c18af3

Map servers by region and server name EUI instead of ip due to dock…

3455645

…er changing internal ip at will

thmsndk force-pushed the feature/environment-configuration branch from 9f63e68 to 3455645 Compare August 13, 2024 20:57

Fixed an issue where server_eval would not talk with the correct dock…

8c20b82

…er container using actual_ip

thmsndk marked this pull request as draft September 17, 2024 06:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/environment configuration #116

Feature/environment configuration #116

thmsndk commented Feb 24, 2024 •

edited

Loading

thmsndk commented Feb 24, 2024

Telokis left a comment

Telokis Apr 12, 2024

thmsndk Apr 12, 2024

Telokis Apr 12, 2024

thmsndk Apr 12, 2024 •

edited

Loading

Telokis Apr 12, 2024

thmsndk Apr 12, 2024

Telokis Apr 12, 2024

Telokis Apr 12, 2024

thmsndk Apr 12, 2024

Telokis Apr 12, 2024

thmsndk Apr 12, 2024

Telokis commented Apr 19, 2024

thmsndk commented Sep 17, 2024

Feature/environment configuration #116

Are you sure you want to change the base?

Feature/environment configuration #116

Conversation

thmsndk commented Feb 24, 2024 • edited Loading

thmsndk commented Feb 24, 2024

Telokis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thmsndk Apr 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Telokis commented Apr 19, 2024

thmsndk commented Sep 17, 2024

thmsndk commented Feb 24, 2024 •

edited

Loading

thmsndk Apr 12, 2024 •

edited

Loading