config/default.yaml

   1 # /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #
   2
   3 listen:
   4   hostname: '127.0.0.1'
   5   port: 9000
   6
   7 # Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
   8 webserver:
   9   https: false
  10   hostname: 'localhost'
  11   port: 9000
  12
  13 # Secrets you need to generate the first time you run PeerTube
  14 secrets:
  15   # Generate one using `openssl rand -hex 32`
  16   peertube: ''
  17
  18 rates_limit:
  19   api:
  20     # 50 attempts in 10 seconds
  21     window: 10 seconds
  22     max: 50
  23   login:
  24     # 15 attempts in 5 min
  25     window: 5 minutes
  26     max: 15
  27   signup:
  28     # 2 attempts in 5 min (only succeeded attempts are taken into account)
  29     window: 5 minutes
  30     max: 2
  31   ask_send_email:
  32     # 3 attempts in 5 min
  33     window: 5 minutes
  34     max: 3
  35   receive_client_log:
  36     # 10 attempts in 10 min
  37     window: 10 minutes
  38     max: 10
  39
  40 oauth2:
  41   token_lifetime:
  42     access_token: '1 day'
  43     refresh_token: '2 weeks'
  44
  45 # Proxies to trust to get real client IP
  46 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
  47 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
  48 trust_proxy:
  49   - 'loopback'
  50
  51 # Your database name will be database.name OR 'peertube'+database.suffix
  52 database:
  53   hostname: 'localhost'
  54   port: 5432
  55   ssl: false
  56   suffix: '_dev'
  57   username: 'peertube'
  58   password: 'peertube'
  59   pool:
  60     max: 5
  61
  62 # Redis server for short time storage
  63 # You can also specify a 'socket' path to a unix socket but first need to
  64 # set 'hostname' and 'port' to null
  65 redis:
  66   hostname: 'localhost'
  67   port: 6379
  68   auth: null
  69   db: 0
  70
  71 # SMTP server to send emails
  72 smtp:
  73   # smtp or sendmail
  74   transport: smtp
  75   # Path to sendmail command. Required if you use sendmail transport
  76   sendmail: null
  77   hostname: null
  78   port: 465 # If you use StartTLS: 587
  79   username: null
  80   password: null
  81   tls: true # If you use StartTLS: false
  82   disable_starttls: false
  83   ca_file: null # Used for self signed certificates
  84   from_address: 'admin@example.com'
  85
  86 email:
  87   body:
  88     signature: 'PeerTube'
  89   subject:
  90     prefix: '[PeerTube]'
  91
  92 # Update default PeerTube values
  93 # Set by API when the field is not provided and put as default value in client
  94 defaults:
  95   # Change default values when publishing a video (upload/import/go Live)
  96   publish:
  97     download_enabled: true
  98
  99     comments_enabled: true
 100
 101     # public = 1, unlisted = 2, private = 3, internal = 4
 102     privacy: 1
 103
 104     # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
 105     # You can also choose a custom licence value added by a plugin
 106     # No licence by default
 107     licence: null
 108
 109   p2p:
 110     # Enable P2P by default in PeerTube client
 111     # Can be enabled/disabled by anonymous users and logged in users
 112     webapp:
 113       enabled: true
 114
 115     # Enable P2P by default in PeerTube embed
 116     # Can be enabled/disabled by URL option
 117     embed:
 118       enabled: true
 119
 120 # From the project root directory
 121 storage:
 122   tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
 123   bin: 'storage/bin/'
 124   avatars: 'storage/avatars/'
 125   videos: 'storage/videos/'
 126   streaming_playlists: 'storage/streaming-playlists/'
 127   redundancy: 'storage/redundancy/'
 128   logs: 'storage/logs/'
 129   previews: 'storage/previews/'
 130   thumbnails: 'storage/thumbnails/'
 131   torrents: 'storage/torrents/'
 132   captions: 'storage/captions/'
 133   cache: 'storage/cache/'
 134   plugins: 'storage/plugins/'
 135   well_known: 'storage/well-known/'
 136   # Overridable client files in client/dist/assets/images:
 137   # - logo.svg
 138   # - favicon.png
 139   # - default-playlist.jpg
 140   # - default-avatar-account.png
 141   # - default-avatar-video-channel.png
 142   # - and icons/*.png (PWA)
 143   # Could contain for example assets/images/favicon.png
 144   # If the file exists, peertube will serve it
 145   # If not, peertube will fallback to the default file
 146   client_overrides: 'storage/client-overrides/'
 147
 148 static_files:
 149   # Require and check user authentication when accessing private files (internal/private video files)
 150   private_files_require_auth: true
 151
 152 object_storage:
 153   enabled: false
 154
 155   # Without protocol, will default to HTTPS
 156   endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
 157
 158   region: 'us-east-1'
 159
 160   upload_acl:
 161     # Set this ACL on each uploaded object of public/unlisted videos
 162     # Use null if your S3 provider does not support object ACL
 163     public: 'public-read'
 164     # Set this ACL on each uploaded object of private/internal videos
 165     # PeerTube can proxify requests to private objects so your users can access them
 166     # Use null if your S3 provider does not support object ACL
 167     private: 'private'
 168
 169   proxy:
 170     # If private files (private/internal video files) have a private ACL, users can't access directly the ressource
 171     # PeerTube can proxify requests between your object storage service and your users
 172     # If you disable PeerTube proxy, ensure you use your own proxy that is able to access the private files
 173     # Or you can also set a public ACL for private files in object storage if you don't want to use a proxy
 174     proxify_private_files: true
 175
 176   credentials:
 177     # You can also use AWS_ACCESS_KEY_ID env variable
 178     access_key_id: ''
 179     # You can also use AWS_SECRET_ACCESS_KEY env variable
 180     secret_access_key: ''
 181
 182   # Maximum amount to upload in one request to object storage
 183   max_upload_part: 100MB
 184
 185   streaming_playlists:
 186     bucket_name: 'streaming-playlists'
 187
 188     # Allows setting all buckets to the same value but with a different prefix
 189     prefix: '' # Example: 'streaming-playlists:'
 190
 191     # Base url for object URL generation, scheme and host will be replaced by this URL
 192     # Useful when you want to use a CDN/external proxy
 193     base_url: '' # Example: 'https://mirror.example.com'
 194
 195   # Same settings but for webtorrent videos
 196   videos:
 197     bucket_name: 'videos'
 198     prefix: ''
 199     base_url: ''
 200
 201 log:
 202   level: 'info' # 'debug' | 'info' | 'warn' | 'error'
 203
 204   rotation:
 205     enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
 206     max_file_size: 12MB
 207     max_files: 20
 208
 209   anonymize_ip: false
 210
 211   log_ping_requests: true
 212   log_tracker_unknown_infohash: true
 213
 214   prettify_sql: false
 215
 216   # Accept warn/error logs coming from the client
 217   accept_client_log: true
 218
 219 # Support of Open Telemetry metrics and tracing
 220 # For more information: https://docs.joinpeertube.org/maintain/observability
 221 open_telemetry:
 222   metrics:
 223     enabled: false
 224
 225     # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics
 226     prometheus_exporter:
 227       hostname: '127.0.0.1'
 228       port: 9091
 229
 230   tracing:
 231     enabled: false
 232
 233     # Send traces to a Jaeger compatible endpoint
 234     jaeger_exporter:
 235       endpoint: ''
 236
 237 trending:
 238   videos:
 239     interval_days: 7 # Compute trending videos for the last x days for 'most-viewed' algorithm
 240
 241     algorithms:
 242       enabled:
 243         - 'hot' # Adaptation of Reddit's 'Hot' algorithm
 244         - 'most-viewed' # Number of views in the last x days
 245         - 'most-liked' # Global views since the upload of the video
 246
 247       default: 'most-viewed'
 248
 249 # Cache remote videos on your server, to help other instances to broadcast the video
 250 # You can define multiple caches using different sizes/strategies
 251 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
 252 redundancy:
 253   videos:
 254     check_interval: '1 hour' # How often you want to check new videos to cache
 255     strategies: # Just uncomment strategies you want
 256 #      -
 257 #        size: '10GB'
 258 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 259 #        min_lifetime: '48 hours'
 260 #        strategy: 'most-views' # Cache videos that have the most views
 261 #      -
 262 #        size: '10GB'
 263 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 264 #        min_lifetime: '48 hours'
 265 #        strategy: 'trending' # Cache trending videos
 266 #      -
 267 #        size: '10GB'
 268 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 269 #        min_lifetime: '48 hours'
 270 #        strategy: 'recently-added' # Cache recently added videos
 271 #        min_views: 10 # Having at least x views
 272
 273 # Other instances that duplicate your content
 274 remote_redundancy:
 275   videos:
 276     # 'nobody': Do not accept remote redundancies
 277     # 'anybody': Accept remote redundancies from anybody
 278     # 'followings': Accept redundancies from instance followings
 279     accept_from: 'anybody'
 280
 281 csp:
 282   enabled: false
 283   report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
 284   report_uri:
 285
 286 security:
 287   # Set the X-Frame-Options header to help to mitigate clickjacking attacks
 288   frameguard:
 289     enabled: true
 290
 291   # Set x-powered-by HTTP header to "PeerTube"
 292   # Can help remote software to know this is a PeerTube instance
 293   powered_by_header:
 294     enabled: true
 295
 296 tracker:
 297   # If you disable the tracker, you disable the P2P on your PeerTube instance
 298   enabled: true
 299   # Only handle requests on your videos
 300   # If you set this to false it means you have a public tracker
 301   # Then, it is possible that clients overload your instance with external torrents
 302   private: true
 303   # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
 304   reject_too_many_announces: false
 305
 306 history:
 307   videos:
 308     # If you want to limit users videos history
 309     # -1 means there is no limitations
 310     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 311     max_age: -1
 312
 313 views:
 314   videos:
 315     # PeerTube creates a database entry every hour for each video to track views over a period of time
 316     # This is used in particular by the Trending page
 317     # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
 318     # -1 means no cleanup
 319     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 320     remote:
 321       max_age: '30 days'
 322
 323     # PeerTube buffers local video views before updating and federating the video
 324     local_buffer_update_interval: '30 minutes'
 325
 326     ip_view_expiration: '1 hour'
 327
 328 # Used to get country location of views of local videos
 329 geo_ip:
 330   enabled: true
 331
 332   country:
 333     database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
 334
 335 plugins:
 336   # The website PeerTube will ask for available PeerTube plugins and themes
 337   # This is an unmoderated plugin index, so only install plugins/themes you trust
 338   index:
 339     enabled: true
 340     check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
 341     url: 'https://packages.joinpeertube.org'
 342
 343 federation:
 344   videos:
 345     federate_unlisted: false
 346
 347     # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
 348     # It removes objects that do not exist anymore, and potentially fix their URLs
 349     cleanup_remote_interactions: true
 350
 351 peertube:
 352   check_latest_version:
 353     # Check and notify admins of new PeerTube versions
 354     enabled: true
 355     # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
 356     url: 'https://joinpeertube.org/api/v1/versions.json'
 357
 358 webadmin:
 359   configuration:
 360     edition:
 361       # Set this to false if you don't want to allow config edition in the web interface by instance admins
 362       allowed: true
 363
 364 # XML, Atom or JSON feeds
 365 feeds:
 366   videos:
 367     # Default number of videos displayed in feeds
 368     count: 20
 369
 370   comments:
 371     # Default number of comments displayed in feeds
 372     count: 20
 373
 374 cache:
 375   previews:
 376     size: 500 # Max number of previews you want to cache
 377   captions:
 378     size: 500 # Max number of video captions/subtitles you want to cache
 379   torrents:
 380     size: 500 # Max number of video torrents you want to cache
 381
 382 admin:
 383   # Used to generate the root user at first startup
 384   # And to receive emails from the contact form
 385   email: 'admin@example.com'
 386
 387 contact_form:
 388   enabled: true
 389
 390 signup:
 391   enabled: false
 392
 393   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
 394
 395   minimum_age: 16 # Used to configure the signup form
 396
 397   # Users fill a form to register so moderators can accept/reject the registration
 398   requires_approval: true
 399   requires_email_verification: false
 400
 401   filters:
 402     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
 403       whitelist: []
 404       blacklist: []
 405
 406 user:
 407   # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
 408   # Byte format is supported ("1GB" etc)
 409   # -1 == unlimited
 410   video_quota: -1
 411   video_quota_daily: -1
 412
 413 video_channels:
 414   max_per_user: 20 # Allows each user to create up to 20 video channels.
 415
 416 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
 417 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
 418 # Please, do not disable transcoding since many uploaded videos will not work
 419 transcoding:
 420   enabled: true
 421
 422   # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
 423   allow_additional_extensions: true
 424
 425   # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
 426   allow_audio_files: true
 427
 428   # Amount of threads used by ffmpeg for 1 transcoding job
 429   threads: 1
 430   # Amount of transcoding jobs to execute in parallel
 431   concurrency: 1
 432
 433   # Choose the transcoding profile
 434   # New profiles can be added by plugins
 435   # Available in core PeerTube: 'default'
 436   profile: 'default'
 437
 438   resolutions: # Only created if the original video has a higher resolution, uses more storage!
 439     0p: false # audio-only (creates mp4 without video stream, always created when enabled)
 440     144p: false
 441     240p: false
 442     360p: false
 443     480p: false
 444     720p: false
 445     1080p: false
 446     1440p: false
 447     2160p: false
 448
 449   # Transcode and keep original resolution, even if it's above your maximum enabled resolution
 450   always_transcode_original_resolution: true
 451
 452   # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
 453   # If you also enabled the hls format, it will multiply videos storage by 2
 454   # If disabled, breaks federation with PeerTube instances < 2.1
 455   webtorrent:
 456     enabled: false
 457
 458   # /!\ Requires ffmpeg >= 4.1
 459   # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
 460   #     * Resolution change is smoother
 461   #     * Faster playback in particular with long videos
 462   #     * More stable playback (less bugs/infinite loading)
 463   # If you also enabled the webtorrent format, it will multiply videos storage by 2
 464   hls:
 465     enabled: true
 466
 467 live:
 468   enabled: false
 469
 470   # Limit lives duration
 471   # -1 == unlimited
 472   max_duration: -1 # For example: '5 hours'
 473
 474   # Limit max number of live videos created on your instance
 475   # -1 == unlimited
 476   max_instance_lives: 20
 477
 478   # Limit max number of live videos created by a user on your instance
 479   # -1 == unlimited
 480   max_user_lives: 3
 481
 482   # Allow your users to save a replay of their live
 483   # PeerTube will transcode segments in a video file
 484   # If the user daily/total quota is reached, PeerTube will stop the live
 485   # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
 486   allow_replay: true
 487
 488   # Allow your users to change latency settings (small latency/default/high latency)
 489   # Small latency live streams cannot use P2P
 490   # High latency live streams can increase P2P ratio
 491   latency_setting:
 492     enabled: true
 493
 494   # Your firewall should accept traffic from this port in TCP if you enable live
 495   rtmp:
 496     enabled: true
 497
 498     # Listening hostname/port for RTMP server
 499     # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
 500     # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
 501     hostname: null
 502     port: 1935
 503
 504     # Public hostname of your RTMP server
 505     # Use null to use the same value than `webserver.hostname`
 506     public_hostname: null
 507
 508   rtmps:
 509     enabled: false
 510
 511     # Listening hostname/port for RTMPS server
 512     # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
 513     # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
 514     hostname: null
 515     port: 1936
 516
 517     # Absolute paths
 518     key_file: ''
 519     cert_file: ''
 520
 521     # Public hostname of your RTMPS server
 522     # Use null to use the same value than `webserver.hostname`
 523     public_hostname: null
 524
 525   # Allow to transcode the live streaming in multiple live resolutions
 526   transcoding:
 527     enabled: true
 528     threads: 2
 529
 530     # Choose the transcoding profile
 531     # New profiles can be added by plugins
 532     # Available in core PeerTube: 'default'
 533     profile: 'default'
 534
 535     resolutions:
 536       144p: false
 537       240p: false
 538       360p: false
 539       480p: false
 540       720p: false
 541       1080p: false
 542       1440p: false
 543       2160p: false
 544
 545     # Also transcode original resolution, even if it's above your maximum enabled resolution
 546     always_transcode_original_resolution: true
 547
 548 video_studio:
 549   # Enable video edition by users (cut, add intro/outro, add watermark etc)
 550   # If enabled, users can create transcoding tasks as they wish
 551   enabled: false
 552
 553 import:
 554   # Add ability for your users to import remote videos (from YouTube, torrent...)
 555   videos:
 556     # Amount of import jobs to execute in parallel
 557     concurrency: 1
 558
 559     # Set a custom video import timeout to not block import queue
 560     timeout: '2 hours'
 561
 562     # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
 563     http:
 564       # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
 565       # See https://docs.joinpeertube.org/maintain/configuration#security for more information
 566       enabled: false
 567
 568       youtube_dl_release:
 569         # Direct download URL to youtube-dl binary
 570         # Github releases API is also supported
 571         # Examples:
 572         #   * https://api.github.com/repos/ytdl-org/youtube-dl/releases
 573         #   * https://api.github.com/repos/yt-dlp/yt-dlp/releases
 574         #   * https://yt-dl.org/downloads/latest/youtube-dl
 575         url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
 576
 577         # Release binary name: 'yt-dlp' or 'youtube-dl'
 578         name: 'yt-dlp'
 579
 580         # Path to the python binary to execute for youtube-dl or yt-dlp
 581         python_path: '/usr/bin/python3'
 582
 583       # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
 584       force_ipv4: false
 585
 586     # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
 587     torrent:
 588       # We recommend to only enable magnet URI/torrent import if you trust your users
 589       # See https://docs.joinpeertube.org/maintain/configuration#security for more information
 590       enabled: false
 591
 592   # Add ability for your users to synchronize their channels with external channels, playlists, etc
 593   video_channel_synchronization:
 594     enabled: false
 595
 596     max_per_user: 10
 597
 598     check_interval: 1 hour
 599
 600     # Number of latest published videos to check and to potentially import when syncing a channel
 601     videos_limit_per_synchronization: 10
 602
 603     # Max number of videos to import when the user asks for full sync
 604     full_sync_videos_limit: 1000
 605
 606 auto_blacklist:
 607   # New videos automatically blacklisted so moderators can review before publishing
 608   videos:
 609     of_users:
 610       enabled: false
 611
 612 # Instance settings
 613 instance:
 614   name: 'PeerTube'
 615   short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
 616   description: 'Welcome to this PeerTube instance!' # Support markdown
 617   terms: 'No terms for now.' # Support markdown
 618   code_of_conduct: '' # Supports markdown
 619
 620   # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
 621   moderation_information: '' # Supports markdown
 622
 623   # Why did you create this instance?
 624   creation_reason: '' # Supports Markdown
 625
 626   # Who is behind the instance? A single person? A non profit?
 627   administrator: '' # Supports Markdown
 628
 629   # How long do you plan to maintain this instance?
 630   maintenance_lifetime: '' # Supports Markdown
 631
 632   # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
 633   business_model: '' # Supports Markdown
 634
 635   # If you want to explain on what type of hardware your PeerTube instance runs
 636   # Example: '2 vCore, 2GB RAM...'
 637   hardware_information: '' # Supports Markdown
 638
 639   # What are the main languages of your instance? To interact with your users for example
 640   # Uncomment or add the languages you want
 641   # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
 642   languages:
 643 #    - en
 644 #    - es
 645 #    - fr
 646
 647   # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
 648   # Uncomment or add the category ids you want
 649   # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
 650   categories:
 651 #    - 1  # Music
 652 #    - 2  # Films
 653 #    - 3  # Vehicles
 654 #    - 4  # Art
 655 #    - 5  # Sports
 656 #    - 6  # Travels
 657 #    - 7  # Gaming
 658 #    - 8  # People
 659 #    - 9  # Comedy
 660 #    - 10 # Entertainment
 661 #    - 11 # News & Politics
 662 #    - 12 # How To
 663 #    - 13 # Education
 664 #    - 14 # Activism
 665 #    - 15 # Science & Technology
 666 #    - 16 # Animals
 667 #    - 17 # Kids
 668 #    - 18 # Food
 669
 670   default_client_route: '/videos/trending'
 671
 672   # Whether or not the instance is dedicated to NSFW content
 673   # Enabling it will allow other administrators to know that you are mainly federating sensitive content
 674   # Moreover, the NSFW checkbox on video upload will be automatically checked by default
 675   is_nsfw: false
 676   # By default, `do_not_list` or `blur` or `display` NSFW videos
 677   # Could be overridden per user with a setting
 678   default_nsfw_policy: 'do_not_list'
 679
 680   customizations:
 681     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
 682     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
 683   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
 684   robots: |
 685     User-agent: *
 686     Disallow:
 687   # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes
 688   # To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
 689   securitytxt:
 690     '# If you would like to report a security issue\n# you may report it to:\nContact: https://github.com/Chocobozzz/PeerTube/blob/develop/SECURITY.md\nContact: mailto:'
 691
 692 services:
 693   # Cards configuration to format video in Twitter
 694   twitter:
 695     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
 696     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
 697     # If false, we use an image link card that will redirect on your PeerTube instance
 698     # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
 699     whitelisted: false
 700
 701 followers:
 702   instance:
 703     # Allow or not other instances to follow yours
 704     enabled: true
 705     # Whether or not an administrator must manually validate a new follower
 706     manual_approval: false
 707
 708 followings:
 709   instance:
 710     # If you want to automatically follow back new instance followers
 711     # If this option is enabled, use the mute feature instead of deleting followings
 712     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 713     auto_follow_back:
 714       enabled: false
 715
 716     # If you want to automatically follow instances of the public index
 717     # If this option is enabled, use the mute feature instead of deleting followings
 718     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 719     auto_follow_index:
 720       enabled: false
 721       # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
 722       index_url: ''
 723
 724 theme:
 725   default: 'default'
 726
 727 broadcast_message:
 728   enabled: false
 729   message: '' # Support markdown
 730   level: 'info' # 'info' | 'warning' | 'error'
 731   dismissable: false
 732
 733 search:
 734   # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
 735   # If enabled, the associated group will be able to "escape" from the instance follows
 736   # That means they will be able to follow channels, watch videos, list videos of non followed instances
 737   remote_uri:
 738     users: true
 739     anonymous: false
 740
 741   # Use a third party index instead of your local index, only for search results
 742   # Useful to discover content outside of your instance
 743   # If you enable search_index, you must enable remote_uri search for users
 744   # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
 745   # instead of loading the video locally
 746   search_index:
 747     enabled: false
 748     # URL of the search index, that should use the same search API and routes
 749     # than PeerTube: https://docs.joinpeertube.org/api/rest-reference.html
 750     # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
 751     # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
 752     url: ''
 753     # You can disable local search in the client, so users only use the search index
 754     disable_local_search: false
 755     # If you did not disable local search in the client, you can decide to use the search index by default
 756     is_default_search: false
 757
 758 # PeerTube client/interface configuration
 759 client:
 760   videos:
 761     miniature:
 762       # By default PeerTube client displays author username
 763       prefer_author_display_name: false
 764       display_author_avatar: false
 765     resumable_upload:
 766       # Max size of upload chunks, e.g. '90MB'
 767       # If null, it will be calculated based on network speed
 768       max_chunk_size: null
 769
 770   menu:
 771     login:
 772       # If you enable only one external auth plugin
 773       # You can automatically redirect your users on this external platform when they click on the login button
 774       redirect_on_single_external_auth: false