My Servers

From Unraid | Docs
Revision as of 06:29, 26 February 2021 by Jonp (talk | contribs)
Jump to: navigation, search

My Servers Documentation

This page will be moved as a link under Official Documentation once My Servers has been released publicly. For now, users will need this link in order to access this page manually.

Prerequisites

1. Please make a local backup of your USB flash drive. This can be done from the Main > Flash page. In the event you need to revert to your previous stable installation, you can use the USB Flash Creator from our website to restore this backup zip file to your flash drive.

Flash backup button (old).png

2. If you have the original Unraid.net plugin on your server, please uninstall it before continuing.

3. Update all of your plugins (older versions of some plugins are incompatible with My Servers, so it is important to update everything).

4. Upgrade to Unraid 6.9.0-rc1 or later. You can do this from the Tools > Update OS page and selecting Next from the drop down and then clicking Install.

IMPORTANT: If you aren't comfortable running a beta then please wait for the upcoming production versions. If you have any support questions about the RC release itself, please | use the forum.

Installing the plugin

Navigate to the Plugins tab, click Install Plugin, and paste the following URL into the field and click Install:

 https://s3.amazonaws.com/dnld.lime-technology.com/unraid-api/dynamix.unraid.net.plg

NOTE: Please make sure you wait until the install completes before closing the window

Signing In

Once you are on the latest release and have the plugin installed, you will notice a new section in the top right which we call the User Profile Component. Depending on the registration status of your server, you may be presented with an option to sign up, sign in, or both. If you already have an existing Unraid.net account (commonly used to access the forums), please use that account to sign in. If you don't have an account yet, you can create one.

400px

Important: If your registration key was purchased with an email address that matches an existing Unraid.net account, you must use that account to sign in to My Servers. If you have any difficulties with this, please contact us at support@lime-technology.com.

Once signed in, a trial key will automatically be downloaded if available and required.

Navigating the User Profile Component

After you sign in with an Unraid.net user account, the top right section will transform into an interactive menu. From this menu you can quickly navigate between your registered servers, launch the My Servers app, connect to the forums, or modify My Servers settings.

300px

Configuring Remote Access

Note: Before you can enable remote access, you must set a root password to your Unraid server. You can do this from the Users page.

1. Open the drop down on the User Profile Component and click Settings (or navigate to the Management Access settings page).

2. Click the Provision button under the Certificate section.

3. Once the certificate has been provisioned, scroll down to the Unraid.net section and toggle Allow Remote Access to Yes.

4. Optionally (but recommended), you can change the public access port used to connect.

5. Make sure you enable port forwarding on your router to allow traffic through to the public access port you specified. You can verify access is possible by clicking the Check button.

A note regarding DNS Rebinding Protection

300px

If you see this message after clicking the Provision button, click OK, try waiting 2-5 minutes, then click Provision again. If that doesn't work, keep reading.

Many routers have a security feature known as DNS Rebinding Protection. This feature prevents public DNS entries from pointing to local IP addresses on your network. Unfortunately this feature prevents us from providing proper SSL access when connecting to the webGui locally. As such, users must either disable this feature on their router or set their router to allow DNS rebinding for the unraid.net domain. Depending on your router, how this feature is described and whether or not it is available to configure may vary. In addition, once you have DNS rebinding disabled on your router, when you go to provision your certificate, you may still see the DNS rebinding error message the first time. This is due to the time it takes for DNS records to propagate once provisioned.

Automated Flash Backup and Registration Key Download

My Servers offers users the ability to automatically back up your OS configuration settings to our cloud. In the event of flash device failure, you can download a zip file of your latest backup and restore it to a new flash drive using the USB Flash Creator. In addition, you can also download any registration key you've purchased through the My Servers dashboard.

Enabling Flash Backup

  1. Open the drop down on the User Profile Component and click Settings (or navigate to the Management Access settings page).
  2. Scroll to the Unraid.net section and under Flash backup click the Activate button.
  3. Wait for the activation and initial backup job to complete (once done, it will show Activated: Up-to-date.

Once activated, any changes to the OS configuration will automatically be replicated to the backup in our cloud servers (within 1-2 minutes of the change).

Important: Backups from the flash device do not include the config/shadow or config/smbpasswd files. User accounts are preserved, but their passwords are not. This means that when you restore from backup, you will need to set passwords for your users including root. We also don't store any of your WireGuard keys. In addition, we do not backup your entire flash drive. If you have custom scripts that you want to include in the backup, please put them in /boot/config/custom/.

Restoring Flash Backup

  1. Click Generate flash backup.
  2. This will combine your OS configuration data with the OS release version you were running and put them both into a zip file that can be used with our flash creator tool to restore the backup to a new flash device.
  3. After the backup has been generated, you can click Download flash backup to obtain it.
  4. Use the Unraid USB Flash Creator to restore your backup to a new flash drive.

Download key and flash backup animated.gif

Additional Steps Required

Once you boot the OS, there are only a few things you will need to reconfigure:

  1. On the Users page, for each user (including root), you will need to reset your passwords.
  2. On the Settings > VPN Manager page, for each tunnel and peer, click the key icon.
  3. Click "Generate Keypair" and "Generate Key", start each tunnel, then download the new client configuration to each associated client device.

Downloading Registration Key

To download your registration key, open the My Servers dashboard. From there, you can click Download registration key to obtain your key file.

My Servers Dashboard

To get a comprehensive overview for all of your registered systems, you'll want to visit the My Servers Dashboard. From here you can see all of your servers, their online/offline status, available storage, and running apps. In addition, you can both locally and remotely access your servers, download your registration keys, and generate your flash backups. To view the My Servers Dashboard, you can either:

A. Open the drop down in the User Profile Component and select My Servers Dashboard.

200px

or

B. Click the My Servers section header on our forums.

500px

Signing Out

In the event that you wish to sign out of the My Servers program on your system, you can do so from the Management Access Settings Page.

  1. Open the drop down in the User Profile Component and select Settings.
  2. Scroll down to the Unraid.net section and click the Sign Out button.

400px

NOTE: Signed out servers will still be displayed on the My Servers Dashboard, but you will only be able to download their registration key(s).

Privacy

Maintaining your data integrity, security, and privacy are of the utmost importance to us at Lime Technology. Below is a disclosure of what we store and relay when you use My Servers. For more information, please see our policies page.

Data we store

When a server is registered for the My Servers program, we store some data regarding your server in our hosted infrastructure. This data includes:

  • The WAN IP address for the network your server is on and the remote access port
  • The LAN IP address for your server and the local access port
  • Your server's hostname and description
  • The URL used for both internal and external access
  • The configuration data of your server (if you use flash-backup)

This data is stored solely for the purpose of providing services to you through our platform and is not publicly accessible. To remove all data from our cloud services you must:

  1. Deactivate flash backup.
  2. Unregister from the My Servers program.
  3. Remove all SSL certificates generated for you through our Let's Encrypt partnership.

Data we relay

In addition to the data we store, Lime Technology provides a reverse-proxy relay to enable users a simpler way to get meaningful data remotely without having to open a port on your firewall/router. Through this relay, your server can communicate to the My Servers web app and provide you with information such as:

  • Online / offline status
  • Storage available / in-use
  • Apps and VMs running

This information is not stored in Lime Technology's infrastructure, but rather, is pulled on-demand from your server to display on the My Servers web application whenever the app is loaded.

Flash backups are not encrypted

It is important to note that at this time, all backups of your flash device are stored in our cloud in a non-encrypted format. This is why we do not store the sensitive data mentioned below.

Sensitive Data

To ensure absolute privacy and integrity, we have a few hard and strict policies regarding the storing of sensitive data. We do not store:

  • Unraid root or user account passwords (not even in the flash backup)
  • Public, private, or shared Wireguard keys