gtlogurl

Login Dashboard Solution for Growtopia Private Servers (GTPS).

gtlogurl is a robust, easy-to-use, and highly customizable LoginURL system designed specifically for Growtopia Private Servers. It provides a clean login dashboard, automatic request handling, and flexible deployment options including domain-based server naming and SSL support.

Features

• Easy Integration
  Start a GTPS LoginURL server with just one line of code.

• Domain-Based Server Name
  Automatically detect server name from domain or subdomain.

• SSL / HTTPS Support
  Built-in HTTPS support using SSL certificates (Port 443).

• Customizable Configuration
  Configure port, server name, domain behavior, and SSL options.

• Secure by Default
  Includes rate limiting to prevent spam and abuse.

• Optimized Performance
  Uses compression for faster responses.

• Responsive Login Dashboard
  Comes with a ready-to-use login dashboard (EJS).

• Growtopia Compatible
  Fully compatible with standard Growtopia login protocols.

Installation

Install via npm:

npm install gtlogurl

Basic Usage (HTTP / Normal Mode)

Use this mode if you want a simple LoginURL server without SSL.

require('gtlogurl')({
  port: 5000,
  serverName: 'Growtopia'
});

• Server will run on HTTP
• Default port: 5000
• Server name will be displayed as Growtopia

Domain-Based Mode

If you want the server name to be automatically generated from the domain or subdomain, enable domain: true.

require('gtlogurl')({
  domain: true
});

How it works

| Domain / Hostname | Generated Server Name | | -------------------- | --------------------- | | novaa.lol | Novaa | | grow.novaa.lol | Grow | | login.myserver.com | Login |

When domain: true is enabled, the serverName option will be ignored.

SSL / HTTPS Mode (Port 443)

To run gtlogurl with HTTPS, provide your SSL certificate and key.

require('gtlogurl')({
  domain: true,
  sslKey: './private.key',
  sslCert: './private.crt'
});

Behavior

• Automatically runs on HTTPS
• Uses Port 443
• Server name is taken from the domain
• If SSL files are missing or invalid, it will fall back to HTTP

Recommended for production servers.

API Endpoints & Routes

gtlogurl automatically handles all required Growtopia login routes:

| Route | Method | Description | | ------------------------------- | ------ | ------------------------------------------------------------- | | / | GET | Health check. Returns a welcome message with server name. | | /player/login/dashboard | ALL | Renders the login dashboard and parses Growtopia client data. | | /player/growid/login/validate | ALL | Validates GrowID & password and generates a token. | | /player/growid/checktoken | ALL | Verifies refresh token validity. Redirects on failure. |

Configuration Options

You can pass the following options when initializing gtlogurl:

| Option | Type | Default | Description | | ------------ | --------- | ---------- | ----------------------------------------------------------- | | port | number | 5000 | HTTP port (used when SSL is disabled). | | serverName | string | Growland | Server name shown in dashboard (ignored if domain: true). | | domain | boolean | false | Auto-generate server name from domain/subdomain. | | sslKey | string | null | Path to SSL private key file. | | sslCert | string | null | Path to SSL certificate file. |

Recommended Setup

Production

• Use domain: true
• Enable SSL
• Run behind a proper DNS record

Development

• Use HTTP
• Custom port (e.g. 5000)
• Manual serverName

Credits & Authors

This project is proudly maintained by:

• Author: NovaIndonesia
• Credits: YoruAkio

License

MIT License Free to use, modify, and distribute.