Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate THEOlive docs #202

Merged
merged 22 commits into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion sidebarsTheolive.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';

const sidebars: SidebarsConfig = {
theolive: ['index'],
theolive: [
'index',
{
type: 'category',
label: 'Getting started',
description: 'Getting started with THEOLive',
link: { type: 'doc', id: 'index' },
items: [{ type: 'autogenerated', dirName: 'getting-started' }],
},
],
};

export default sidebars;
Binary file added theolive/assets/img/22fb225-my-team.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theolive/assets/img/230b3c5-platform-panel2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theolive/assets/img/302e789-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theolive/assets/img/3030fa6-4.Whole_team.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theolive/assets/img/467abb8-overview.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theolive/assets/img/57e33f4-manage-webhook.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theolive/assets/img/7918a6d-viewer-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theolive/assets/img/a1acade-create-webhook.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theolive/assets/img/cbe288c-start.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theolive/assets/img/d2e680e-webhooks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theolive/assets/img/e35aec9-2.Team.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theolive/assets/img/e409065-where-insights3.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theolive/assets/img/e631989-latency-panel2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theolive/assets/img/fe6b54f-3._New_user.jpg
53 changes: 53 additions & 0 deletions theolive/getting-started/authorization.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
sidebar_position: 1
sidebar_label: Authorization
pagination_label: Authorization
pagination_next: getting-started/regions
title: Autorization
---

We make sure that only authorized users can make API calls!

---

Making secure calls to our REST API requires authentication and authorization. THEOlive makes use of token-secret pairs to authorize requests.

## 1. Getting a token-secret pair

To generate a token-secret pair, you should be registered for an account at on our [management console](https://console.theo.live/). Under the section "Tokens", click on the "Generate Token" button, and enter a name before clicking "Generate".

![](../assets/img/c0aca77-1.-THEOlive-console-generate-token.PNG)

This will give a pop-up which shows your token "key" and the corresponding secret.

![](../assets/img/bb9b4a6-2.-THEOlive-console-generated-token-and-secret.PNG)

Once you "Close" the pop-up window, the new token will be visible in your list of tokens.

![](../assets/img/5361242-3.-THEOlive-console-token-list.PNG)

> 🚧 Please store the secret
>
> Make sure to store the secret somewhere, as this will be shown to you only once, and THEOlive only stores a hash of the secret, so it cannot be recovered afterward.

In case you forgot your secret, or the secret got exposed, you can easily regenerate a pair at all times.

## 2. Using the token-secret pair with Basic Authentication

THEOlive makes use of Basic Authentication when making requests to the API. In the 'Authorization' header, make sure to pass your token-secret pair (encrypted with base64), prepended with the word 'Basic'.

As an example, assume that your token has the value "my-token", and your secret has the value "my-secret". Then you can put them together like this: `my-token:my-secret`.

You subsequently encode this value using base64. Applying 'base64(my-token:my-secret)' will result in the following encoded string: 'bXktdG9rZW46bXktc2VjcmV0'

This string can then be used in combination with 'Basic' to pass in the 'Authorization' header:

```text
Authorization: Basic bXktdG9rZW46bXktc2VjcmV0
```

You can now make requests to our THEOlive API in the name of your organization!

> 📘 Basic Authentication with Postman
>
> The guide [Using Postman with THEOlive](doc:how-to-use-postmans-api-client-with-theolive) illustrates how to use the THEOlive token-secret pair in Postman.
55 changes: 55 additions & 0 deletions theolive/getting-started/billing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
sidebar_position: 5
title: How Billing works for THEOLive
sidebar_label: How Billing works for THEOLive
pagination_label: billing
pagination_next: getting-started/viewer-insights
---

Discover our payment methods and billing cycles

---

This guide describes which payment methods are available, how to activate these, and when you will be billed.

## 1. Know this first

- You can test for free in demo mode. This limits your streaming time to 5 minutes and puts a watermark on your video. All other functionalities are equivalent to those available in production.
- When adding your payment method, you get $20 in production for free.
- We work with billing cycles and payment thresholds, in combination.

## 2. Add you billing details

Your billing details can be added via _My Account_ > _Billing Details_.

![](../assets/img/dcb32a2-billing-details.PNG)

You subsequently have to click _Add Billing Details_, and complete the form.

![](../assets/img/8e7abe9-2.Billing-details-fields-overview.PNG)

This will allow you in turn to add a payment method. We provide for 2 methods: credit card payment and direct debit. The picture below illustrates the credit card view.

![](../assets/img/76aaff1-3.Add-credit-or-debit-card.PNG)

You are all set, and can start using your production channels!

## 2. Invoicing

### 2.1 Model

THEOlive is pay-as-you-go. There are no minimum fees; you pay per minute of transcoding and per minute of streaming per viewer.

> 📘 Estimate your streaming costs
>
> To get an estimate of the streaming cost for an event, you can check the [pricing page](https://www.theoplayer.com/pricing/theolive) on the website. Note that the prices listed do not include VAT yet; this will be added on your invoice. Discounts are possible for high volumes and commitments: [contact us](https://www.theoplayer.com/contact-us) to know more.

You will be invoiced based on billing cycles or payment thresholds, whichever takes place first.

### 2.2 Payment thresholds

There are four payment thresholds, or tiers, respectively $100 (Tier 1), $250 (Tier 2), $500 (Tier 3) and $1000 (Tier 4). As a new user, you start in Tier 1. When you've accrued $100 in costs, an invoice is generated and you are promoted to Tier 2. The same applies to the following tiers: if you accumulate an additional $250, a new invoice is generated and you are promoted to Tier 3. Tier 4 is the highest: reaching the threshold will not move your account to a new tier and the same threshold remains applicable.

### 2.3 Billing cycles

If at the end of the calendar month your threshold has not been reached, you will be billed for the open amount. For example, a THEOlive user in Tier 2 has an open amount of $200 at the end of the month. As the Tier 2 threshold of $250 has not been reached, an invoice will be generated for $200.
55 changes: 55 additions & 0 deletions theolive/getting-started/manage-team.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
sidebar_position: 7
title: How to manage your team
sidebar_label: How to manage your team
pagination_label: manage-your-team
pagination_next: getting-started/real-time-update-with-webhooks
---

Form a team with your colleagues and work together

---

When you sign up to the [THEOlive console](https://console.theo.live/login), you might want to work together with your colleagues on the same account and the same channels. This guide describes how to set this up.

## 1. Manage your team

### 1.1 - Access the team

Click on the “My account” button, on the top right-hand corner of the screen and select _My Team_.

![](../assets/img/22fb225-my-team.PNG 'My team in top right-hand corener menu')

Here, you will see all the members that are part of your team, and the status for each of them.

![](../assets/img/e35aec9-2.Team.PNG '2.Team.PNG')

> 🚧 Only admins can access the _My Team_ section
>
> The _My Team_ section is only available for admins. If you don’t see the _My team_ button, this means you do not have admin rights at the moment. More information on roles can be found in the below section.

### 1.2 - Add member

To invite your colleagues, click on the _Add member_ button. Insert the desired email address, choose the role, and then click _Add_.

![](../assets/img/fe6b54f-3._New_user.jpg '3. New user.jpg')

An invitation to join your THEOlive console account has now been sent to the email address, containing a link and instructions on how to access the console.

It is also possible to re-send the invitation from the "My team" page, should it be needed. To do this, click on the envelope icon on the side of the account name (see screenshot below). Now, your invited colleagues can access the same console account. Back to the _My Team_ page, you will see the newly invited users:

![](../assets/img/3030fa6-4.Whole_team.PNG '4.Whole team.PNG')

## 2. Determining the role of your new team members

Two possible roles are defined in the console: **admin** and **user**. Both admin and user team members mostly have access to the same information and can perform the same actions. Key differences between these two roles are as follows:

- Admin members can additionally access the pages related to managing the team and the billing details.
- Admin members can grant or revoke admin access for all other team members, or remove them from the team.
- Admin members can revoke tokens

## 3. Complete your profile

When invited to a THEOlive team, every team member has access to the _My profile_ page, where they can edit their first name, last name, phone number and change their password. This access is limited to the team member itself. Other users or admin team members cannot see (nor change) the personal info.

![](../assets/img/3aad379-5.Personal_info.PNG '5.Personal info.PNG')
42 changes: 42 additions & 0 deletions theolive/getting-started/platforms.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
sidebar_position: 3
sidebar_label: Platforms
title: Platforms
pagination_label: platforms
pagination_next: getting-started/stream-configuration
---

THEOlive supports all major web platforms

---

THEOlive supports playback across all major web platforms. An overview of the supported platforms can be found below. If you have any questions in regards to supported platforms and capabilities, don’t hesitate to reach out to our team.

## Desktop browser platforms

| Browser | Version |
| :-------------------------- | :-------------------------------- |
| Edge (Chromium) | Evergreen (last 3 major versions) |
| Chrome (and Chromium based) | Evergreen (last 3 major versions) |
| Firefox | Evergreen (last 3 major versions) |
| Safari | 8+ |

## Mobile browser platforms

| Browser | Version |
| :--------------------- | :-------------------------------- |
| Chrome for Android | Evergreen (last 3 major versions) |
| Firefox for Android | Evergreen (last 3 major versions) |
| Safari for iOS (\*) | Evergreen (last 3 major versions) |
| Chrome for iOS (\*\*) | Evergreen (last 3 major versions) |
| Firefox for iOS (\*\*) | Evergreen (last 3 major versions) |

(\*) The latency for iOS Safari is currently about 1,5s. We're targeting sub-second latency in a next release.
(\*\*) Supported as of iOS14.

## Native applications

| OS | Version |
| :------ | :------ |
| Android | 24+ |
| iOS | 14+ |
Loading