Difference between revisions of "TubeStudio Installation Instructions"

From TMM Wiki
Jump to navigationJump to search
 
(51 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
Below are the instructions for self installation of Too Much Media's TubeStudio.  
+
{{TubeStudio Manual
 +
| show_about_section = true
 +
}}
 +
 
 +
 
 +
Below are the instructions for installing Too Much Media's TubeStudio.  There are two parts to the installation procedure: the server installation and the web installation.  If you are unfamiliar with using ssh you should have your system admin or your hosting provider complete the server installation for you.
  
  
 
== Server Instructions ==
 
== Server Instructions ==
−
The quick installation contains a simple list of instructions and expects the installer to be able to follow an on screen prompts and questions as well as configure any needed systems on the server.
+
You will need to first ssh into the server you wish to use for your TubeStudio installation.
  
 
=== Download ===
 
=== Download ===
−
Download Tube Studio to the web server that will run your tube sites.
+
You can download the latest version of TubeStudio from the following URL:<br>
 +
https://clients.toomuchmedia.com/tubestudio.tar.gz<br>
 +
Please upload the tar file to the appropriate folder on your server. 
 +
<br><Br>
 +
 
 +
<span style="color:red">NOTE: </span> Its is very important that you do not install TubeStudio into a web-accessible folder. Uploading and installing to your home  directory is best. Traditionally the directory you are located in after you log in is fine (unless its web-accessible).
 +
 
 +
You can also use wget or fetch to download the files directly to your server.
 
Example:
 
Example:
 
<pre>
 
<pre>
−
wget "<download url>"
+
wget https://clients.toomuchmedia.com/tubestudio.tar.gz
−
</pre>
+
or
−
<pre>
+
fetch https://clients.toomuchmedia.com/tubestudio.tar.gz
−
If you get a ''wget'' comand not found message use this instead:
 
−
fetch "<download url>"
 
 
</pre>
 
</pre>
  
 
=== Unzip ===
 
=== Unzip ===
−
Unzip the compressed archive.
+
Once the downloaded file is placed in the desired folder on your server, unzip the compressed archive.
 
Example:  
 
Example:  
 
<pre>
 
<pre>
−
tar -xzf tube_1_0_17_1.tar.bz2
+
tar -xzf tubestudio.tar.gz
 
</pre>
 
</pre>
  
−
== Install ==
+
This will create a new folder called tube which will contain the install script to install TubeStudio.
−
Run the ''install.sh'' script from within the new directory called 'tube' by default.
+
 
 +
=== Install ===
 +
Go to the newly created directory called tube which you unzipped.
 +
Run the ''install.sh'' script from within the new directory.
 
Example:
 
Example:
 
<pre>
 
<pre>
Line 31: Line 44:
 
</pre>
 
</pre>
  
−
== Web Server ==
+
=== Apache Settings ===
−
Most web servers require different settings to create new websites.  If you are unfamiliar on how to properly configure your web server you should ask your hosting company to assist you with this step.
+
There are a lot of possible Apache settings you could use but we only have the minimum required.  It is very important that your server is setup to follow symbolic links and allows .htaccess files to be used.  We accomplish this with the following parameters:
 +
 
 +
* Options FollowSymLinks
 +
* AllowOverride All
 +
 
 +
These should work for most servers. If you get an issue with SEO links not working correctly or unusable video download link then these are probably not configured correctly for your server.
  
−
=== Admin Site ===
+
==== Admin Site ====
−
The Tube admin runs from its own hostname.  If you already have a primary tube site domain you can just create a sub domain called ''admin''.  The document root of the admin domain should point to /path/to/tube/www/.  So if you installed Tube Studio in the directory ''/home/domains/tube/'' then you would make the document root '/home/domains/tube/www/''.
+
The Tube admin runs from its own hostname.  If you already have a primary tube site domain you can just create a sub domain called ''admin''.  The document root of the admin domain should point to /path/to/tube/www/.  So if you installed TubeStudio in the directory ''/home/domains/tube/'' then you would make the document root ''/home/domains/tube/www/''.
  
−
=== Tube Sites ===
+
If we assume that your desired admin hostname is ''myadmin.mytubesite.com'' and the path to the root TubeStudio directory is ''/home/domains/tube/'' then the following would be the typical configuration for Apache:
−
Tube studio can support multiple sites by default. Each one will use the same set of scripts located in ''/path/to/tube/site_scripts/''.  The easiest way to set up a new domain site is to make the ''site_scripts'' directory the document root for all tube sites.  If you host does not support multiple domains using the same document root then you can give each domain its own document root and then create a symlink for all the needed files from the the domains document root to the site_scripts directory.  You can Either symlink the entire directory or all the files within the directory. 
 
  
 +
<pre>
 +
  <VirtualHost *:80>
 +
    ServerName myadmin.mytubesite.com
 +
    DocumentRoot /home/domains/tube/www
 +
    <Directory /home/domains/tube/www >
 +
      Options FollowSymLinks
 +
      AllowOverride All
 +
    </Directory>
 +
  </VirtualHost>
 +
</pre>
 +
 +
==== Tube Sites ====
 +
TubeStudio supports an unlimited number of sites. The number of sites that are supported on your install depends on how many sites you have registered with TMM. Each one will use the same set of scripts located in ''/path/to/tube/site_scripts/''.  The easiest way to set up a new domain site is to make the ''site_scripts'' directory the document root for all tube sites.
 +
 +
If we assume that the hostname for your first tube site is ''mytubesite.com'' and the path to the root TubeStudio directory is ''/home/domains/tube/'' then the following would be the typical configuration for Apache:
 +
 +
<pre>
 +
  <VirtualHost *:80>
 +
    ServerName mytubesite.com
 +
    DocumentRoot /home/domains/tube/site_scripts
 +
    <Directory /home/domains/tube/site_scripts >
 +
      Options FollowSymLinks
 +
      AllowOverride All
 +
    </Directory>
 +
  </VirtualHost>
 +
</pre>
  
 
== Web Instructions ==
 
== Web Instructions ==
  
−
After pointing your web browser to the URL you already set up for TubeStudio you will see the TMM graphical installer.  Each pages will displayed detailed information about how to complete the current steps.   
+
After pointing your web browser to the URL you already set up for TubeStudio Admin you will see the TMM graphical installer.  Each page will display detailed information about how to complete the current steps.  Most of the information is automatically filled in for you but you should verify that it is correct before continuing.
  
 
=== Prerequisites ===
 
=== Prerequisites ===
−
The Prerequisites page checks your servers current settings and verifies they it meets the minimum requirments to install and run TubeStudio.  Each test will give you one of the following messages:
+
 
 +
[[Image:Screen_cap-prereq.png|frame|center||||Figure 1.1 - TubeStudio Web Installation - Prerequisites]]
 +
 
 +
 
 +
The Prerequisites page checks your servers current settings and verifies that it meets the minimum requirments to install and run TubeStudio.  Each test will give you one of the following messages:
 
<table>
 
<table>
 
<tr>
 
<tr>
Line 54: Line 101:
 
<tr>
 
<tr>
 
<td align="center" width="70"><font color="orange">passed</font></td>
 
<td align="center" width="70"><font color="orange">passed</font></td>
−
<td>You meet the minimum requirement but it is recommended you increase the value</td>
+
<td>You meet the minimum requirement but it is recommended you increase the value (i.e upgrade your php version or increase the memory limit to a higher value)</td>
 +
</tr>
 +
<tr>
 +
<td align="center" width="70"><font color="blue">unknown</font></td>
 +
<td>The program may be installed but can't be guaranteed. Most likely the program is not in the Web Servers path (Most of the time this is ok, as long as it is in the path of the user that installed the physical files).</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
 
<td align="center" width="70"><font color="red">failed</font></td>
 
<td align="center" width="70"><font color="red">failed</font></td>
−
<td>Mminimum requirement not met.  Item has to be resolved before installation can continue</td>
+
<td>Minimum requirement not met.  Item has to be resolved before installation can continue</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
−
As long as all the tests say "passed"  you can continue with the installation. If the test says <font color="orange">passed</font>  with the orange text color then you can continue but it is recommended that you or your server administrator increase the setting for the best performance.  For more information on TubeStudio system requirements you should refer to [[TubeStudio Requirements|this page]].
+
Sometimes one or more failed prerequisites will cause others tests to fail. For example, if php is not in the path of your web-server then most of the php related checks will fail even if they are in fact set correctly.
  
 
=== Paths ===
 
=== Paths ===
 +
 +
[[Image:Screen_cap-path.png|frame|center||||Figure 1.2 - TubeStudio Web Installation - Paths]]
 +
 
The paths page is where you will set up the default directory and system binary paths.  The installer will make an attempt to figure out your current location and and the paths to the current binaries.   
 
The paths page is where you will set up the default directory and system binary paths.  The installer will make an attempt to figure out your current location and and the paths to the current binaries.   
  
 
==== Disk Paths ====
 
==== Disk Paths ====
−
TubeStudio will uses these paths for all file system operations.  It is recommended that you use the default paths and only more advance users with a specific goal in mind should adjust them.  You should not alter these paths once the installer is complete and these paths are saved to the configuration file.  If you have a specific reason for needing to adjust a path after the installation is done you should put in a support ticket with TMM and we can assist you with any questions or problems that may come up with altering these settings.
+
TubeStudio will uses these paths for all file system operations.  It is recommended that you use the default paths. Only more advanced users with a specific goal in mind should adjust them.  You should not alter these paths once the installer is complete and these paths are saved to the configuration file.  If you have a specific reason for needing to adjust a path after the installation is done you should put in a support ticket with TMM and we can assist you with any questions or problems that may come up with altering these settings.
  
−
All the paths are built of of the ''Root Dir'' path by default and all the default directories have also already been created.  All paths except 1 should be absolute.  The ''Thumbnail Web Dir'' path is just the web accessible part of the ''Thumbnail Dir'' path.
+
==== Binary Paths ====
 +
The binary paths are the the paths to the external programs that TubeStudio needs to use to perform tasks such as video conversion, screen capture generation, and fetching information about about a video file.  By default the correct paths should be filled in.  If instead you see just a program name for any of the paths then chances are the application is not in the path for the user your web server runs as or the program is not installed.  If this is the case then you should check with your host and make sure that they are installed and/or find out what the paths are for programs not installed in the normal system path.
 +
 
 +
=== Database ===
  
−
For example, if your is:
+
[[Image:Screen_cap-database.png|frame|center||||Figure 1.3 - TubeStudio Web Installation - Database]]
  
−
  /path/to/tube/www/thumbs/
+
Use the provided form to enter in your database information. 
 +
* DB Host
 +
** The hostname or IP of your database server.  If the database is on your current server you should use localhost or 127.0.0.1 instead. 
 +
* DB Username
 +
** The username for the database server provided above.  This user must already have access to an existing table that will be used for TubeStudio. This user should have all the normal permissions of a database user including permissions to create tables.  It is highly recommended that you do not use the root database user.
 +
* DB Password
 +
** Password for above username
 +
* DB Name
 +
**The name of the database (must already be created)
 +
* Partition Tables
 +
** Check this if you server supports table partitioning.  Only servers with MySQL 5.1 and higher will have support for this.  Even if you have the correct version there is a chance that this could be disabled.  If your server supports this it is highly recommended that you turn it on as it will greatly increase performance for larger tables.
  
−
Then the ''Thumbnail Web Dir'' is just:
 
−
thumbs/
 
  
−
Since that is the part a web browser would use to access it.
+
It is very important that you do not have programs like CPanel running.  If you have no choice but to have it on your server then you should ensure that any functionality that alters database setups is disabled.
  
−
==== Binary Paths ====  
+
=== Program ===
−
The binary paths are the the paths to the external programs that TubeStudio needs to use to perform tasks such as video conversion, screen capture generation, and fetching information about about a video file.  Be default the correct paths should be filled in.  If instead you see just a program name for any of the paths then chances are the application is not in the path for the user your web serve runs as or the program is not installed. If this is the case then you should check with your host and make sure that they are installed and/or find out what the paths are for programs not installed in the normal system path.
+
[[Image:Screen_cap-program.png|frame|center||||Figure 1.4 - TubeStudio Web Installation - Program]]
  
−
=== Database ===
+
This page lets you set the final information needed for the TubeStudio installer.   
−
Use the provided form to enter in your database information.  It is very important that you do not have programs like CPanel running.  While they can be very useful for administrating servers for the non tech savy, they have an unfortunate habit of alerting database setups. If you hosting provider can not rid of server administration software then you should make sure that they hav any database altering subsystems disabled.  To complete this step you must provide the following:
 
  
−
==== DB Host ====
 
−
The hostname or IP of your database server.  If the database is on your current server you should use localhost or 127.0.0.1 instead. 
 
−
====DB Username ====
 
−
The username for the database server provided above.  This user must already have access to an existing table that will be used for TubeStudio.  This user should all all the normal permissions of a database user including permissions to create tables.  It is highly recommended that you do not use the root database user.
 
−
==== DB Password ====
 
−
Password for above username
 
−
==== DB Name ====
 
−
The name of the database (must already be created)
 
−
==== Partition Tables ====
 
−
Check this if you server supports table partitioning.  Only servers with MySQL 5.1 and higher will have support for this.  Even if you have the correct version there is a chance that this could be disabled.  If your server supports this it is highly recommended that you turn it on as it will greatly increase performance for larger tables.
 
  
−
After hitting the "Save Database"  button the TMM Installer will attempt to connect to the server. If for some reason it cant it will provide you with an error.  Even if your username and password are correct, it is possible for it to fail if you did not provide the correct hostname for that username and password.
+
=== Register ===
 +
[[Image:Screen_cap-reg.png|frame|center||||Figure 1.5 - TubeStudio Web Installation - Register]]
  
 +
Follow the link to register this product.  Once the registration is completed you will be given a code to enter in here.
  
−
=== DB Struct ===
 
−
This page will output the progress of the table creation.  If for some reason a table could not be created you will see a red X  next to the failed table.  If a table fails this is generally do to an incorrect version of MySQL or a particular setting not being enabled.  For more information on TubeStudio system requirements you should refer to [[TubeStudio Requirements|this page]].
 
  
 +
=== Finish ===
 +
After submitting a valid registration key you should be taken to the login screen.  Login using the username and password you entered during the installation.
  
−
=== Program ===
 
−
This page lets you set the final information needed for the TubeStudio installer.  The most important part of this step is setting your ''TMM Product Code''.  A proper code is required for activation and future upgrading for TubeStudio.  By entering in your correct ''TMM Product Code''  You will activate your copy of TubeStudio and be supplied with a TMM Client login which will allow you full access to the TMM Support system.  This code is also needed by the upgrade system in order to correctly identify your installation and provide you will all the needed files when upgrading.  Changing or altering this code after installation will break your system. 
 
  
 +
== Common Problems & Solutions ==
 +
TubeStudio's auto-installer and these installation instructions attempt to provide you with everything you need to install TubeStudio simply and without issue.  However, do to the diversity of BSD and Linux server setups, you may encounter problems.
  
−
=== Finish ===
+
=== Lighttpd ===
−
This page will present you with all the information that will be written out to the configuration files.  You should verify that all the settings are correct and then click ''Save'' to finish the installation.
+
TubeStudio has been tested to work with lighttpd, however the default installation comes with .htaccess files that are only used by Apache.  In order to get the SEO style links working in Lighttpd you need to add the following mod rewrite rules
  
−
=== Install Completed ===
+
<pre>
−
Once your installation is completed you will be presented with a default administration username and password.  You should use these login credentials to gain access to your now setup TubeStudio admin and creating any additional accounts from the Users admin.
 
  
−
If you are a new TMM Client you should also receive an email with additional login information for the TMM Client Support system.
 
  
−
== Common Problems ==
+
</pre>
  
−
=== Missing config.php file ===
+
=== You don't have permission to access / on this server ===
−
This indicates that you did not run the ''install.sh'' script from the root directory of TubeStudio.  You will often see an error like this:
+
If you get error message like this:
 
<pre>
 
<pre>
−
include_once(/home/path/to/tube/www/../includes/config.php) [function.include-once]: failed to open stream: No such file or directory
+
Forbidden
 +
 
 +
You don't have permission to access / on this server.
 
</pre>
 
</pre>
 +
Then this is a server miss-configuration error.  Most likely the document root for the website is not setup correctly.

Latest revision as of 18:03, 12 March 2010

TubeStudio
About TubeStudio
TubeStudio Requirements
TubeStudio Installation Instructions
Upgrading TubeStudio



Below are the instructions for installing Too Much Media's TubeStudio. There are two parts to the installation procedure: the server installation and the web installation. If you are unfamiliar with using ssh you should have your system admin or your hosting provider complete the server installation for you.


Server Instructions

You will need to first ssh into the server you wish to use for your TubeStudio installation.

Download

You can download the latest version of TubeStudio from the following URL:
https://clients.toomuchmedia.com/tubestudio.tar.gz
Please upload the tar file to the appropriate folder on your server.

NOTE: Its is very important that you do not install TubeStudio into a web-accessible folder. Uploading and installing to your home directory is best. Traditionally the directory you are located in after you log in is fine (unless its web-accessible).

You can also use wget or fetch to download the files directly to your server. Example: 

wget https://clients.toomuchmedia.com/tubestudio.tar.gz
or 
fetch https://clients.toomuchmedia.com/tubestudio.tar.gz

Unzip

Once the downloaded file is placed in the desired folder on your server, unzip the compressed archive. Example: 

tar -xzf tubestudio.tar.gz

This will create a new folder called tube which will contain the install script to install TubeStudio.

Install

Go to the newly created directory called tube which you unzipped. Run the install.sh script from within the new directory. Example: 

cd tube
sh install.sh

Apache Settings

There are a lot of possible Apache settings you could use but we only have the minimum required. It is very important that your server is setup to follow symbolic links and allows .htaccess files to be used. We accomplish this with the following parameters:

  • Options FollowSymLinks
  • AllowOverride All

These should work for most servers. If you get an issue with SEO links not working correctly or unusable video download link then these are probably not configured correctly for your server.

Admin Site

The Tube admin runs from its own hostname. If you already have a primary tube site domain you can just create a sub domain called admin. The document root of the admin domain should point to /path/to/tube/www/. So if you installed TubeStudio in the directory /home/domains/tube/ then you would make the document root /home/domains/tube/www/.

If we assume that your desired admin hostname is myadmin.mytubesite.com and the path to the root TubeStudio directory is /home/domains/tube/ then the following would be the typical configuration for Apache: 

  <VirtualHost *:80>
    ServerName myadmin.mytubesite.com
    DocumentRoot /home/domains/tube/www
    <Directory /home/domains/tube/www >
      Options FollowSymLinks
      AllowOverride All
    </Directory>
  </VirtualHost>

Tube Sites

TubeStudio supports an unlimited number of sites. The number of sites that are supported on your install depends on how many sites you have registered with TMM. Each one will use the same set of scripts located in /path/to/tube/site_scripts/. The easiest way to set up a new domain site is to make the site_scripts directory the document root for all tube sites.

If we assume that the hostname for your first tube site is mytubesite.com and the path to the root TubeStudio directory is /home/domains/tube/ then the following would be the typical configuration for Apache: 

  <VirtualHost *:80>
    ServerName mytubesite.com
    DocumentRoot /home/domains/tube/site_scripts
    <Directory /home/domains/tube/site_scripts >
      Options FollowSymLinks
      AllowOverride All
    </Directory>
  </VirtualHost>

Web Instructions

After pointing your web browser to the URL you already set up for TubeStudio Admin you will see the TMM graphical installer. Each page will display detailed information about how to complete the current steps. Most of the information is automatically filled in for you but you should verify that it is correct before continuing.

Prerequisites

Figure 1.1 - TubeStudio Web Installation - Prerequisites


The Prerequisites page checks your servers current settings and verifies that it meets the minimum requirments to install and run TubeStudio. Each test will give you one of the following messages:

passed You meet or surpass the minimum requirement
passed You meet the minimum requirement but it is recommended you increase the value (i.e upgrade your php version or increase the memory limit to a higher value)
unknown The program may be installed but can't be guaranteed. Most likely the program is not in the Web Servers path (Most of the time this is ok, as long as it is in the path of the user that installed the physical files).
failed Minimum requirement not met. Item has to be resolved before installation can continue

Sometimes one or more failed prerequisites will cause others tests to fail. For example, if php is not in the path of your web-server then most of the php related checks will fail even if they are in fact set correctly.

Paths

Figure 1.2 - TubeStudio Web Installation - Paths

The paths page is where you will set up the default directory and system binary paths. The installer will make an attempt to figure out your current location and and the paths to the current binaries.

Disk Paths

TubeStudio will uses these paths for all file system operations. It is recommended that you use the default paths. Only more advanced users with a specific goal in mind should adjust them. You should not alter these paths once the installer is complete and these paths are saved to the configuration file. If you have a specific reason for needing to adjust a path after the installation is done you should put in a support ticket with TMM and we can assist you with any questions or problems that may come up with altering these settings.

Binary Paths

The binary paths are the the paths to the external programs that TubeStudio needs to use to perform tasks such as video conversion, screen capture generation, and fetching information about about a video file. By default the correct paths should be filled in. If instead you see just a program name for any of the paths then chances are the application is not in the path for the user your web server runs as or the program is not installed. If this is the case then you should check with your host and make sure that they are installed and/or find out what the paths are for programs not installed in the normal system path.

Database

Figure 1.3 - TubeStudio Web Installation - Database

Use the provided form to enter in your database information.

  • DB Host
    • The hostname or IP of your database server. If the database is on your current server you should use localhost or 127.0.0.1 instead.
  • DB Username
    • The username for the database server provided above. This user must already have access to an existing table that will be used for TubeStudio. This user should have all the normal permissions of a database user including permissions to create tables. It is highly recommended that you do not use the root database user.
  • DB Password
    • Password for above username
  • DB Name
    • The name of the database (must already be created)
  • Partition Tables
    • Check this if you server supports table partitioning. Only servers with MySQL 5.1 and higher will have support for this. Even if you have the correct version there is a chance that this could be disabled. If your server supports this it is highly recommended that you turn it on as it will greatly increase performance for larger tables.


It is very important that you do not have programs like CPanel running. If you have no choice but to have it on your server then you should ensure that any functionality that alters database setups is disabled.

Program

Figure 1.4 - TubeStudio Web Installation - Program

This page lets you set the final information needed for the TubeStudio installer.


Register

Figure 1.5 - TubeStudio Web Installation - Register

Follow the link to register this product. Once the registration is completed you will be given a code to enter in here.


Finish

After submitting a valid registration key you should be taken to the login screen. Login using the username and password you entered during the installation.


Common Problems & Solutions

TubeStudio's auto-installer and these installation instructions attempt to provide you with everything you need to install TubeStudio simply and without issue. However, do to the diversity of BSD and Linux server setups, you may encounter problems.

Lighttpd

TubeStudio has been tested to work with lighttpd, however the default installation comes with .htaccess files that are only used by Apache. In order to get the SEO style links working in Lighttpd you need to add the following mod rewrite rules

You don't have permission to access / on this server

If you get error message like this: 

Forbidden

You don't have permission to access / on this server.

Then this is a server miss-configuration error. Most likely the document root for the website is not setup correctly.

Retrieved from "https://tmmwiki.com/index.php?title=TubeStudio_Installation_Instructions&oldid=8844"