Links

Migrating from v9

The new nLogin v10 now has its core on the proxy server (BungeeCord, Waterfall, Velocity). To migrate from an older version, follow the steps below.
If you do not use a proxy server, just install the new version of nLogin v10 and delete the nLogin config.yml.

Preparing for Migration

Install the latest compatible version

Before you start the migration, make sure you are using the version compatible with the migration on the proxy server and the backend (lobby) server.

Schedule a maintenance on the server

Let your players know that the server will undergo temporary maintenance and make sure to start the conversion without any players online.

Back up your information

nLogin automatically backs up your folders before the migration. However, it is advisable to make an additional backup to ensure that no important data is lost.
If the conversion process fails at any point, do not revert to the old version!
By reverting back to the old version, you risk corrupting some important information. The plugin may not function properly and will shut down the server to protect against unauthorized access.
In case of problems, please contact our team through the Discord group or via email [email protected].
*After opening the ticket, please inform us that you had a problem converting the new nLogin and provide the latest logs from your server or any information that seems useful to you. That way we can solve your problem in the shortest time possible.

Starting the migration

Start the proxy server and the backend server. The processes listed below will run automatically.

Automatic processes:

  1. 1.
    A backup will be performed and saved in nLogin/migration/migration-backup.zip
  2. 2.
    It will install and configure BungeeGuard. The server will restart after that.
  3. 3.
    The server will be ready for the conversion.
After the above processes have been completed, you are ready for the next step.

Common mistakes:

HikariCP dependency outdated

To solve the problem below, follow the steps below:
  1. 1.
    Go to the server's file/FTP manager.
  2. 2.
    Go to the nCore folder and delete the dependencies folder.
  3. 3.
    Start the server again.
Message sent when the dependency is out of date.

Setting up the encryption keys

To ensure that sensitive information is not exposed, nLogin encrypts the messages sent between the proxy server and the backend server. Follow the steps below to configure the encryption key.

Servers hosted on the same machine:

If the proxy server and the backend server are hosted on the same machine (most cases), disable encryption. To do this, remove the secret from the settings.

Proxy server:

Open the file "nLogin/proxy/secret.yml" and change the value of secret to ""
# To ensure that communication between the proxy and the backend server is done in an encrypted way, nLogin creates a random secret key.
# If you leave the value below null, encryption will be disabled (useful for servers where the proxy is hosted on the same machine as the backend).
# To set it up, follow this tutorial: https://www.nickuc.com/docs/nlogin-proxy
secret: ""

Backend server:

Open the file "nLogin/secret.yml" and repeat the same procedure.
# To ensure that communication between the proxy and the backend server is done in an encrypted way, nLogin creates a random secret key.
# If you leave the value below null, encryption will be disabled (useful for servers where the proxy is hosted on the same machine as the backend).
# To set it up, follow this tutorial: https://www.nickuc.com/docs/nlogin-proxy
secret: ""

Servers hosted on different machines:

If the proxy server and the backend server are hosted on a different machine, enable encryption. To do this, use the same secret as the proxy server.

Proxy server:

Open the file "nLogin/proxy/secret.yml" and copy the value of secret as the example below:
# To ensure that communication between the proxy and the backend server is done in an encrypted way, nLogin creates a random secret key.
# If you leave the value below null, encryption will be disabled (useful for servers where the proxy is hosted on the same machine as the backend).
# To set it up, follow this tutorial: https://www.nickuc.com/docs/nlogin-proxy
secret: "VivIvQaijL4ZNfMNlR8u1MbC"

Backend server:

Open the file "nLogin/secret.yml" and paste the value of secret copied in the previous procedure.
# To ensure that communication between the proxy and the backend server is done in an encrypted way, nLogin creates a random secret key.
# If you leave the value below null, encryption will be disabled (useful for servers where the proxy is hosted on the same machine as the backend).
# To set it up, follow this tutorial: https://www.nickuc.com/docs/nlogin-proxy
secret: "VivIvQaijL4ZNfMNlR8u1MbC"
The encryption process used can be costly for your server!
We recommend that you always prefer to use the proxy server and the backend server on the same machine.
*If you use shared hosting, opt for network plans or split plans. If the host does not offer this service, ask them via tickets to migrate both servers (proxy and backend) to the same node (extra service fees may apply).

Uploading the migration file

Now you will need to migrate some information from the old version to the proxy server. Follow the steps below:
  1. 1.
    Log into the server and remain logged in with it at all times.
  2. 2.
    You will receive a welcome message from nLogin.
    • When the message "Waiting for conversion file..." is sent, you are ready for the next step.
      a
  3. 3.
    Go to the nLogin folder on your backend server and download the proxy-migration.zip file to your computer.
  4. 4.
    Then go to the nLogin folder on your proxy server and upload the file you downloaded in the previous step.
  5. 5.
    Monitor the upload progress through your Minecraft client.
We recommend that you use an FTP client, such as FileZilla or WinSCP.

Common mistakes:

No admin permission

If you get a message like this when logging into the server, add the permission nlogin.admin to your account.
Message sent when logging into the server without having the permission "nlogin.admin".

Database conversion

If you were using MySQL, you will need to set it up again. To do this, follow the MySQL installation tutorial.
After starting the server again, you may need to start the database conversion. A progress bar will be sent, like the image below.
Progress bar of the database conversion.
Do not shut down the server in any way during the conversion process!
If the server was turned off before the conversion was completed, please contact our support via the Discord group or via email [email protected].

Your server is ready!

We recommend that you check that the accounts were converted successfully.
You can...
  • log into the server and check if your account is registered.
  • run the command /nlogin version and check the user count, like the image below:
Make sure the user count matches the size of your server.