Tridentstream Guides

This page contains information about how to install and use Tridentstream Media Server.

How to Install Tridentstream

Install on Linux with Docker

This guide explains how to get Tridentstream Media Server up and running on a server where you have access to Docker.

Prerequisite

  • A server with Docker access, this guide assumes Ubuntu or Debian
  • A domain pointed towards your server is strongly encouraged as this guide assumes it

If you do not already have docker and docker-compose installed, do this:

apt-get install \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg-agent \
    software-properties-common -y && \
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - && \
add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable" && \
apt-get install docker-ce docker-ce-cli containerd.io -y && \
curl -L "https://github.com/docker/compose/releases/download/1.25.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose && \
chmod +x /usr/local/bin/docker-compose && \
ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

Installation

To get started, download and unzip the config file bundle

curl -L -o bundle.zip https://github.com/tridentstream/setups/raw/master/linux-docker/bundle.zip && \
unzip bundle.zip -d tridentstream && \
rm bundle.zip && \
cd tridentstream

OPTIONAL: If you do not have your own webserver to be infront of the Tridentstream instance, then traefik is recommended. It’s easy to get going and is already included.

docker network create web && \
cd traefik && \
touch acme.json && \
chmod 600 acme.json && \
docker-compose up -d && \
cd ..

Time to get Tridentstream bootstrapped.

# If you do not need to use built-in deluge, skip -d
./bootstrap.sh -d -o example.com

Please note, if you do not use traefik as prescribed, then you will need to modify docker-compose.yml to fit your needs.

When Tridentstream is bootstrapped, it can be started by executing start.sh.

./start.sh

If you decided to include Deluge, it is now available at: https://example.com/_deluge_web/.

It is strongly recommended that you change the default Deluge WebUi password.

First time you login, a new user is created with the info you login with.

Install on Linux without root

Install Tridentstream Media Server as a normal user. A shared server will also work, e.g. a seedbox.

Prerequisite

Build tools must be installed, if you know someone with root, they can follow this guide to install the required build tools: https://github.com/pyenv/pyenv/wiki/common-build-problems

Installation

curl -L https://github.com/tridentstream/setups/raw/master/linux-user/bootstrap.sh | bash

Configuration

Configurable options can be found in the .environ file and at the top of start.sh.

Settings are reloaded by running ./restart.sh.

If you want to enable SSL or change port, modify ./start.sh.

First time you login, a new user is created with the info you login with.

Install on Windows

Install Tridentstream Media Server as a normal user on a Windows computer.

Prerequisite

Windows 10 64 bit or equivalent.

Installation

Download and run the Windows Installer. The installer will download all the requirements and fetch the latest version of Tridentstream. The installation will pop up some windows and might take some time to complete.

Click here to download

After the installation is complete a new Shortcut is created. Run the shortcut and Tridentstream should be accessible at http://127.0.0.1:45477/

Configuration

Configurable options can be found in the .environ file. The file can be found in %localappdata%\Programs\Tridentstream\ per default.

Special Note

To shut down the server, close the window running Tridentstream. You might have to press a few times before it succeeds.

First time you login, a new user is created with the info you login with.

Basic Setup Guides

Setup and Use Deluge Streaming

This guide will show how to setup Deluge Streaming and configure the plugin correctly. This allows for streaming of torrents via other plugins.

Step 1 - Install Deluge

Installing Deluge is the first thing you need to do, the actual steps to do this is outside the scope of this guide.

Deluge can be found at https://deluge-torrent.org/

Step 2 - Install Deluge Streaming

The latest release of this plugin can be found on Github

You can find a plugin installation guide on the official Deluge Wiki

Deluge Streaming should now be installed and enabled.

Please note, some versions of Deluge 2 has a broken plugin system.

Step 3 - Configuring Deluge Streaming

To use Deluge Streaming with Tridentstream the “Allow remote control” needs to be enabled.

_images/deluge-streaming-settings.png

Deluge Streaming config.

Fig. 1 is the streaming configuration window with all the options changed to be correct.

  • The red line is the hostname or IP address where Deluge can be reached.
  • The blue line indicates the checkbox that needs to be checked.
  • The orange line indicates the password, it is randomly generated and does not need to be changed.
  • The green line is the remote control URL, this is needed for Tridentstream

After the correct settings are changed, press apply and test the “Remote control url” (green line) by opening it in a webbrowser.

_images/streaming-working-url.png

Webbrowser trying to open the remote control url directly.

The result from the url should say “Unauthorized” or give an error page similar to the one in Fig. 2.

Step 4 - Adding the Plugin to Tridentstream

With Deluge Streaming configured, we need to add it to Tridentstream.

First, head over to the “Admin” page under “Plugins” tab.

_images/add-new-plugin.png

Where to add new plugin on the admin interface

On Fig. 3 it is shown where to add the Deluge Streaming plugin on Tridentstream. Click the highlighted “Add new plugin” button.

_images/add-new-plugin-popup.png

The add new plugin popup

A popup appears as seen in Fig. 4, click “Add” next to the Deluge plugin.

_images/deluge-plugin-form.png

Filled out Deluge Plugin form

When a new plugin is added, it is in an unsaved stage. Fill it out with your correct information and press “Save”. An example of this can be seen in Fig. 5 which aligns with what we did in step 3.

Install an External Plugin and use it

This guide will explain how to install an externally acquired plugin that streams torrents and how to actually use it.

It is assumed you already acquired a plugin you want to install.

Step 1 - Install the Plugin

Head over to the admin page and go to the “External plugin” section.

_images/page-external-plugins.png

External plugins page

Fig. 6 shows the external plugin page with no plugins uploaded yet.

  • Click the “Upload Plugins” button and select the plugin files you want to upload.
_images/plugin-uploaded.png

Plugin uploaded successfully.

Fig. 7 shows the plugin being successfully uploaded. The uploaded plugin is available in the “Available plugin” list.

  • Click the “Enable” button under the plugin, this will make it show up in the “Enabled plugins” list as seen in Fig. 8.
  • The text says “Loaded: No” which means that the plugin is not loaded into Tridentstream yet. This can be solved by clicking “Restart Tridentstream” - the server will restart and load the plugin.
_images/plugin-enabled.png

Plugin enabled successfully.

Step 2 - Add the Plugin

_images/plugin-now-addable.png

Add new searcher popup with LegitTorrents available.

With the plugin loaded we can now use it.

  • Go to the “Plugins” tab and click “Add new searcher”.
  • A popup will appear as seen in Fig. 9 where you can add your new plugin. Click “Add” next to the plugin you want to add, in this case LegitTorrents.
_images/configure-legittorrents-plugin.png

Configuration menu for LegitTorrents Plugin.

When adding a new plugin a form appears with all the necessary and optional settings available. A filled out form for LegitTorrent can be seen in Fig. 10. This also relies on the Deluge plugin added in another guide. When done, click “Save”.

Step 4 - Use the New Plugin

_images/store-available.png

The added store is available.

After the changes are committed, the section is available under “Store” on the frontpage as seen in Fig. 13.

Add a New User

With a server setup and a plugin added you might want to share your server with other people.

Head over to the admin interface and go under the “Users” tab.

_images/add-new-user.png

Add new user form.

Click the “Add new user” button and enter a name of the new user as seen in Fig. 14. Click the “Add user” button when the name is filled out.

_images/new-user-added.png

Configure user form.

The newly added user does not have a password yet, you can set that in the form seen in Fig. 15. Click “Set password” to set the new password.

Per default a user has access to some services and no access to other services. You can change what they have access to here by toggling the toggles.