Documentation

Table of contents

Rockstor’s “Built on openSUSE” installer - Beta release

Thanks

Rockstor’s developers would like to thank the entire OSS community for making any of this possible. Specifically with our fledgling move / rebase on openSUSE Leap15.2 our thanks go to the openSUSE/SuSE organisations and the larger community for the extreme generosity we all benefit from in a myriad of seen and unseen ways.

Please note: Rockstor is in no way affiliated with openSUSE / SuSE and does not wish, under any circumstances, to misrepresent these organisations. Any errors you encounter are most likely our fault and we try, on a current volunteer basis, to support our users via our friendly forum.

It is hoped that Rockstor’s ongoing small contribution back to the larger community is of value, and if this is so for you please consider either subscribing to our Stable Channel updates or taking part in our developer orientated Testing Channel. Details of these Rockstor package update services are available in our Official Docs subsection Update Channels. Rockstor’s ongoing development is wholly dependent on community support via either of these channels and by positively participating in our forum, linked above. It is hoped that in time we can contribute back more significantly, and possibly financially, as our own community and Stable Channel subscriptions grow. Also note that irrespective of Rockstor update channel selection or otherwise, upstream updates are available by normal command line means and via our Web-UI. See Dashboard and System updates later in this guide for the details.

Our “Built on openSUSE” Kiwi-ng created installer

The existence of this installer, and those of many Linux distributions, is down in a major part to the Kiwi installer creation tool. I would specifically like to thank Marcus Schafer and David Cassany Viladomat of openSUSE/SuSE for their timely and rapid oem, partition, swap, and btrfs related fixes that were required for our initial version of this installer. Please contribute to this important multi-distribution upstream project if you have the means and/or talent KIWI - Next Generation.

Initial Selection Screen

Select the “Install Rockstor- …” option. The default is “Boot from Hard Disk”.

../_images/initial_screen.png

Use cursor keys to highlight, then the “Enter” key to select. Only use Failsafe if the ‘Install …’ option fails, i.e. the screen goes blank and does not return.

Select Installation Disk

This will usually be your smallest disk: dedicated to system only use. If unsure do not proceed and select <Cancel> via Tab key and then Enter.

../_images/select_installation_disk.png

Use cursor keys to highlight, then the “Enter” key to select. Only devices less than 500 GB are shown. Larger disks are assumed to be data disks.

Destroying ALL data on …, continue ?

Do not proceed if at all unsure. This will wipe the entire contents of the indicated drive.

../_images/destroy-all-data.png

There will be a short period of scrolling text after this screen.

Loading Rockstor …

This step may take a while, please be patient.

../_images/loading-rockstor.png

After 100% there will be more scrolling text that may pause for a few minutes depending on computer and selected drive speed.

Select Locale

../_images/select_locale.png

Use cursor keys to highlight, then the “Enter” key to select.

Select Keyboard Layout

../_images/select_keyboard.png

Use cursor keys to highlight, then the “Enter” key to select.

GPLv2 & openSUSE based Rockstor License Agreement

Rockstor is “Built on openSUSE” and so our installer and the consequent installs are considered modified copies of the indicated openSUSE variant.

../_images/gplv2_license_agreement.png

Use cursor keys or Page-up / Page-down (space bar) to view the entire agreement. There are about 3 pages: Enter key to ‘Exit’ & ‘Agree’, or cursor keys to select ‘No’ in pop up.

Select Time Zone

../_images/select_time_zone.png

Use cursor keys to highlight, then the “Enter” key to select.

Enter Desired root User Password

../_images/enter_root_password.png

Confirm root User Password

../_images/confirm_root_password.png

Wait for the “Rockstor bootstrapping tasks”

The Rockstor tasks may take a few minutes to appear, depending on computer and selected drive speed. But will normally appear in less than 2 minutes.

../_images/wait_for_rockstor_tasks.png

Press the Enter key to show the login prompt again.

Login as the ‘root’ user

This one-off login is required to find the Web-UI’s address for use in your browser.

../_images/root_login_myip.png

Enter your systems’ https://.. address into your browser, Chrome/Firefox/.., for the Web-UI.

Visit Rockstor’s Web-UI

Rockstor defaults to a self signed https certificate.

Although more secure than ‘http’ (no ‘s’) your browser will still present a warning:

../_images/self_signed_certificate_advanced.png

As your Rockstor is on your Local Area Network (LAN) you can add an exception for this address. Click Advanced:

../_images/self_signed_certificate_accept.png

Then “Accept the Risk and Continue”. Do not do this for any site on the internet. You can use a ‘real’ domain certificate with Rockstor but this is an advanced topic beyond the scope of this installer guide.

Rockstor Setup and EULA

The following shows example entries for this initial Web-UI setup screen, they are blank by default.

../_images/initial_rockstor_setup_screen.png

Note the required “license agreement”. This link opens an additional tab shown below:

../_images/eula-page.png

Welcome banner

Directly after the initial Rockstor setup the following welcome banner introduces the Rockstor package Update Channels. A link to our documentation explaining these channels is included:

../_images/initial_welcome_banner.png

Dashboard and System updates

As the GPLv2 + licensed “rockstor” package stands on the shoulders of numerous OSS giants, it is possible to update all upstream, read openSUSE/SuSE, provided/curated packages via the flashing icon to the left of the “Uses openSUSE …” text in the top right of the Web-UI:

../_images/dashboard.png

Your Rockstor installation is now up and running and ready to be configured.

Update Channel reminder banner

Until an Update Channel selection has been made, a reminder banner appears whenever the dashboard is visited:

../_images/update_channel_reminder_banner.png

Enjoy your Rockstor DIY NAS ‘Built on openSUSE’

All upstream (openSUSE) updates, at time of installer creation, are pre-applied. The following repositories are included and enabled in the resulting install.

OSS (open source software only)

Update (security and bugfix updates for OSS packages)

shells (An OBS repo to provide our Web-UI integrated shell via shellinabox)

NetTime (to address a chrony Network-Manager related bug)

No Rockstor package update repository is configured until an Update Channel is selected.