Video Streaming Server With Multi-Protocol,Robust And Rich API
Location：Index Page  >  Document  >  Upgrade

For 2B industry application software, in general, "upgrade" refers to installing an upgrade package or executing an upgrade script on basic of the existing version. It must be pointed out that this is for situations where the software installation process is relatively complex

The installation of Ti Top Streamer is very simple, so we prefer to "upgrade" by uninstalling first and then installing a new version completely.

Here, we will provide an explanation of this upgrade process：

1. Back up all configuration files of existing versions


All the configuration file of Ti Top Streamer were saved in the "conf" directory of the Installation directory (Default in /usr/local/TiTopStreamer/conf)

The backup location can be any location, such as/usr/local/mybak. If this directory is not available, please create it. The directory creation and backup commands are as follows： 

mkdir /usr/local/mybak
cp /usr/local/TiTopStreamer/conf /usr/local/mybak -r

In addition, if there are other resource files in your installation directory, such as recorded videos, please transfer them to another directory first (the reason for using the word "transfer" instead of "backup" is because video files are relatively large, and extra backups will occupy more disk space)

2. Uninstall existing version


The uninstallation process is very simple, and we have prepared explanatory documents. Please take a look here: uninstall Ti Top Streamer software

3. Install the latest version


Similarly, the installation process is also very simple, and we have prepared explanatory documents. Please take a look here: install Ti Top Streamer software

4. Restore previously backed up configuration files


This step is to copy the previously backed up configuration files to the conf directory in the current installation directory and replace the existing files in that directory. But it should be noted that "it is not simply copying back or covering the entire files". The reason is that compared to the old version, the new version may also have changes in the structure of the configuration file, which usually occur when there are significant differences in version due to the release of new features. So, for safety reasons, we offer the following suggestions:


  • 1) It's best for you to be very clear about what kind of configuration information is saved in each configuration file, so that you can know whether you need to copy it back or not. Is there any risk in doing so?

    For example: server.license, It is just a text file that stores your license key. So, you must copy it back. Of course, if you have already backed up your authorization key, you can reconfigure it on the web control pannel without any problem.

  • 2) If you have a clear understanding of your previous configuration and the information is very simple, then you don't have to copy it back from the backup file. You just need to reconfigure it on the new version of the software.

    For example, in the original software version, you only changed the TCP port of the HLS streaming service from 8080 to 80, and everything else was configured by default. You just need to do the same operation on the new software version, change the port to 80, and there is no need to copy the previous configuration file.

    For example, in the original software version, you added an Application called "live2", whose streams were all pulled from third-party RTMP sources, and you only added one stream. You are also very clear about the RTMP URL of this stream. So you can directly add the "live2" Application on the new software version and then add this RTMP stream.

    The reason we are so cautious in not directly copying and replacing files is because we are concerned that the new version has already adjusted the data structure of the configuration file. If you copy back the previous configuration file and replace it with the latest one, the risk naturally comes.(Of course, it must be said that as software functions become increasingly stable, this situation is very rare)

  • 3) Some configuration files, you don't need to copy them back. Previously, in the first step, when we were backing up, for the sake of simplicity, we backed up the entire conf directory. But in fact, not every file here needs to be backed up. As we all know, configuration files are text files with very small volumes, so we don't need to list which file needs to be backed up or which file doesn't need to be backed up. We just need to back up the conf directory.

    So, at this step, we must point out which files you don't need to copy back. And if you copy it back, there will definitely be risks.

    text_en.txt and text_zh.txt, In these two files, all the required text on the web UI is saved. In order to support multiple languages, we have made the a set of text configurations for each language. text_en.txt is for English, text_zh.txt is for Chinese. Obviously, you don't need to copy these two files back, just use the current new version.

  • 4) For the some configuration file, It's sure that you need to copy them back.
    Suppose that you have already added many sources or forward streams,and It would be very troublesome for add them again one by one. Then,of course,The correct approach is to copy these files back again. These configuration files are all located in the directory of a certain application. They are the most commonly used configuration information configured by users themselves in Ti Top Streamer.

    For example, In the Application of "live2" (corresponding to the conf/live2 directory), You have previously configured 20 RTMP stream URLs (corresponding to all .stream files in the conf/live2/source directory), For these configuration, It would be very troublesome if you choose to add them again one by one on the web UI. If you feel It's okay for 20 streams, thent what if there are 100 streams? So, for these files, you can definitely copy them back. (The content of these files is organized in JSON format and is also very simple, with the structure generally not changing).

5. review and then startup service again


The last step you need to do is to compare the previously backed up configuration files with the configuration files under the new version one by one,You can check them by byte size, and if there is any inconsistency, compare and review (just a few files, it can be checked in 5 minutes).

When there are differences, you need to carefully examine whether it is because you have made some configurations on the original version yourself, which were not done in the new version, or because there have been changes in the new version.

Of course, for convenience, we have also provided an explanation of the roles of all configuration files, please refer to here: 关于配置文件的说明

In short, if you are more careful, upgrading will not be a problem.

At this step, the upgrade process is complete! Restart the Ti Top Streamer service.

......

If there are issues with the operation after upgrading, do you need to revert back to the previous version? This situation usually does not occur. If there are any issues, please contact us promptly. If your business is very important and any problems can have a significant impact, then what you need to do is upgrade on the testing server first, confirm that there are no problems, and then upgrade to the official online system.