Files
factorio-clusterio/plugins/player_auth
Hornwitser 6a404d9fb3 Refactor and port plugin web code to TypeScript
Clean up the configuration for compiling TypeScript for the Web
interface to us its own tsconfig.web.json config files and reference the
TypeScript source files directly in the configuration and imports
instead of files compiled to dist.

To properly support recompliation with TypeScript's projects feature
each package's tsconfig.web.json file is set to output the build to
dist/web_build which is then ignored in .npmignore.  Webpack is still
used to create the proper build in dist/web, so this is mainly to make
TypeScipt's compiler happy but it also allows the root tsconfig.json
file to include the web interface code, meaning running the build script
now also checks the typing of the web interface.

Final part of #491.
2023-11-28 15:52:54 +01:00
..
2021-09-11 01:02:24 +02:00
2023-11-19 04:48:38 +01:00
2023-02-22 15:30:51 +01:00
2023-08-26 17:11:47 +02:00

Clusterio Player Auth Plugin

Plugin authenticating logged in players to the web interface. Authentication is achieved by a simple challenge response mechanism where players have to log into one of the Factorio server in the cluster and open a dialog that presents a code, this code is input into the login form on the web interface which gives back a second code. Once the player enters the second code into the dialog in-game the web interface is authenticated.

Installation

Run the following commands in the folder Clusterio is installed to:

npm install @clusterio/plugin-player_auth
npx clusteriocontroller plugin add @clusterio/plugin-player_auth

Substitute clusteriocontroller with clusteriohost or clusterioctl if this a dedicate host or ctl installation respectively.

Controller Configuration

player_auth.code_length

Length in character of the generated challenge codes that need to be input between the web interface login form and the in-game Factorio login dialog.

Defaults to 6.

player_auth.code_timeout

Time in seconds the first code generated stays valid. The login must be completed in less than this time starting from when the login dialog is opened in-game.

Defaults to 120.