Instance information

INSTANCE

Name

Short description

Description

Main instance categories

Main languages you/your moderators speak

MODERATION & NSFW

Manage users to build a moderation team.

This instance is dedicated to sensitive or NSFW content

Enabling it will allow other administrators to know that you are mainly federating sensitive content.

Moreover, the NSFW checkbox on video upload will be automatically checked by default.

Policy on videos containing sensitive content

With Do not list or Blur thumbnails, a confirmation will be requested to watch the video.

Terms

Code of conduct

Moderation information

Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc

YOU AND YOUR INSTANCE

Who is behind the instance?

A single person? A non-profit? A company?

Why did you create this instance?

To share your personal videos? To open registrations and allow people to upload what they want?

How long do you plan to maintain this instance?

It's important to know for users who want to register on your instance

How will you finance the PeerTube server?

With your own funds? With user donations? Advertising?

OTHER INFORMATION

What server/hardware does the instance run on?

i.e. 2vCore 2GB RAM, a direct the link to the server you rent, etc.

Basic configuration

APPEARANCE

Use plugins & themes for more involved changes, or add slight customizations.

Theme

Landing page

Default trending page

BROADCAST MESSAGE

Display a message on your instance

Broadcast message level

Message

NEW USERS

Manage users to set their quota individually.

⚠️ This functionality requires a lot of attention and extra moderation.

Signup limit

{form.value['signup']['limit'], plural, =1 {user} other {users}}

Signup won't be limited to a fixed number of users.

Default video quota per user

Default daily upload limit per user

VIDEOS

Unless a user is marked as trusted, their videos will stay private until a moderator reviews them.

Allow your users to look up remote videos/actors that may not be federated with your instance

Allow anonymous users to look up remote videos/actors that may not be federated with your instance

⚠️ This functionality depends heavily on the moderation of instances followed by the search index you select.

You should only use moderated search indexes in production, or host your own.

Search index URL

Otherwise the local search stays used by default

FEDERATION

Manage relations with other instances.

⚠️ This functionality requires a lot of attention and extra moderation.

You should only follow moderated indexes in production, or host your own.

Index URL

ADMINISTRATORS

Admin email

TWITTER

Provide the Twitter account representing your instance to improve link previews. If you don't have a Twitter account, just leave the default value.

Your Twitter username

Instance allowed by Twitter

If your instance is explicitly allowed by Twitter, a video player will be embedded in the Twitter feed on PeerTube video share.
If the instance is not, we use an image link card that will redirect to your PeerTube instance.

Check this checkbox, save the configuration and test with a video URL of your instance (https://example.com/videos/watch/blabla) on https://cards-dev.twitter.com/validator to see if you instance is allowed.

VOD Transcoding

Estimating a server's capacity to transcode and stream videos isn't easy and we can't tune PeerTube automatically. However, you may want to read our guidelines before tweaking the following values.

Read guidelines

TRANSCODING

Process uploaded videos so that they are in a streamable form that any device can play. Though costly in resources, this is a critical part of PeerTube, so tread carefully.

Transcoding enabled

Input formats

Allows users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, .m2ts, .mxf, or .nut videos.

Allows users to upload .mp3, .ogg, .wma, .flac, .aac, or .ac3 audio files.

The file will be merged in a still image video with the preview file on upload.

Output formats

If you also enabled HLS support, it will multiply videos storage by 2

If disabled, breaks federation with PeerTube instances < 2.1

Requires ffmpeg >= 4.1

Generate HLS playlists and fragmented MP4 files resulting in a better playback than with plain WebTorrent:

Resolution change is smoother
Faster playback especially with long videos
More stable playback (less bugs/infinite loading)

If you also enabled WebTorrent support, it will multiply videos storage by 2

Resolutions to generate per enabled format

The original file resolution will be the default target if no option is selected.

Transcoding threads

will claim at most {{ getTotalTranscodingThreads().value }} {{ getTotalTranscodingThreads().unit }} with live transcoding

will claim at least {{ getTotalTranscodingThreads().value }} {{ getTotalTranscodingThreads().unit }} with live transcoding

Transcoding profile new transcoding profiles can be added by PeerTube plugins

{{ item }}
x264, targeting maximum device compatibility

Live streaming

LIVE

Enable users of your instance to stream live.

Allow live streaming

⚠️ Enabling live streaming requires trust in your users and extra moderation work

If enabled, your server needs to accept incoming TCP traffic on port {{ liveRTMPPort }}

If the user quota is reached, PeerTube will automatically terminate the live streaming

Max simultaneous lives created on your instance (-1 for "unlimited")

{form.value['live']['maxInstanceLives'], plural, =1 {live} other {lives}}

Max simultaneous lives created per user (-1 for "unlimited")

{form.value['live']['maxUserLives'], plural, =1 {live} other {lives}}

Max live duration

TRANSCODING

Same as VOD transcoding, transcoding live streams so that they are in a streamable form that any device can play. Requires a beefy CPU, and then some.

Transcoding enabled for live streams

Live resolutions to generate

Live transcoding threads

will claim at most {{ getTotalTranscodingThreads().value }} {{ getTotalTranscodingThreads().unit }} with VOD transcoding

will claim at least {{ getTotalTranscodingThreads().value }} {{ getTotalTranscodingThreads().unit }} with VOD transcoding

Live transcoding profile new live transcoding profiles can be added by PeerTube plugins

{{ item }}
x264, targeting maximum device compatibility

Advanced configuration

CACHE

Some files are not federated, and fetched when necessary. Define their caching policies.

Number of previews to keep in cache

{form.value['cache']['previews']['size'], plural, =1 {cached image} other {cached images}}

Number of video captions to keep in cache

{form.value['cache']['captions']['size'], plural, =1 {cached image} other {cached images}}

CUSTOMIZATIONS

Slight modifications to your PeerTube instance for when creating a plugin or theme is overkill.

JavaScript

Write JavaScript code directly.
Example:

console.log('my instance is amazing');

CSS

Write CSS code directly. Example:

    #custom-css {{ '{' }}
      color: red;
    {{ '}' }}

Prepend with #custom-css to override styles. Example:

    #custom-css .logged-in-email {{ '{' }}
      color: red;
    {{ '}' }}

Configuration