Installing OmniStream

Installing and configuring OmniStream

You have followed the Linux crash course and know your way around Linux and the terminal. That means you now have a fresh new Debian installation and can access your server using PuTTY or its equivalent on your OS.

What is OmniStream?

OmniStream is a menu driven fully automatic installation of all your streaming needs. It doesn't get simpler than that! We are in no way responsible how you use these applications - that is entirely up to you. Please respect and obey the copyright laws of your country.

You can find the project on GitHub.

Getting started

You are probably still logged in your terminal session (PuTTY) and looking at that beautiful green cursor. Let's continue where we left off... But first, please read this important disclaimer:

    • This software is supplied "AS IS" without any warranties and support. You are solely responsible for determining whether OmniStream is compatible with your equipment and other software installed on your system. Make sure you have a backup of all your important data!

Ok, with that out of the way, let's get going!

Now all you need to do is copy the line below (Ctrl-C) and paste this in PuTTY (right click), then press Enter.

wget tinyurl.com/omniSetup -O /tmp/setup && chmod 700 /tmp/setup && /tmp/setup

Note: This is a rather long line, make sure you copy everything (even if it is wrapped around multiple lines).

Root installation

If you are new to Linux and followed the previous tutorial, you are probably still logged in as the root user.

If that is the case, Omni will inform you that a new user with sudo (admin) rights needs to be created. Type the letter Y - you are sure you want to create a new user. No one should ever perform tasks as root... It's a Linux thing.

Next, you will be asked to pick a password for your new user. This is the password you will have to type in every time you need to maintain Linux... so make sure it is a strong password, yet easy to remember.

You can fill out your personal information if you wish, or enter through the fields leaving them empty. In the example below we picked perplexed as our user.

Exit your PuTTY root session and log back in as your new user.

Installation as user

Now that you are logged in as your user with all the correct privileges, you will need to run the Omni setup again. This time you can just type:

/tmp/setup

You may be asked to select a default editor. If you aren’t sure what to choose, pick nano… it is by far the easiest to use. This tutorial uses nano throughout.

Timezone

Next, you will be asked to pick a timezone. Pick the one you live in.

Then sit back and relax while a number of essential apps and services get installed. Be patient… It will take a few minutes.

OmniStream initialization

During the installation you will be asked to provide some essential information. Follow along with this tutorial for best practises, though most will speak for itself.

Domain

First you will be asked to enter your domain. Enter the domain you would like to use and press the Enter key (or click OK).

Make sure you enter a domain that you own. Popular places to register a domain are CloudFlare, Domain.com, NameCheap, GoDaddy or Google.

Email

Next you need to enter an email address. This is only used to register with Let’s Encrypt.

You can enter a fake address, but you won’t be getting any notifications about expired SSL certificates or other important information from Let's Encrypt.

Rclone

As mentioned before, Rclone is the heart of OmniStream. It needs to be configured to connect to your cloud service.

After selecting YES you will be taken to the “rclone config” screen. For more information, check the Rclone documentation and follow the path of your cloud service. For example, you can find detailed information on how to configure your Google drive with Rclone.

You will be asked to confirm your mount name. I picked google.

Then click OK to proceed.

Keep that file!

If you previously installed Rclone on another server and still have your config information, you can select NO to paste the content of your rclone.conf file (you can find it in the ~/.config/rclone folder).

If you selected nano as your editor, you can save your file with Ctrl-X - then Y to save.

It would be a good idea to store the content of that file in a safe place, so you can use it over and over again and you’ll never have to go through the configuration process again.

Restoring from backup

The dialog will ask you if you are restoring from a backup. This tutorial will of course assume that you are installing this for the first time, so you will need to choose NO.

Media folder

By default, OmniStream assumes your media folder in your cloud service is named /Media. If however you named your folder differently, of course you have the ability to change your media directory to something else. In that case, select YES.

Then select the folder that you wish to use (in my case, I actually named my folder Media).

  • Pro tip: if you aren’t 100% sure if you set up Rclone correctly, this is a great way to find out. If you see your folders in your Cloud service, you know it went okay!

Advanced

The next option is the advanced setup. In almost all cases this is not needed (nor recommended). In very select situations it might be necessary, for example if you are installing OmniStream on an additional server. In that case, refer to the documentation on how to tweak your variables.

Since you are following this tutorial, it is assumed that you are installing Omni for the first time, so definitely select YES - you want to skip the advanced setup for now.

Traefik

The next question is about Traefik. This is the application that looks after your certificates.

Since it is assumed that you are following this tutorial because you are installing OmniStream for the first time, you will need to select YES.

You are now asked for a password to access Traefik. Traefik includes a console for viewing the virtual routers and paths that are setup. The default username is admin. Pick a password and then type it again for confirmation. Eventually, you can use this information to login at traefik.yourdomain.com - but that is a ways off still.

  • Pro tip: Traefik only needs to be set up once - you can take your configuration from server to server through the backup. If you previously installed Omni and have a backup, you can skip the rest of the setup by selecting NO.

DNS Settings

We’re nearly there! You will need to configure your DNS settings to make sure that you can access all your services through the revenant subdomain. For example, Plex can be reached on plex.yourdomain.com, Deluge on deluge.yourdomain.com, Netdata on netdata.yourdomain.com, etcetera.

For each of those entries, you need to provide a DNS entry (A record) with your registrar.

You now have a choice to make: to CloudFlare, or not to CloudFlare.

Cloudflare (recommended)

We very strongly recommend that you choose the CloudFlare method. It is a little more work to set up, but once done, you will never need to maintain your DNS settings ever again, nor worry about running out of SSL certificates.

Because it involves quite a few steps, we decided to create a separate tutorial on how to manage your DNS through CloudFlare. Trust me, you'll never look back!

Registrar (not recommended)

If for some reason you really don’t want to use CloudFlare, that is certainly possible. In that case, you need to manually create an A record for each entry using the DNS management tool of your registrar:

It’s a convoluted method that we definitely don’t recommend, but if that's what you want, make sure you select NO. In that case, you will use up one SSL certificate for each subdomain that you add.

You can check what DNS entries you need to create and what IP address they need to point to by typing omni dns after logging out and back in.

Important! Create your DNS entries before you bring Omni up. If you don’t, your new subdomain will take several hours to properly propagate and receive the SSL certificate.

That's it

Congratulations, OmniStream is now ready to use. Log out and back in as your user, then setup CloudFlare (optional) and finalize your installation to get your system up and running.