My Servers

From Unraid | Docs
Jump to: navigation, search
(Made doc public)
(linked to My Servers Dashboard)
 
(31 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=Prerequisites=
+
=Overview=
 +
One of the core design goals of Unraid OS is its ease of use. Our users can configure server environments with minimal expertise and time. Whether that's installing the OS, configuring an array, setting up shares, or adding apps—we get you through those tasks in record time. Today we're extending that benefit beyond those core functions with the introduction of our latest offering: My Servers.
 +
 
 +
My Servers is designed to extend the value of your investment in Unraid by enabling you to more easily connect, share, monitor, and access your Unraid Server.
 +
 
 +
The first set of features for the launch of the My Servers plugin are simple, yet powerful: users can access their server remotely, backup their flash devices at the click of a button, monitor their servers at a glance, and easily manage their Unraid licenses. This is just a starting point - more great features and tools are coming in the future so be sure to stay tuned as our team works to roll out even more helpful tools!
 +
 
 +
==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.
 
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.
Line 5: Line 12:
 
[[File:Flash_backup_button_(old).png|400px]]
 
[[File:Flash_backup_button_(old).png|400px]]
  
2. If you have the original Unraid.net plugin on your server, please uninstall it before continuing.
+
2. If you have the original Unraid.net plugin from 2018 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).
 
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'''.
+
4. Upgrade to Unraid 6.10 or later from the Tools > Update OS page.
 +
 
 +
5. Login in the top right of the webGui using your Unraid.net account (or create one if needed).
  
'''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 [https://forums.unraid.net/bug-reports/prereleases/unraid-os-version-690-rc1-available-r1165/ use the forum].
+
==Installing the plugin==
  
=Installing the plugin=
+
Go to the Apps tab and search for '''My Servers''', then click the '''Install plugin''' icon.
  
Navigate to the Plugins tab, click '''Install Plugin''', and paste the following URL into the field and click '''Install''':
+
Don't have the [https://forums.unraid.net/topic/38582-plug-in-community-applications/ Community Applications plugin] installed? 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
 
   https://s3.amazonaws.com/dnld.lime-technology.com/unraid-api/dynamix.unraid.net.plg
Line 21: Line 30:
 
'''NOTE:  Please make sure you wait until the install completes before closing the window'''
 
'''NOTE:  Please make sure you wait until the install completes before closing the window'''
  
=Signing In=
+
==Navigating the User Profile Component==
 
 
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.
 
 
 
[[File:User_profile_component_-_sign_in_or_sign_up.png|400px]]
 
 
 
'''Important''': ''Sign in with your Unraid.net forum account. If you don't have one, Sign Up! If you have any difficulties, please contact us at [[Mailto:support@lime-technology.com|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.
 
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.
Line 39: Line 38:
 
Note: If the text in this area is hard to read, go to Settings -> Display Settings and remove any "Header custom text color" and "Header custom background color" values you had previously set. This will get you back to the standard colors for your chosen theme, and you can customize from there.
 
Note: If the text in this area is hard to read, go to Settings -> Display Settings and remove any "Header custom text color" and "Header custom background color" values you had previously set. This will get you back to the standard colors for your chosen theme, and you can customize from there.
  
=Configuring Remote Access=
+
It should be rare, but if you see any error messages in the UPC please open a terminal window and type:
[[File:Enabling_remote_access.png|400px|right]]
+
unraid-api restart
'''Note: Before you can enable remote access, you must set a root password to your Unraid serverYou can do this from the Users page.'''
+
==My Servers Dashboard==
 +
To get a comprehensive overview of 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 backupsTo view the My Servers Dashboard, you can either:
  
1. Open the drop-down on the User Profile Component and click '''Settings''' (or navigate to the Management Access settings page).
+
A. Open the drop-down in the '''User Profile Component''' and select '''My Servers Dashboard'''.
  
2. Click the '''Provision''' button under the '''Certificate''' section.
+
[[File:My servers dashboard link - upc.png|200px]]
  
3. Once the certificate has been provisioned, scroll down to the Unraid.net section and toggle '''Allow Remote Access''' to '''Yes'''.
+
or
  
4. Optionally (but recommended), you can change the public access port used to connect.
+
B. Click the '''My Servers''' section header on our forums.
  
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.
+
[[File:My servers dashboard link - forums.png|500px]]
 
+
==Download Registration Key==
==A note regarding DNS Rebinding Protection==
+
To download your registration key, open the My Servers dashboard.  From there, you can click '''Download registration key''' to obtain your key file.
 
+
==Automated Flash Backup==
[[File:Dns_rebinding_error.png|300px]]
+
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.
 
 
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=
+
Note: Flash Backup is an optional feature, not required to use the rest of My Servers.
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==
+
==Enabling Flash Backup <small>(optional)</small>==
 
Until we are able to fully encrypt the flash backups on our servers, we exclude all sensitive data owned by the OS from the backups, including Unraid account passwords and WireGuard encryption keys. However, the backups do include docker template XML files, which may contain application-specific passwords and other private data. We are actively working on solutions to encrypt the backups.
 
Until we are able to fully encrypt the flash backups on our servers, we exclude all sensitive data owned by the OS from the backups, including Unraid account passwords and WireGuard encryption keys. However, the backups do include docker template XML files, which may contain application-specific passwords and other private data. We are actively working on solutions to encrypt the backups.
  
#Open the drop-down on the User Profile Component and click '''Settings''' (or navigate to the Management Access settings page).
+
#Navigate to Settings -> Management Access -> My Servers and under '''Flash backup''' click the '''Activate''' button.
#Scroll to the Unraid.net section and under '''Flash backup''' click the '''Activate''' button.
 
 
#Wait for the activation and initial backup job to complete (once done, it will show '''Activated: Up-to-date'''.
 
#Wait for the activation and initial backup job to complete (once done, it will show '''Activated: Up-to-date'''.
  
Line 77: Line 71:
 
==Restoring Flash Backup==   
 
==Restoring Flash Backup==   
  
 +
#Login to the [[My Servers#My_Servers_Dashboard|My Servers Dashboard]].
 
#Click '''Generate flash backup'''.
 
#Click '''Generate flash backup'''.
 
#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.
 
#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.
Line 90: Line 85:
 
#On the Settings -> Management Access -> Unraid.net page, click to Activate your flash backup again.
 
#On the Settings -> Management Access -> Unraid.net page, click to Activate your flash backup again.
 
#On the Users page, for each user (including root), you will need to reset your passwords.
 
#On the Users page, for each user (including root), you will need to reset your passwords.
#On the Settings > VPN Manager page, for each tunnel and peer, click the key icon.
+
#On the Settings > VPN Manager page, for each tunnel and peer:
#Click "Generate Keypair" and "Generate Key", start each tunnel, then download the new client configuration to each associated client device.
+
#*Click the key icon. Click "Generate Keypair" and "Generate Key", start each tunnel, then download the new client configuration to each associated client device.
  
==Downloading Registration Key==
+
==Configuring Remote Access <small>(optional)</small>==
 +
[[File:Enabling_remote_access.png|400px|right]]
 +
'''Note: Before you can enable remote access, you must set a root password to your Unraid server.  Make it complex. You can do this from the Users page.'''
  
To download your registration key, open the My Servers dashboardFrom there, you can click '''Download registration key''' to obtain your key file.
+
Also note: '''Remote Access is an optional feature''', and is not required to use the rest of My Servers.
 +
 
 +
#Navigate to Settings -> Management Access
 +
#If you are using Unraid 6.10, be sure to set '''USE SSL/TLS''' to '''No'''. In Unraid 6.9 this should be set to '''Auto'''.
 +
#Note the '''HTTPS port''', it defaults to port 443. If you have Docker containers running on this port, choose an unused port over 1000 such as 3443, 4443, 5443, etc.
 +
#If you changed any of the above settings, hit '''Apply''' for them to take effect.
 +
#In the '''CA-signed certificate file''' area, click '''Provision'''
 +
#*If you are using Unraid 6.10 your local access url will not change.
 +
#*If you are using Unraid 6.9, your local access url will change to <code><nowiki>https://yourpersonalhash.unraid.net</nowiki></code> , giving you secure local access
 +
#Navigate to Settings -> Management Access -> My Servers
 +
#Change '''Allow Remote Access''' to '''Yes'''
 +
#Set the '''WAN port''' you want to use. We highly recommend you choose a random port over 1000 rather than using the default of 443. i.e. something like 13856, 48653, etc
 +
#Click '''Apply'''
 +
#Setup your router to port forward the '''WAN port''' you specified to the '''HTTPS port''' used by the server. There is a note on the screen telling you the exact ports and IP to use.
 +
#Press the '''Check''' button. If the port is forwarded correctly you will see a message saying "Your Unraid Server is reachable from the Internet"
 +
#To access your server using Remote Access, login to the [[My Servers#My_Servers_Dashboard|My Servers Dashboard]] and click the Remote Access link.
 +
 
 +
===Optional step for Unraid 6.10===
 +
If you want to use secure https for local access to your server as well, navigate to Settings -> Management Access. In the CA-signed certificate area, if there are no warnings about DNS Rebinding then go ahead and set '''Use SSL/TLS''' to '''Auto'''. If there are warnings about DNS Rebinding see [[My Servers#A_note_regarding_DNS_Rebinding_Protection|A note regarding DNS Rebinding Protection]].
 +
 
 +
Note that once SSL is set to Auto, your client computers will need access to DNS in order to access your server. This means if your Internet connection drops you will likely lose access to your server's webgui. See [[My_Servers#How_to_access_your_server_when_DNS_is_down|How to access your server when DNS is down]].
 +
 
 +
===Using Custom Certificates===
 +
If you intend to use a custom certificate for secure remote access, you will be unable to utilize the My Servers remote access solutionFor more details, please see [[Manual/Security#Custom certificate - with no possibility of My Servers Remote Access|this article]].
 +
 
 +
===A note regarding DNS Rebinding Protection===
 +
[[File:Dns_rebinding_error.png|alt=|left|400x400px]]
 +
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.
 +
 
 +
===How to access your server when DNS is down===
 +
Once you enable local SSL per the instructions above, you will access your server through a Fully Qualified Domain Name:
 +
 
 +
  <code><nowiki>https://yourpersonalhash.unraid.net</nowiki></code> or <code><nowiki>https://yourpersonalhash.unraid.net:<https_port></nowiki></code> (if your https port is not the default of 443)
 +
 
 +
This is required in order to utilize a fully valid SSL certificate. A downside is if you temporarily lose Internet access and your browser has not cached the DNS for yourpersonalhash.unraid.net, you will be unable to access the webgui.
  
=My Servers Dashboard=
+
====Unraid 6.10====
To get a comprehensive overview of 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:
+
If the Internet goes down and you lose access to DNS, do the following:
  
A. Open the drop-down in the '''User Profile Component''' and select '''My Servers Dashboard'''.
+
*If '''Use SSL/TLS''' is set to '''Yes''', then you can access your server using: <code>https://[servername].[localTLD]</code> or <code>https://[servername].[localTLD]:<https_port></code> (if your https port is not the default of 443)
 +
*If that doesn't work, or if '''Use SSL/TLS''' is set to '''Auto''', then using telnet, SSH or local keyboard/monitor log in to the server and type: <code>use_ssl no</code>
 +
*Now you will be able to access your server's webgui via: <code>http://<ip_address></code>  (note: http not https) or <code>http://<server_ip>:<http_port></code> (if your http port is not the default of 80)
 +
*When the Internet comes back, navigate to Settings -> Management Access and set '''Use SSL/TLS''' back to '''Auto''' to re-enable local SSL.
  
[[File:My servers dashboard link - upc.png|200px]]
+
====Unraid 6.9====
 +
While you wait for your Internet access to be restored, access the server with this URL:
  
or
+
  <code>https://<server_ip></code> (note: https not http) or <code>https://<server_ip>:<https_port></code> (if your https port is not the default of 443)
  
B. Click the '''My Servers''' section header on our forums.
+
Your browser will bring up a warning that the SSL certificate does not match the url you are tryin to visit. It is safe to ignore this warning since you are are intentionally using the wrong url.
  
[[File:My servers dashboard link - forums.png|500px]]
+
===How to disable SSL for local access===
 +
If you decide you would rather not use the secure <code><nowiki>https://yourpersonalhash.unraid.net</nowiki></code> url for local access, you can disable SSL. There is no need to uninstall the My Servers plugin, in fact that will have no effect on SSL as this is a core feature of Unraid and not the plugin.
  
=Signing Out=
+
Navigate to Settings -> Management Access, set '''Use SSL/TLS''' to '''No''' and hit Apply. In Unraid 6.9 this will also disable the Remote Access feature at the same time.
 +
==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.
 
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.
  
 
#Open the drop down in the '''User Profile Component''' and select '''Settings'''.
 
#Open the drop down in the '''User Profile Component''' and select '''Settings'''.
#Scroll down to the Unraid.net section and click the '''Sign Out''' button.
+
#Scroll down to the My Servers section and click the '''Sign Out''' button.
  
 
[[File:Sign out.png|400px]]
 
[[File:Sign out.png|400px]]
Line 121: Line 160:
 
'''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).
 
'''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=
+
==Uninstalling the plugin==
 +
Note: if your goal is to change your url from <code><nowiki>https://yourpersonalhash.unraid.net</nowiki></code> back to <code><nowiki>http://computername</nowiki></code>, see [[My_Servers#How_to_disable_SSL_for_local_access|How to disable SSL for local access]]. Uninstalling the plugin will have no effect on your url!
 +
 
 +
As of the 8/25/21 release of My Servers, uninstalling the plugin will automatically:
 +
 
 +
*Deactivate and delete the backup files from your flash drive. We will provide a way to remove them from our server later.
 +
*Disable Remote Access and delete the corresponding DDNS entry. Please remember to disable any port forward that you configured in your router related to this feature.
 +
*Sign Out from Unraid.net.
 +
 
 +
Note that if you have the webgui open in multiple browser tabs, you should close or reload them after uninstalling the plugin.
  
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 [https://unraid.net/policies policies] page.
 
  
==Data we store==
+
If you uninstalled a previous version of the plugin, here are the steps to make sure everything is deactivated:
  
When a server is registered for the My Servers program, we store some data regarding your server in our hosted infrastructure. This data includes:
+
*Login to your router and disable any port forward you setup for Remote Access
 +
*On your flash drive, delete the .git folder. This is your local copy of the flash backup. We will provide a way to remove them from our server later.
 +
*On your flash drive, delete the config/plugins/dynamix.my.servers/myservers.cfg file. Note that this file will be recreated in Unraid 6.10, that is not a problem.
  
*The WAN IP address for the network your server is on and the remote access port
+
==Privacy==
*The LAN IP address for your server and the local access port
 
*Your server's hostname, description, and icon.
 
*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 accessibleTo remove all data from our cloud services you must:
+
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 ServersFor more information, please see our [https://unraid.net/policies policies] page.
  
#Deactivate flash backup.
+
===Data We Store===
#Sign out from My Servers.
 
#Remove all SSL certificates generated for you through our Let's Encrypt partnership.
 
  
==Data we relay==
+
When a server signs in to Unraid.net, it opens a secure connection to our hosted infrastructure and sends just enough data so we can give you a meaningful overview of your servers in the [https://forums.unraid.net/my-servers My Servers Dashboard].  We do not keep historical data, just the most recent update from your server which includes:
  
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:
+
*Your server's hostname, description, and icon
 +
*Your server's keyfile state / type
 +
*Your server's Local Access URL
 +
*Your server's LAN IP, if SSL is enabled.
 +
*Your server's Remote Access URL and WAN IP, if Remote Access is enabled.
 +
*The version of Unraid that is installed, and its uptime
 +
*The version of the My Servers plugin that is installed, and uptime of the unraid-api
 +
*The size of your array and the amount used (just numbers, no details about what is stored on the array)
 +
*The number of Docker Containers and VMs installed and started
  
*Online / offline status
+
Separate and unrelated to the My Servers Dashboard, the Flash Backup service stores your server's configuration data.
*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.
+
This data is stored solely for the purpose of providing services to you through our platform and is not publicly accessible. To remove this data from our servers you must follow the procedure listed in the "Uninstalling the plugin" section as well as remove all SSL certificates generated for you through our Let's Encrypt partnership.
  
==Flash backups are not encrypted==
+
===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.
 
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==
+
===Sensitive Data===
  
 
Until we are able to fully encrypt the flash backups on our servers, to ensure absolute privacy and integrity we have a few hard and strict policies regarding the storing of sensitive data. We do not store:
 
Until we are able to fully encrypt the flash backups on our servers, to ensure absolute privacy and integrity we have a few hard and strict policies regarding the storing of sensitive data. We do not store:

Latest revision as of 07:00, 20 October 2021

Overview

One of the core design goals of Unraid OS is its ease of use. Our users can configure server environments with minimal expertise and time. Whether that's installing the OS, configuring an array, setting up shares, or adding apps—we get you through those tasks in record time. Today we're extending that benefit beyond those core functions with the introduction of our latest offering: My Servers.

My Servers is designed to extend the value of your investment in Unraid by enabling you to more easily connect, share, monitor, and access your Unraid Server.

The first set of features for the launch of the My Servers plugin are simple, yet powerful: users can access their server remotely, backup their flash devices at the click of a button, monitor their servers at a glance, and easily manage their Unraid licenses. This is just a starting point - more great features and tools are coming in the future so be sure to stay tuned as our team works to roll out even more helpful tools!

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 from 2018 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.10 or later from the Tools > Update OS page.

5. Login in the top right of the webGui using your Unraid.net account (or create one if needed).

Installing the plugin

Go to the Apps tab and search for My Servers, then click the Install plugin icon.

Don't have the Community Applications plugin installed? 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

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.

User profile component - main navigation.png

Note: If the text in this area is hard to read, go to Settings -> Display Settings and remove any "Header custom text color" and "Header custom background color" values you had previously set. This will get you back to the standard colors for your chosen theme, and you can customize from there.

It should be rare, but if you see any error messages in the UPC please open a terminal window and type:

unraid-api restart

My Servers Dashboard

To get a comprehensive overview of 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.

My servers dashboard link - upc.png

or

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

My servers dashboard link - forums.png

Download 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.

Automated Flash Backup

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.

Note: Flash Backup is an optional feature, not required to use the rest of My Servers.

Enabling Flash Backup (optional)

Until we are able to fully encrypt the flash backups on our servers, we exclude all sensitive data owned by the OS from the backups, including Unraid account passwords and WireGuard encryption keys. However, the backups do include docker template XML files, which may contain application-specific passwords and other private data. We are actively working on solutions to encrypt the backups.

  1. Navigate to Settings -> Management Access -> My Servers and under Flash backup click the Activate button.
  2. 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. Login to the My Servers Dashboard.
  2. Click Generate flash backup.
  3. 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.
  4. After the backup has been generated, you can click Download flash backup to obtain it.
  5. 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 Settings -> Management Access -> Unraid.net page, click to Activate your flash backup again.
  2. On the Users page, for each user (including root), you will need to reset your passwords.
  3. On the Settings > VPN Manager page, for each tunnel and peer:
    • Click the key icon. Click "Generate Keypair" and "Generate Key", start each tunnel, then download the new client configuration to each associated client device.

Configuring Remote Access (optional)

Enabling remote access.png

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

Also note: Remote Access is an optional feature, and is not required to use the rest of My Servers.

  1. Navigate to Settings -> Management Access
  2. If you are using Unraid 6.10, be sure to set USE SSL/TLS to No. In Unraid 6.9 this should be set to Auto.
  3. Note the HTTPS port, it defaults to port 443. If you have Docker containers running on this port, choose an unused port over 1000 such as 3443, 4443, 5443, etc.
  4. If you changed any of the above settings, hit Apply for them to take effect.
  5. In the CA-signed certificate file area, click Provision
    • If you are using Unraid 6.10 your local access url will not change.
    • If you are using Unraid 6.9, your local access url will change to https://yourpersonalhash.unraid.net , giving you secure local access
  6. Navigate to Settings -> Management Access -> My Servers
  7. Change Allow Remote Access to Yes
  8. Set the WAN port you want to use. We highly recommend you choose a random port over 1000 rather than using the default of 443. i.e. something like 13856, 48653, etc
  9. Click Apply
  10. Setup your router to port forward the WAN port you specified to the HTTPS port used by the server. There is a note on the screen telling you the exact ports and IP to use.
  11. Press the Check button. If the port is forwarded correctly you will see a message saying "Your Unraid Server is reachable from the Internet"
  12. To access your server using Remote Access, login to the My Servers Dashboard and click the Remote Access link.

Optional step for Unraid 6.10

If you want to use secure https for local access to your server as well, navigate to Settings -> Management Access. In the CA-signed certificate area, if there are no warnings about DNS Rebinding then go ahead and set Use SSL/TLS to Auto. If there are warnings about DNS Rebinding see A note regarding DNS Rebinding Protection.

Note that once SSL is set to Auto, your client computers will need access to DNS in order to access your server. This means if your Internet connection drops you will likely lose access to your server's webgui. See How to access your server when DNS is down.

Using Custom Certificates

If you intend to use a custom certificate for secure remote access, you will be unable to utilize the My Servers remote access solution. For more details, please see this article.

A note regarding DNS Rebinding Protection

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.

How to access your server when DNS is down

Once you enable local SSL per the instructions above, you will access your server through a Fully Qualified Domain Name:

  https://yourpersonalhash.unraid.net or https://yourpersonalhash.unraid.net:<https_port> (if your https port is not the default of 443)

This is required in order to utilize a fully valid SSL certificate. A downside is if you temporarily lose Internet access and your browser has not cached the DNS for yourpersonalhash.unraid.net, you will be unable to access the webgui.

Unraid 6.10

If the Internet goes down and you lose access to DNS, do the following:

  • If Use SSL/TLS is set to Yes, then you can access your server using: https://[servername].[localTLD] or https://[servername].[localTLD]:<https_port> (if your https port is not the default of 443)
  • If that doesn't work, or if Use SSL/TLS is set to Auto, then using telnet, SSH or local keyboard/monitor log in to the server and type: use_ssl no
  • Now you will be able to access your server's webgui via: http://<ip_address> (note: http not https) or http://<server_ip>:<http_port> (if your http port is not the default of 80)
  • When the Internet comes back, navigate to Settings -> Management Access and set Use SSL/TLS back to Auto to re-enable local SSL.

Unraid 6.9

While you wait for your Internet access to be restored, access the server with this URL:

  https://<server_ip> (note: https not http) or https://<server_ip>:<https_port> (if your https port is not the default of 443)

Your browser will bring up a warning that the SSL certificate does not match the url you are tryin to visit. It is safe to ignore this warning since you are are intentionally using the wrong url.

How to disable SSL for local access

If you decide you would rather not use the secure https://yourpersonalhash.unraid.net url for local access, you can disable SSL. There is no need to uninstall the My Servers plugin, in fact that will have no effect on SSL as this is a core feature of Unraid and not the plugin.

Navigate to Settings -> Management Access, set Use SSL/TLS to No and hit Apply. In Unraid 6.9 this will also disable the Remote Access feature at the same time.

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 My Servers section and click the Sign Out button.

Sign out.png

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).

Uninstalling the plugin

Note: if your goal is to change your url from https://yourpersonalhash.unraid.net back to http://computername, see How to disable SSL for local access. Uninstalling the plugin will have no effect on your url!

As of the 8/25/21 release of My Servers, uninstalling the plugin will automatically:

  • Deactivate and delete the backup files from your flash drive. We will provide a way to remove them from our server later.
  • Disable Remote Access and delete the corresponding DDNS entry. Please remember to disable any port forward that you configured in your router related to this feature.
  • Sign Out from Unraid.net.

Note that if you have the webgui open in multiple browser tabs, you should close or reload them after uninstalling the plugin.


If you uninstalled a previous version of the plugin, here are the steps to make sure everything is deactivated:

  • Login to your router and disable any port forward you setup for Remote Access
  • On your flash drive, delete the .git folder. This is your local copy of the flash backup. We will provide a way to remove them from our server later.
  • On your flash drive, delete the config/plugins/dynamix.my.servers/myservers.cfg file. Note that this file will be recreated in Unraid 6.10, that is not a problem.

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 signs in to Unraid.net, it opens a secure connection to our hosted infrastructure and sends just enough data so we can give you a meaningful overview of your servers in the My Servers Dashboard. We do not keep historical data, just the most recent update from your server which includes:

  • Your server's hostname, description, and icon
  • Your server's keyfile state / type
  • Your server's Local Access URL
  • Your server's LAN IP, if SSL is enabled.
  • Your server's Remote Access URL and WAN IP, if Remote Access is enabled.
  • The version of Unraid that is installed, and its uptime
  • The version of the My Servers plugin that is installed, and uptime of the unraid-api
  • The size of your array and the amount used (just numbers, no details about what is stored on the array)
  • The number of Docker Containers and VMs installed and started

Separate and unrelated to the My Servers Dashboard, the Flash Backup service stores your server's configuration data.

This data is stored solely for the purpose of providing services to you through our platform and is not publicly accessible. To remove this data from our servers you must follow the procedure listed in the "Uninstalling the plugin" section as well as remove all SSL certificates generated for you through our Let's Encrypt partnership.

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

Until we are able to fully encrypt the flash backups on our servers, 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
  • Public, private, or shared WireGuard keys