Differences

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

Link to this comparison view

cloudappliance:applinstallv1705 [2018_01_30 17:23] (current)
Line 1: Line 1:
 +====== SME 1705 Enterprise File Fabric Appliance Installation Guide ======
 +
 +===== Systems Requirements =====
 +
 +This guide is for v1705 Enterprise File Fabric Appliance.
 +
 +The Appliance is provided as a VMWARE image, Hyper-V image and in OVF Format.
 +
 +For the VMWare image you will need VMWare software to run the virtual machine:
 +
 +  * VMWare player
 +  * VMWare Workstation 8.x
 +  * VMWare Fusion 4.x
 +  * VMWare ESX/i 4.x/5.x
 +
 +The VMWare is setup to use DHCP, this can be changed during configuration.
 +
 +If you want to run it in XEN, KVM etc you can convert the OVF image to VHD format (return to the Appliance section for links to how to do this.)
 +
 +===== Hardware =====
 +
 +==== For evaluation Purposes: ====
 +
 +  * 2 GB RAM for the VM
 +  * 2 cores dedicated
 +  * 40 GB Hard Disk Space
 +
 +==== For Production purposes: ====
 +
 +  * 4G+ RAM (more RAM is always better)
 +  * 2+ Cores (depending on the number of users)
 +  * 40 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|link]]
 +
 +===== Configuration =====
 +
 +To configure the appliance you will need
 +
 +  * A registered Domain Name that (required for production or internet access but the Appliance 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''​%%.%%''​DomaninName>​ e.g if domain name is sme.yourdomain.com then webdav url should be webdavsme.yourdomain.com.)
 +
 +  * An IP address that is 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.
 +  * A catch all email address if you want to use Filebox functionality. You will need IMAP server details for this email address
 +
 +===== Firewall =====
 +
 +You will need the following ingress ports open:
 +
 +80, 443, 21, 990, 2200
 +
 +If you want to use FTP/S then you will need to configure the firewall to allow FTP passive connections.
 +
 +===== 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 =====
 +
 +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.
 +
 +====== Configuring the SME Appliance ======
 +
 +The configuration server allows you to configure
 +
 +  * Static IP address
 +  * Domain name
 +  * SSL certificate
 +
 +===== Login =====
 +
 +Start the VMWare instance and ssh into the appliance. The IP address is displayed in the console.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_console.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:
 +
 +<​code>​smenetconf</​code>​
 +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:
 +
 +<​code>​passwd</​code>​
 +===== 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:
 +
 +<​code>​smeconfigserver</​code>​
 +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: http://IP Address:​8080
 +
 +You should see the Welcome Screen.
 +
 +To start configuration,​ please click Configuration link:
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_welcome.png}} The Configuration page shows different options that you can configure
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_configuration.png}}
 +
 +===== 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.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_hostnamesettings.png}}
 +
 +===== Network Settings =====
 +
 +In the “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.
 +
 +If you check the **Apply to SME configuration only** checkbox then changes are only made to SME components. This is useful if you have configured the network settings direcly in the operating system or are deploying the appliance in an IaaS e.g Amazon EC2 and do not want to change the operating system network settings.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_network.png}} If you enter the wrong settings, you will not be able to ssh into the appliance. In this case please use the below command:
 +
 +''​%% smerestoreconf%%''​
 +
 +This will set the configuration to default settings and you can start with default configuration
 +
 +===== SSL Certificates (Recommended) =====
 +
 +The File Server uses https to communicate with the clients for security. For https to work correctly you need wildcard SSL certificates that matches the domain name that you have configured. The SSL certificate should match the host name that you have configured.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_ssl.png}}
 +
 +This will require a reboot.
 +
 +Please Note that if you don’t set SSL certificates then some native clients that use https will not be able to communicate with the appliance.
 +
 +To generate a CSR if you are applying for certificates please see http://​httpd.apache.org/​docs/​2.4/​ssl/​ssl_faq.html#​realcert
 +
 +==== Setting up self-certified Certificates ====
 +
 +Self-signed certificates are generated with each new version of SME Appliance. From version 10 they are included out-of-the-box.
 +
 +===== 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.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_systemupdate.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%%''​
 +
 +====== Login as Admin ======
 +
 +Once you have configured and rebooted your appliance, open a browser at http://​yourdomain and you will be able to login as appladmin
 +
 +===== Customising 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.
 +
 +The appladmin account is used to configure the functionality of the appliance. Depending on your key different options will be available. {{:/​cloudappliance:​applinstallv1705:​img:​sme_homescreenwithoutlicense.png}}
 +
 +===== 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.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_licensekey1.png}}
 +
 +After you have entered the license key you will see more options.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_licensekey2.png}}
 +
 +===== Changing Look and Feel =====
 +
 +Companies can brand and change logos and look and feel for the Appliance.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_l&​f1.png}} The Color scheme can be managed at a very granular level:
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_l&​f2.png}}
 +
 +Advanced usage also enabled custom CSS style sheets to be applied. {{:/​cloudappliance:​applinstallv1705:​img:​sme_l&​f3.png}}
 +
 +===== User Registration =====
 +
 +User Registration can be customized using the options in the User registration section.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_userregistration1.png}}{{:/​cloudappliance:​applinstallv1705:​img:​sme_userregistration2.png}}{{:/​cloudappliance:​applinstallv1705:​img:​sme_userregistration3.png}}
 +
 +===== Annotations =====
 +
 +The SME Appliance is provided with a comprehensive PDF annotation suite. The Annotations can be enabled for users at a package level.
 +
 +Please refer to the SOLR and Burn Docs [[cloudappliance/​solr/#​enabling-the-search-and-burn-service|here]] for guidance on how to configure the PDF burn service.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_annotations.png}}
 +
 +===== Email Templates (Optional) =====
 +
 +The default email templates that are used with the Appliance for customer interactions can be changed here.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_emailtemplates.png}}
 +
 +===== Functionality =====
 +
 +This screen allows you enable/​disable appliance wide functionality. {{:/​cloudappliance:​applinstallv1705:​img:​sme_sitefunctionality.png}}
 +
 +===== Email and Filebox Settings =====
 +
 +==== SMTP Setttings ====
 +
 +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.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_smtpconfig.png}}
 +
 +==== 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:​applinstallv1705:​img:​sme_fileboxconfig.png}}
 +
 +===== App Integrations (Optional) =====
 +
 +The 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.
 +
 +Also if you want to add your development keys for cloud services you can do here {{:/​cloudappliance:​applinstallv1705:​img:​sme_appintegration1.png}}{{:/​cloudappliance:​applinstallv1705:​img:​sme_appintegration2.png}}
 +
 +===== Search Integration =====
 +
 +Please see the SOLR configuration guide [[cloudappliance/​solr|here]] for search configuration.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_search.png}}
 +
 +===== Tests =====
 +
 +You can test email templates here {{:/​cloudappliance:​applinstallv1705:​img:​sme_tests.png}}
 +
 +===== Tasks =====
 +
 +Here you will see background tasks that you have initiated as an administrator.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_tasks.png}}
 +
 +===== Messages =====
 +
 +As an admin you can send users messages {{:/​cloudappliance:​applinstallv1705:​img:​sme_messages.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:​applinstallv1705:​img:​sme_backup.png}}
 +
 +===== Changing the Password =====
 +
 +You can change the ApplAdmin password. {{:/​cloudappliance:​applinstallv1705:​img:​sme_password.png}}
 +
 +===== Users =====
 +
 +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 change a users password, activate or inactivate and delete users and also configure the functionality available to him.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_users1.png}}{{:/​cloudappliance:​applinstallv1705:​img:​sme_users2.png}}
 +
 +You can also edit users {{:/​cloudappliance:​applinstallv1705:​img:​sme_edituser1.png}}{{:/​cloudappliance:​applinstallv1705:​img:​sme_edituser2.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:​applinstallv1705:​img:​sme_adduser.png}}
 +
 +===== 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.
 +
 +{{:/​cloudappliance:​applinstallv1705:​img:​sme_packages1.png}}{{:/​cloudappliance:​applinstallv1705:​img:​sme_packages2.png}}{{:/​cloudappliance:​applinstallv1705:​img:​sme_packages3.png}}
 +
 +====== End ======
 +
 +This is the end of the configuration guide for the SME Cloud Appliance.
 +