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