config/production.yaml.example

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