I Want To Control My Server (IWTCMS)

# I-Want-To-Control-My-Server ### or just IWTCMS

Simple minecraft mod, which allows you to connect to your server and control it

### miniDocumentation structure: (#clients-)

## Clients (#minidocumentation-structure)

### (https://github.com/Bumer-32/I-Want-To-Control-My-Server/blob/main/python/iwtcms_client.py)

To launch an official client, type: ``python iwtcms_client.py --help``

### (https://github.com/AXCWG/IWTCMS-Client)

You also can download an official client if you go to the main page of server in the browser

## SSL (#minidocumentation-structure)

I will not tell you how to generate a certificate here, I will only tell you how to use it with IWTCMS. let's be brief

In the config file, we have ssl section:

```hocon // Other settings

# read more about setting ssl here: https://modrinth.com/mod/i-want-to-control-my-server ssl { # use SSL: enabling SSL for embedded server, clients must connect with SSL or they can't send/receive any data. By default it's disabled(false) BUT highly recommended to enable(true) it and setup SSL connection. use SSL = false // boolean # custom Sertificate: if enabled IWTCMS won't generating new sertificate, instead it reads sertificates from config/iwtcms/keystore.jks custom Sertificate = false // boolean # Actually idk what do this shit, but alias must be entered here. Usually you use it for custom generated certificates. By default it's "iwtcms". You can read more here: https://security.stackexchange.com/questions/123944/what-is-the-purpose-role-of-the-alias-attribute-in-java-keystore-files ssl Alias = "iwtcms" // string # sslPass: password for certificates, certs will be automaticly generated with this password or if you use any other certificates it will use pass to read it. ssl Pass = "keystorePassword" // string }

// Other settings ```

In fact, everything is already written here in the comments, but I want to add:

``use SSL`` - I always recommend enabling it even if you don't have generated certificate, if ``custom Sertificate`` disabled IWTCMS will generate new certificate every launch and SSL should work fine.

Btw if ``use SSL`` enabled non ssl connections disabled at all, you cant connect to it. Use https:// instead of http:// and wss:// instead of ws://

``custom Sertificate`` - Just disables auto generation of certificates and instead in reads certificate from config/iwtcms/keystore.jks

``ssl Alias`` and ``ssl Pass`` must match with alias and password in generated certificates

## Users (#minidocumentation-structure)

IWTCMS supports user profiles, very simple but useful

```hocon // Other settings

auth { # useAuthentication: enabling password for clients, client can't receive/send messages from/to server before login. By default it's disabled(false) BUT highly recommended to enable(true) it password. use Authentication = false // boolean

# needs ONLY IF useAuthentication enabled # here you can configure users # you can add custom users or remove existing users : [ // list { # anonymous name : anonymous // string # do not change if you wanna keep permits for anonymous # password : anonymous # doesn't matter permits : { read real time logs : false // boolean read logs history : false // boolean execute commands : false // boolean } } { # admin name : admin // string password : iwtcms // string permits : { read real time logs : true // boolean read logs history : true // boolean execute commands : true // boolean } } { # guest name : guest // string password : guest // string permits : { read real time logs : true // boolean read logs history : false // boolean execute commands : false // boolean } } ] }

// Other settings ```

The auth block in the config is responsible for all authentications

``use Authentication`` - enables auth, if it disabled anyone can connect, listen, send commands, and any other shit with server with IWTCMS can do.

``users`` - list of all users, there's no limits for users count

Every user has their own permits, False forbids action for user, True allows action.

If any permit is not defined, IWTCMS will use it analog from anonymous user.

If an anonymous user or anonymous permit doesn't exist, then follow this pattern: not defined? - forbidden

If a user does requests without cookies (without logining in), it uses permits from anonymous.

Anonymous didn't need password if his password exist