Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
Next revisionBoth sides next revision
cloudappliance/applinstallation [2018_01_30 17:23] – external edit 127.0.0.1cloudappliance/applinstallation [2019_10_17 00:03] – steven
Line 1: Line 1:
- 
- 
- 
- 
 ====== Storage Made Easy Cloud Appliance installation Guide ====== ====== Storage Made Easy Cloud Appliance installation Guide ======
  
 +For the latest installation guide see [[:cloudappliance/applinstallv1906]].
  
 ===== 1 Requirements ===== ===== 1 Requirements =====
  
 +You will need VMWare softwafre to run the virtual machine,
  
 +  * VMWare player
 +  * VMWare Workstation 8.x
 +  * VMWare Fusion 4.x
 +  * VMWare ESX/i 4.x/5.x
  
-You will need VMWare software to run the virtual machine,+Please note we provide the appliance as 64 bit OS, VMWare disk image and OVF format. The VMWare is setup to use DHCP, this can be changed during configuration. If you want to run it in Microsoft Hyper-V, XEN, KVM etc you can convert the OVF image to VHD format (return to the Appliance section for links to how to do this.)
  
-  * - VMWare player +**Hardware**
-  * - VMWare Workstation 8.x +
-  * - VMWare Fusion 4.x +
-  * - VMWare ESX/i 4.x/5.x+
  
-Please note we provide the appliance as 64 bit OS, VMWare disk image and OVF format. The VMWare is setup to use DHCP, this can be changed during configuration. If you want to run it in Microsoft Hyper-V, XEN, KVM etc you can convert the OVF image to VHD format (return to the Appliance section for links to how to do this.)+For evaluation Purposes: 
 +  * 2 GB RAM for the VM 
 +  * 2 cores dedicated 
 +  * 20 GB Hard Disk Space
  
-\\ **Hardware**\\ \\  For evaluation Purposes:\\ \\ +For Production purposes: 
-  * - 2 GB RAM for the VM +  * 4-8GB RAM 
-  * - 2 cores dedicated +  * 2-4 Cores depending on the number of users 
-  * - 20 GB Hard Disk Space+  * 20 GB Hard Disk space
  
-\\  For Production purposes:\\ \\ +Please note we recommend tuning the appliance components in production and can provide help for that. You can also increase the size of the Hard Disk by following the instructions provided by VMWare:
-  * - 4–8GB RAM +
-  * - 2–4 Cores depending on the number of users +
-  * - 20 GB Hard Disk space\\ \\  Please note we recommend tuning the appliance components in production and can provide help for that. You can also increase the size of the Hard Disk by following the instructions provided by VMWare:\\ \\ http://kb.vmware.com/selfservice/microsites/search.do?cmd=displayKC&docType=kc&docTypeID=DT_KB_1_1&externalId=1006371+
  
-\\ **Configuration:**\\ \\ +http://kb.vmware.com/selfservice/microsites/search.do?cmd=displayKC&docType=kc&docTypeID=DT_KB_1_1&externalId=1006371
-To configure the appliance you will need+
  
-  * - A Domain Name that is registered (required for production or internet access. Can be run internally and tested without this) +**Configuration:** 
-  * - A wildcard SSL certificate for your chosen domain name (required if you wish to test SSL but can be self generated) + 
-  * - You will need to register the following DNS entries(please note you can change the sub-domain names as you wish)\\ \\  - sme.yourdomain.com\\  - webdav.yourdomian.com\\  - s3.yourdomain.com+To configure the appliance you will need: 
 +  * A Domain Name that is registered (required for production or internet access. Can be run internally and tested without this) 
 +  * A wildcard SSL certificate for your chosen domain name (required if you wish to test SSL but can be self generated) 
 +  * You will need to register the following DNS entries(please note you can change the sub-domain names as you wish) 
 +   * sme.yourdomain.com 
 +   * webdav.yourdomian.com 
 +   * s3.yourdomain.com
  
-\\ 
 (Please note webdav DNS entry should be webdav.DomainName e.g if the domain name is sme.yourdomain.com then the webdav url should be webdavsme.yourdomain.com.) (Please note webdav DNS entry should be webdav.DomainName e.g if the domain name is sme.yourdomain.com then the webdav url should be webdavsme.yourdomain.com.)
  
-  * - An IP address that configured to point to the domains +  * An IP address that configured to point to the domains 
-  * - An email address with SMTP server details to connect to that account. This will be used to send emails +  * An email address with SMTP server details to connect to that account. This will be used to send emails 
-  * - A catch all email address if you want to use filebox functionality. You will need IMAP server details for this email address+  * A catch all email address if you want to use filebox functionality. You will need IMAP server details for this email address 
 + 
 +**Firewall**
  
-\\ **Firewall**\\ \\ 
 You will need to following ingress ports open\\  80, 443, 21, 990 You will need to following ingress ports open\\  80, 443, 21, 990
  
 If you want to use FTP/S then you will need to configure the firewall to allow FTP passive connections If you want to use FTP/S then you will need to configure the firewall to allow FTP passive connections
  
-\\ **Storage**\\ \\ +**Storage**
-The appliance can attach to all the storage providers supported by SME. You can see a list at http://storagemadeeasy.com/cloud_list.\\ \\  To attach your local storage you will need to provide an FTP or WebDav interface on top of your local storage.+
  
-\\ **Authentication details / License Key**\\ \\ +The appliance can attach to all the storage providers supported by SME. You can see a list at http://storagemadeeasy.com/cloud_list.
-You will require the Authentication Details and License key that you were provided in an email to be able to configure the Appliance. Please have these to hand.+
  
 +To attach your local storage you will need to provide an FTP or WebDav interface on top of your local storage.
  
 +**Authentication details / License Key**
  
 +You will require the Authentication Details and License key that you were provided in an email to be able to configure the Appliance. Please have these to hand.
  
 ===== 2 Configuring the SME Appliance ===== ===== 2 Configuring the SME Appliance =====
  
 +The configuration server allows you to configure
  
 +  * Static IP address
 +  * Domain name
 +  * SSL certificate
  
-The configuration server allows you to configure+**Login**
  
-  * - Static IP address +Start the VMWare instance and login to the appliance. The IP address is displayed in the console.
-  * - Domain name +
-  * - SSL certificate+
  
-\\ **Login**\\ 
-Start the VMWare instance and login to the appliance. The IP address is displayed in the console.\\ \\ 
 {{:/cloudappliance:applinstallation:sme_voila_capture18.png}} {{:/cloudappliance:applinstallation:sme_voila_capture18.png}}
-\\ **Setting the IP Address**\\  Note if you don’t see an IP address please contact your system admin to enable DHCP or if DHCP is not possible for your environment then login to the Appliance as the smeconfiguser and run the following command to start the script:\\ \\ ''%%cd installer ./smenetconf.pl%%''\\ \\  This will invoke a wizard that will enable a static network IP address to be added. + 
-\\ **Change Password**\\  Please note that on first login it is strongly recommended to change the password. To do this use the password command below:\\ \\ ''%%       passwd%%''\\ \\ **DNS and SSL Certificates**\\  If you wish to configure the Appliance DNS and SSL certificates then, after login, you can launch the Appliance installer. If you wish to simply check out the features of the web Appliance and use the Appliance only in IP mode (rather than DNS) and test clients over http only you can navigate straight to the Appliance using the IP address and login using the authentication details you will have been provided in an email.\\ \\  To move forward and configure the appliance DNS / SSL then either logged directly in to the Appliance, or from an ssh session, enter\\ \\ ''%% cd installer ./configserver.pl%%''\\ \\+**Setting the IP Address** 
 + 
 +Note if you don't see an IP address please contact your system admin to enable DHCP or if DHCP is not possible for your environment then login to the Appliance as the smeconfiguser and run the following command to start the script: 
 + 
 +    cd installer 
 +    ./smenetconf.pl 
 +     
 +This will invoke a wizard that will enable a static network IP address to be added. 
 + 
 +**Change Password** 
 + 
 +Please note that on first login it is strongly recommended to change the password. To do this use the password command below: 
 + 
 +    passwd 
 +     
 +**DNS and SSL Certificates** 
 + 
 +If you wish to configure the Appliance DNS and SSL certificates then, after login, you can launch the Appliance installer. If you wish to simply check out the features of the web Appliance and use the Appliance only in IP mode (rather than DNS) and test clients over http only you can navigate straight to the Appliance using the IP address and login using the authentication details you will have been provided in an email. 
 + 
 +To move forward and configure the appliance DNS / SSL then either logged directly in to the Appliance, or from an ssh session, enter 
 + 
 +    cd installer ./configserver.pl 
 +    
 This will start the configuration server on port 8080. Please make sure that you shutdown the configuration server after you have finished configuring the appliance. This will start the configuration server on port 8080. Please make sure that you shutdown the configuration server after you have finished configuring the appliance.
  
-\\ 
 Once the configuration server has been started, on your local machine, in the browser open the following URL: Once the configuration server has been started, on your local machine, in the browser open the following URL:
  
-**http:%%//%%IP Address:8080**+    http://IP Address:8080
  
-\\ 
 You should see the Welcome Screen. To start configuration, please click Configuration link. You should see the Welcome Screen. To start configuration, please click Configuration link.
  
-\\ +{{:/cloudappliance:applinstallation:sme_welcomescreen.png}} 
-{{:/cloudappliance:applinstallation:sme_welcomescreen.png}}\\ \\ \\ The Configuration page shows different options that you can configure.+ 
 +The Configuration page shows different options that you can configure.
  
-\\ 
 {{:/cloudappliance:applinstallation:sme_configuration.png}} {{:/cloudappliance:applinstallation:sme_configuration.png}}
  
-\\ **Hostname Settings**\\ \\ +**Hostname Settings** 
-In the â€œSME Server Hostname Settings” options you set the domain names that will be used to access the File Server.\\  You should have the IP address that you want to use configured in your DNS server. This change requires a reboot of the appliance.+ 
 +In the SME Server Hostname Settings options you set the domain names that will be used to access the File Server. 
 + 
 +You should have the IP address that you want to use configured in your DNS server. This change requires a reboot of the appliance.
  
-\\ 
 {{:/cloudappliance:applinstallation:sme_hostnamesettings.png}} {{:/cloudappliance:applinstallation:sme_hostnamesettings.png}}
-\\ **Network Settings**\\ 
-In “SME Server Network Settings” the Admin can set the static IP address, Gateway, IP Mask and DNS server to resolve hostnames. This change requires a reboot of the appliance. 
  
-\\ +**Network Settings**
-{{:/cloudappliance:applinstallation:sme_network.png}}\\ \\  If you enter the wrong settings, you will not be able to ssh into the appliance. In this case, login from the console as smeconfiguser\\ \\ ''%%cd installer%%''\\  and enter the following command:+
  
-\\ +In €œSME Server Network Settings the Admin can set the static IP address, Gateway, IP Mask and DNS server to resolve hostnames. This change requires a reboot of the appliance. 
-''%%./restore-system-settings%%''+ 
 +{{:/cloudappliance:applinstallation:sme_network.png}} 
 + 
 +If you enter the wrong settings, you will not be able to ssh into the appliance. In this case, login from the console as smeconfiguser 
 + 
 +    cd installer 
 +     
 +and enter the following command: 
 + 
 +    ./restore-system-settings
  
-\\ 
 {{:/cloudappliance:applinstallation:sme_voila_capture21.png}} {{:/cloudappliance:applinstallation:sme_voila_capture21.png}}
 +
 This will set the configuration to default settings and you can start with default configuration This will set the configuration to default settings and you can start with default configuration
  
-\\ **SSL Certificates (recommended for production)**\\ \\+**SSL Certificates (recommended for production)** 
 The File Server uses https to communicate with the clients for security. If you are planning to use WebDav and S3 protocol adapters then you will need a wildcard SSL certificate that matches the domain names that you have configured. Other wise the SSL certificate should match the host name that you have configured. The File Server uses https to communicate with the clients for security. If you are planning to use WebDav and S3 protocol adapters then you will need a wildcard SSL certificate that matches the domain names that you have configured. Other wise the SSL certificate should match the host name that you have configured.
  
-\\ 
 {{:/cloudappliance:applinstallation:sme_ssl.png}} {{:/cloudappliance:applinstallation:sme_ssl.png}}
-\\+
 This will require a reboot. This will require a reboot.
  
 Please Note that if you don’t set SSL certificates then some native clients that are set to use https will not be able to communicate with the appliance. You may be need to configure them to use http. Please Note that if you don’t set SSL certificates then some native clients that are set to use https will not be able to communicate with the appliance. You may be need to configure them to use http.
  
-**Generating a Certificate Signing Request**\\ +**Generating a Certificate Signing Request** 
-To generate a Certificate Signing Request(CSR) if you are applying for certificates please see:\\ \\ http:%%//%%httpd.apache.org/docs/2.2/ssl/ssl_faq.html#realcert+ 
 +To generate a Certificate Signing Request(CSR) if you are applying for certificates please see: http://httpd.apache.org/docs/2.2/ssl/ssl_faq.html#realcert 
 + 
 +**Setting up self-certified Certificates** 
 + 
 +If you wish to use a self-signed certificate to test https then we suggest following steps 1 to 4 in [[http://www.akadia.com/services/ssh_test_certificate.html|this external guide]] to generate the necessary certificates. 
 + 
 +The guide shows the use of the "openssl" utility, which is available on the command line of the SME appliance. Once you have followed this guide you will have three files, server.crt; server.csr;server.key. 
 + 
 +Once you have these run the SME Config installer open server.crt in a text editor and paste the content into the "SSL public certificate text". Similarly paste the contents of server.key into the "SSL certificate private key" text input. 
 + 
 +Now follow the wizard to save the settings and at the end choose the reboot option. You should now be set to use private certificate SSL but note you cannot use these outside of an internal network unless the IP address is available externally.
  
-\\ **Setting up self-certified Certificates**\\ +**System Update**
-If you wish to use a self-signed certificate to test https then we suggest following steps 1 to 4 in [[http://www.akadia.com/services/ssh_test_certificate.html|this external guide]] to generate the necessary certificates.\\ \\ . The guide shows the use of the "openssl" utility, which is available on the command line of the SME appliance. Once you have followed this guide you will have three files, server.crt; server.csr;server.key.\\ \\ Once you have these run the SME Config installer open server.crt in a text editor and paste the content into the "SSL public certificate text". Similarly paste the contents of server.key into the "SSL certificate private key" text input.\\ \\ Now follow the wizard to save the settings and at the end choose the reboot option. You should now be set to use private certificate SSL but note you cannot use these outside of an internal network unless the IP address is available externally.+
  
-\\ \\ **System Update**\\ 
 Here you can update the appliance with the latest release. You can check for a new version here. When the appliance is updated with the new version, the installed version is saved and allows you to rollback to the previous installed version. Here you can update the appliance with the latest release. You can check for a new version here. When the appliance is updated with the new version, the installed version is saved and allows you to rollback to the previous installed version.
  
 {{:/cloudappliance:applinstallation:sme_systemupdate.png}} {{:/cloudappliance:applinstallation:sme_systemupdate.png}}
 {{:/cloudappliance:applinstallation:sme_updates.png}} {{:/cloudappliance:applinstallation:sme_updates.png}}
-\\ \\ **Rebooting**\\ 
-Smeconfiguser has permissions to reboot the server. You can reboot from the ssh console or using the configuration tool.\\ \\ ''%%  sudo /usr/bin/reboot  sudo /usr/bin/poweroff%%'' 
  
-Once you have configured and rebooted your appliance, open a browser at http:%%//%%yourdomain or http:%%//%%SME appliance IP Address and you will be able to login as appladmin+**Rebooting** 
 + 
 +Smeconfiguser has permissions to reboot the server. You can reboot from the ssh console or using the configuration tool. 
 + 
 +    sudo /usr/bin/reboot   
 +    sudo /usr/bin/poweroff 
 + 
 +Once you have configured and rebooted your appliance, open a browser at http://yourdomain or http://SME appliance IP Address and you will be able to login as appladmin 
 + 
 +**Customizing the Appliance**
  
-\\ **Customizing the Appliance**\\ \\ 
 Using your browser login as **appladmin** . **Change the password after logging in for the first time**. You will see the home screen, on the right hand side you will see different options to customise the website. Using your browser login as **appladmin** . **Change the password after logging in for the first time**. You will see the home screen, on the right hand side you will see different options to customise the website.
  
-The appladmin account is used to configure the functionality of the appliance. Depending on your key different options will be available.\\ \\ {{:/cloudappliance:applinstallation:sme_homescreen.png}}+The appladmin account is used to configure the functionality of the appliance. Depending on your key different options will be available. 
 +{{:/cloudappliance:applinstallation:sme_homescreen.png}} 
 + 
 +**Entering the License Key**
  
-**Entering the License Key**\\ \\ 
 Enter the license key and depending on the key new functionality will become available in the right hand side menu. If the key is expired or you have not entered a valid key then you will only be able to use clouduser account. Enter the license key and depending on the key new functionality will become available in the right hand side menu. If the key is expired or you have not entered a valid key then you will only be able to use clouduser account.
  
 {{:/cloudappliance:applinstallation:sme_licensekey.png}} {{:/cloudappliance:applinstallation:sme_licensekey.png}}
-**Changing the look and feel**\\ + 
-You can brand and change logos for the of the appliance including the default logos for the login screen and the one displayed in the top banner after a user logs in.\\ \\ Also see the [[cloudappliance/branding|dedicated Wiki entry]] on this topic.+**Changing the look and feel** 
 + 
 +You can brand and change logos for the of the appliance including the default logos for the login screen and the one displayed in the top banner after a user logs in. 
 + 
 +Also see the [[cloudappliance/branding|dedicated Wiki entry]] on this topic.
  
 {{:/cloudappliance:applinstallation:sme_l&f1.png}} {{:/cloudappliance:applinstallation:sme_l&f1.png}}
 {{:/cloudappliance:applinstallation:sme_l&f2.png}} {{:/cloudappliance:applinstallation:sme_l&f2.png}}
-\\ \\ **Email Templates (Optional)**\\+ 
 +**Email Templates (Optional)** 
 The default email templates that are used with the Appliance for customer interactions can be changed here. The default email templates that are used with the Appliance for customer interactions can be changed here.
  
 {{:/cloudappliance:applinstallation:sme_voila_capture51.png}} {{:/cloudappliance:applinstallation:sme_voila_capture51.png}}
-\\ \\ **Site Wide Functionality**\\ 
-This screen allows you enable/disable appliance wide functionality.\\ \\ {{:/cloudappliance:applinstallation:sme_voila_capture53.png}} 
  
-\\ **Email and Filebox Settings**\\ \\ **SMTP Settings:**\\+**Site Wide Functionality** 
 + 
 +This screen allows you enable/disable appliance wide functionality. 
 + 
 +{{:/cloudappliance:applinstallation:sme_voila_capture53.png}} 
 + 
 +**Email and Filebox Settings** 
 + 
 +**SMTP Settings:** 
 The File Server uses an external email SMTP server to send registration and notification emails. Here you enter the account details that will be used to send emails. The File Server uses an external email SMTP server to send registration and notification emails. Here you enter the account details that will be used to send emails.
  
-FileBox IMAP Settings (Optional):\\ \\ +FileBox IMAP Settings (Optional): 
-The filebox feature provides each user and shared folder a dedicated email address. This is an optional feature. A user can send email with attachment to the firebox address. For this you will need a catch all email address and IMAP server.\\ \\ {{:/cloudappliance:applinstallation:sme_voila_capture54.png}}+ 
 +The filebox feature provides each user and shared folder a dedicated email address. This is an optional feature. A user can send email with attachment to the firebox address. For this you will need a catch all email address and IMAP server. 
 + 
 +{{:/cloudappliance:applinstallation:sme_voila_capture54.png}}
  
 **Integration Settings (Optional)** **Integration Settings (Optional)**
-SME appliance can use Zoho to view and edit MS Office (Word, Powerpoint and Excel) and RTF documents. You will need to register for Zoho API at http://apihelp.wiki.zoho.com/ and enter the API key.\\ \\ {{:/cloudappliance:applinstallation:sme_voila_capture55.png}} 
  
-\\ **Meta Data Backup**\\ +SME appliance can use Zoho to view and edit MS Office (Word, Powerpoint and Excel) and RTF documents. You will need to register for Zoho API at http://apihelp.wiki.zoho.com/ and enter the API key. 
-The only data that is stored is data about the files and any classification information the user adds. This can be backed up for disaster recovery (as this data is stored in a database it can also be made highly available.)\\ \\ {{:/cloudappliance:applinstallation:sme_backup.png}}+ 
 + {{:/cloudappliance:applinstallation:sme_voila_capture55.png}} 
 + 
 +**Meta Data Backup** 
 + 
 +The only data that is stored is data about the files and any classification information the user adds. This can be backed up for disaster recovery (as this data is stored in a database it can also be made highly available.) 
 + 
 +{{:/cloudappliance:applinstallation:sme_backup.png}}
  
 **Changing the Password**\\ **Changing the Password**\\
-You can change the ApplAdmin password.\\ \\ {{:/cloudappliance:applinstallation:sme_password.png}}+ 
 +You can change the ApplAdmin password. 
 +{{:/cloudappliance:applinstallation:sme_password.png}}
  
 You can see a list of all users and the packages that are assigned to them by clicking on **Users** on the left hand side. You can see a list of all users and the packages that are assigned to them by clicking on **Users** on the left hand side.
Line 173: Line 246:
 You can change a users password, activate or inactivate and delete users and also configure the functionality available to him. You can change a users password, activate or inactivate and delete users and also configure the functionality available to him.
  
-\\ 
 {{:/cloudappliance:applinstallation:sme_users.png}} {{:/cloudappliance:applinstallation:sme_users.png}}
 {{:/cloudappliance:applinstallation:sme_usersedit.png}} {{:/cloudappliance:applinstallation:sme_usersedit.png}}
-\\ \\ **Creating a new User**\\ + 
-To Add a user Click on â€œAdd User” and enter the details. A new user can also be added using the API.\\ \\ {{:/cloudappliance:applinstallation:sme_useradd.png}}+**Creating a new User** 
 + 
 +To Add a user Click on Add User and enter the details. A new user can also be added using the API. 
 + 
 +{{:/cloudappliance:applinstallation:sme_useradd.png}}
  
 **User Packages** **User Packages**
 +
 You can edit and create User packages that are assigned to users. Sample packages are provided. User Packages allow you configure available functionality and default setting for new users. You can edit and create User packages that are assigned to users. Sample packages are provided. User Packages allow you configure available functionality and default setting for new users.
  
 {{:/cloudappliance:applinstallation:sme_package1.png}} {{:/cloudappliance:applinstallation:sme_package1.png}}
 {{:/cloudappliance:applinstallation:sme_package2.png}} {{:/cloudappliance:applinstallation:sme_package2.png}}
-\\ \\ 
-**Summary:** 
  
-This is the end of the configuration guide for the SME Cloud Appliance.\\ \\ 
  
 +**Summary:**
  
 +This is the end of the configuration guide for the SME Cloud Appliance.
  
  
© Copyright 2024 Nasuni.