X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=client%2Fsrc%2Fapp%2F%2Badmin%2Fconfig%2Fedit-custom-config%2Fedit-custom-config.component.html;h=5f02d00e8070a7628d362815cd1b469294857d4a;hb=149e4cc597777f2fcf9a62639afeeb0e168cedb2;hp=47e3e5a52605eacd923bb3ae993d57705e197e47;hpb=e771dbe0aa6ccc005472001230ef0ef4b3ad1a56;p=github%2FChocobozzz%2FPeerTube.git diff --git a/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.html b/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.html index 47e3e5a52..5f02d00e8 100644 --- a/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.html +++ b/client/src/app/+admin/config/edit-custom-config/edit-custom-config.component.html @@ -1,608 +1,1199 @@ +

Configuration

- +
- - + + Instance information - - -
Instance
- -
- - -
{{ formErrors.instance.name }}
-
- -
- - -
{{ formErrors.instance.shortDescription }}
-
- -
- - -
{{ formErrors.instance.description }}
-
+ -
- + -
- +
+
+
INSTANCE
-
-
- +
-
- -
-
+
+ + +
{{ formErrors.instance.name }}
+
-
Moderation & NSFW
+
+ + +
{{ formErrors.instance.shortDescription }}
+
-
- - - This instance is dedicated to sensitive or NSFW content - +
+ + +
{{ formErrors.instance.description }}
+
- - - 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. - - - -
+
+ + +
+ + +
+
-
- +
+ + +
+ + +
+
- - - - With Do not list or Blur thumbnails, a confirmation will be requested to watch the video. - - - - -
-
-
{{ formErrors.instance.defaultNSFWPolicy }}
-
- - -
{{ formErrors.instance.terms }}
-
+
+
+
MODERATION & NSFW
+
+ Manage users to build a moderation team. +
+
-
- - -
{{ formErrors.instance.codeOfConduct }}
-
+
-
- -
Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
+
+ + + 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. + + + +
- -
{{ formErrors.instance.moderationInformation }}
-
+
+ + + + + + With Do not list or Blur thumbnails, a confirmation will be requested to watch the video. + + + + +
+ +
+
{{ formErrors.instance.defaultNSFWPolicy }}
+
-
You and your instance
+
+ + +
{{ formErrors.instance.terms }}
+
-
- -
A single person? A non profit? A company?
+
+ + +
{{ formErrors.instance.codeOfConduct }}
+
- +
+ +
Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
+ + +
{{ formErrors.instance.moderationInformation }}
+
-
{{ formErrors.instance.administrator }}
+
-
- -
To share your personal videos? To open registrations and allow people to upload what they want?
- - -
{{ formErrors.instance.creationReason }}
-
+
+
+
YOU AND YOUR INSTANCE
+
-
- -
It's important to know for users who want to register on your instance
+
- -
{{ formErrors.instance.maintenanceLifetime }}
-
+
+ +
A single person? A non-profit? A company?
-
- -
With you own funds? With users donations? Advertising?
+ - -
{{ formErrors.instance.businessModel }}
-
+
{{ formErrors.instance.administrator }}
+
-
Other information
+
+ +
To share your personal videos? To open registrations and allow people to upload what they want?
+ + +
{{ formErrors.instance.creationReason }}
+
-
- -
2vCore 2GB RAM/or directly the link to the server you rent etc
+
+ +
It's important to know for users who want to register on your instance
+ + +
{{ formErrors.instance.maintenanceLifetime }}
+
- +
+ +
With your own funds? With user donations? Advertising?
+ + +
{{ formErrors.instance.businessModel }}
+
-
{{ formErrors.instance.hardwareInformation }}
+
- - - - - - - -
Theme & Default route
- - -
- - -
- +
+
+
OTHER INFORMATION
-
- +
-
- -
- -
-
{{ formErrors.instance.defaultClientRoute }}
-
+
+ +
i.e. 2vCore 2GB RAM, a direct the link to the server you rent, etc.
-
Signup
+ - -
- -
+
{{ formErrors.instance.hardwareInformation }}
+
-
- +
-
- - -
{{ formErrors.signup.limit }}
-
+ + + + Basic configuration -
Users
+ - -
- -
- +
+
+
APPEARANCE
+
+ Use plugins & themes for more involved changes, or add slight customizations.
-
{{ formErrors.user.videoQuota }}
-
- -
- -
-
{{ formErrors.user.videoQuotaDaily }}
-
- +
+ +
+ -
Import
+
+ +
+
+ -
- +
+ +
+ +
+
{{ formErrors.instance.defaultClientRoute }}
-
- +
+ + + +
+ +
+
{{ formErrors.trending.videos.algorithms.default }}
+ +
- - +
+
+
+
+
BROADCAST MESSAGE
+
+ Display a message on your instance +
+
-
Auto-blacklist
+
- - - +
- - - +
+ +
+
+ +
+ +
+
{{ formErrors.broadcastMessage.level }}
+
-
Instance followers
+
+ + +
{{ formErrors.broadcastMessage.message }}
+
- - + -
- -
+
+
-
- +
+
+
NEW USERS
+
+ Manage users to set their quota individually.
- - - -
Instance followings
+
- - +
- +
+ inputName="signupEnabled" formControlName="enabled" + i18n-labelText labelText="Enable Signup" + > + + ⚠️ This functionality requires a lot of attention and extra moderation. + + + + + + +
+ +
+ + {form.value['signup']['limit'], plural, =1 {user} other {users}} +
+
{{ formErrors.signup.limit }}
+ Signup won't be limited to a fixed number of users. +
+ +
- +
- + +
+ +
+
{{ formErrors.user.videoQuota }}
- - -
{{ formErrors.followings.instance.autoFollowIndex.indexUrl }}
+ +
+ +
+
{{ formErrors.user.videoQuotaDaily }}
+ +
+
+ +
+
+
VIDEOS
+
+ +
+ + + + +
+ +
+ +
+ +
+ + - - + + + + +
+ + + Unless a user is marked as trusted, their videos will stay private until a moderator reviews them. + + +
-
Administrator
+ + + -
- - -
{{ formErrors.admin.email }}
+
-
- +
+
+
SEARCH
+
+ +
+ + + + +
+ + + 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. + + + + +
+ + +
{{ formErrors.search.searchIndex.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. + + +
+ - - -
Twitter
+ +
+ + +

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

+ + + You should only follow moderated indexes in production, or host your own. + + + + +
+ + +
{{ formErrors.followings.instance.autoFollowIndex.indexUrl }}
+
+ + +
- - + + + + +
+
-
- +
+
+
ADMINISTRATORS
+
- - - Indicates the Twitter account for the website or platform on which the content was published. - - +
+
+ -
{{ formErrors.services.twitter.username }}
+
{{ formErrors.admin.email }}
-
- - - Instance whitelisted by Twitter - - - - - If your instance is whitelisted by Twitter, a video player will be embedded in the Twitter feed on PeerTube video share.
- If the instance is not whitelisted, we use an image link card that will redirect on 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 whitelisted. - - - +
+
- - +
+
+ +
+
+
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. +
+
- - +
+ + + + +
+ + + +
{{ formErrors.services.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. + + + +
+ + + - - +
+
+ + -
Transcoding
+ + VOD Transcoding - -
- - - Transcoding enabled - + - - If you disable transcoding, many videos from your users will not work! - - -
+
+
+
- +
+ + 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. + -
- - - Allow your users to upload .mkv, .mov, .avi, .flv videos - - +
+ Read guidelines +
-
- - - Allow your users to upload audio files that will be merged with the preview file on upload - - + +
+
+ +
+
+
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 + + + + +
+ + +
+ + + 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.
+ + +
+
+ +
+ + + +
+ + + +

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

+ + + +
+ + +
+ + +
+ +
+ + +
+ + +
+ + + The original file resolution will be the default target if no option is selected. + + +
+
+
+ + +
-
{{ formErrors.transcoding.threads }}
-
- -
- +
+ + + will claim at most {{ getTotalTranscodingThreads().value }} {{ getTotalTranscodingThreads().unit }} with live transcoding + will claim at least {{ getTotalTranscodingThreads().value }} {{ getTotalTranscodingThreads().unit }} with live transcoding + + +
+ +
+
{{ formErrors.transcoding.threads }}
+ +
+ + new transcoding profiles can be added by PeerTube plugins + + + + {{ item }} + +
+ x264, targeting maximum device compatibility + + + +
{{ formErrors.transcoding.profile }}
+
+ - - +
+
-
- Cache + + + + + Live streaming + + + +
+
+
LIVE
+
+ Enable users of your instance to stream live. +
+
+ +
+ + - - - Some files are not federated (previews, captions). We fetch them directly from the origin instance and cache them. - - +
+ + + 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 + + +
+ +
+ +
+ + {form.value['live']['maxInstanceLives'], plural, =1 {live} other {lives}} +
+
+ +
+ +
+ + {form.value['live']['maxUserLives'], plural, =1 {live} other {lives}} +
+
+ +
+ + + +
+ + + +
+ +
- -
- - -
{{ formErrors.cache.previews.size }}
+
+
+
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. +
-
- - -
{{ formErrors.cache.captions.size }}
+
+ + + + +
+ + + Transcoding enabled for live streams + + +
+ +
+ + +
+ +
+ + +
+ + +
+ +
+
+ +
+ + + will claim at most {{ getTotalTranscodingThreads().value }} {{ getTotalTranscodingThreads().unit }} with VOD transcoding + will claim at least {{ getTotalTranscodingThreads().value }} {{ getTotalTranscodingThreads().unit }} with VOD transcoding + + +
+ +
+
{{ formErrors.live.transcoding.threads }}
+
+ +
+ + New live transcoding profiles can be added by PeerTube plugins + +
+ +
+
{{ formErrors.live.transcoding.profile }}
+
+ + + +
- +
-
Customizations
+ + - - -
- - - - - Write directly JavaScript code.
Example: 
console.log('my instance is amazing');
- - - + + Advanced configuration - + -
{{ formErrors.instance.customizations.javascript }}
+
+
+
CACHE
+
+ Some files are not federated, and fetched when necessary. Define their caching policies.
+
-
- - - - - - Write directly CSS code. Example:

-
-#custom-css {{ '{' }}
-  color: red;
-{{ '}' }}
-
- - Prepend with #custom-css to override styles. Example:

-
-#custom-css .logged-in-email {{ '{' }}
-  color: red;
-{{ '}' }}
-
- - - - - -
{{ formErrors.instance.customizations.css }}
+
+ + +
+ +
+ + {form.value['cache']['previews']['size'], plural, =1 {cached image} other {cached images}} +
+
{{ formErrors.cache.previews.size }}
+
+ +
+ +
+ + {form.value['cache']['captions']['size'], plural, =1 {cached image} other {cached images}} +
+
{{ formErrors.cache.captions.size }}
+
+ + +
+
+ +
+
+
+
CUSTOMIZATIONS
+
+ Slight modifications to your PeerTube instance for when creating a plugin or theme is overkill.
- - +
+ +
+ + + +
+ + + + + Write JavaScript code directly.
Example: 
console.log('my instance is amazing');
+ + + + + + +
{{ formErrors.instance.customizations.javascript }}
+
+ +
+ + + + + + Write CSS code directly. Example:

+ 
+    #custom-css {{ '{' }}
+      color: red;
+    {{ '}' }}
+
+ Prepend with #custom-css to override styles. Example:

+ 
+    #custom-css .logged-in-email {{ '{' }}
+      color: red;
+    {{ '}' }}
+
+ + + + + +
{{ formErrors.instance.customizations.css }}
+
+ + + +
+
- - + +
+ +
+ +
+
+
+ + It seems like the configuration is invalid. Please search for potential errors in the different tabs. + + + + You cannot allow live replay if you don't enable transcoding. + - - It seems the configuration is invalid. Please search potential errors in the different tabs. + +
+