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 for 'most-viewed' algorithm
 238
 239     algorithms:
 240       enabled:
 241         - 'hot' # Adaptation of Reddit's 'Hot' algorithm
 242         - 'most-viewed' # Number of views in the last x days
 243         - 'most-liked' # Global views since the upload of the video
 244
 245       default: 'most-viewed'
 246
 247 # Cache remote videos on your server, to help other instances to broadcast the video
 248 # You can define multiple caches using different sizes/strategies
 249 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
 250 redundancy:
 251   videos:
 252     check_interval: '1 hour' # How often you want to check new videos to cache
 253     strategies: # Just uncomment strategies you want
 254 #      -
 255 #        size: '10GB'
 256 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 257 #        min_lifetime: '48 hours'
 258 #        strategy: 'most-views' # Cache videos that have the most views
 259 #      -
 260 #        size: '10GB'
 261 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 262 #        min_lifetime: '48 hours'
 263 #        strategy: 'trending' # Cache trending videos
 264 #      -
 265 #        size: '10GB'
 266 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 267 #        min_lifetime: '48 hours'
 268 #        strategy: 'recently-added' # Cache recently added videos
 269 #        min_views: 10 # Having at least x views
 270
 271 # Other instances that duplicate your content
 272 remote_redundancy:
 273   videos:
 274     # 'nobody': Do not accept remote redundancies
 275     # 'anybody': Accept remote redundancies from anybody
 276     # 'followings': Accept redundancies from instance followings
 277     accept_from: 'anybody'
 278
 279 csp:
 280   enabled: false
 281   report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
 282   report_uri:
 283
 284 security:
 285   # Set the X-Frame-Options header to help to mitigate clickjacking attacks
 286   frameguard:
 287     enabled: true
 288
 289   # Set x-powered-by HTTP header to "PeerTube"
 290   # Can help remote software to know this is a PeerTube instance
 291   powered_by_header:
 292     enabled: true
 293
 294 tracker:
 295   # If you disable the tracker, you disable the P2P on your PeerTube instance
 296   enabled: true
 297   # Only handle requests on your videos
 298   # If you set this to false it means you have a public tracker
 299   # Then, it is possible that clients overload your instance with external torrents
 300   private: true
 301   # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
 302   reject_too_many_announces: false
 303
 304 history:
 305   videos:
 306     # If you want to limit users videos history
 307     # -1 means there is no limitations
 308     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 309     max_age: -1
 310
 311 views:
 312   videos:
 313     # PeerTube creates a database entry every hour for each video to track views over a period of time
 314     # This is used in particular by the Trending page
 315     # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
 316     # -1 means no cleanup
 317     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 318     remote:
 319       max_age: '30 days'
 320
 321     # PeerTube buffers local video views before updating and federating the video
 322     local_buffer_update_interval: '30 minutes'
 323
 324     ip_view_expiration: '1 hour'
 325
 326 # Used to get country location of views of local videos
 327 geo_ip:
 328   enabled: true
 329
 330   country:
 331     database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
 332
 333 plugins:
 334   # The website PeerTube will ask for available PeerTube plugins and themes
 335   # This is an unmoderated plugin index, so only install plugins/themes you trust
 336   index:
 337     enabled: true
 338     check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
 339     url: 'https://packages.joinpeertube.org'
 340
 341 federation:
 342   videos:
 343     federate_unlisted: false
 344
 345     # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
 346     # It removes objects that do not exist anymore, and potentially fix their URLs
 347     cleanup_remote_interactions: true
 348
 349 peertube:
 350   check_latest_version:
 351     # Check and notify admins of new PeerTube versions
 352     enabled: true
 353     # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
 354     url: 'https://joinpeertube.org/api/v1/versions.json'
 355
 356 webadmin:
 357   configuration:
 358     edition:
 359       # Set this to false if you don't want to allow config edition in the web interface by instance admins
 360       allowed: true
 361
 362 # XML, Atom or JSON feeds
 363 feeds:
 364   videos:
 365     # Default number of videos displayed in feeds
 366     count: 20
 367
 368   comments:
 369     # Default number of comments displayed in feeds
 370     count: 20
 371
 372 ###############################################################################
 373 #
 374 # From this point, almost all following keys can be overridden by the web interface
 375 # (local-production.json file). If you need to change some values, prefer to
 376 # use the web interface because the configuration will be automatically
 377 # reloaded without any need to restart PeerTube
 378 #
 379 # /!\ If you already have a local-production.json file, modification of some of
 380 # the following keys will have no effect /!\
 381 #
 382 ###############################################################################
 383
 384 cache:
 385   previews:
 386     size: 500 # Max number of previews you want to cache
 387   captions:
 388     size: 500 # Max number of video captions/subtitles you want to cache
 389   torrents:
 390     size: 500 # Max number of video torrents you want to cache
 391
 392 admin:
 393   # Used to generate the root user at first startup
 394   # And to receive emails from the contact form
 395   email: 'admin@example.com'
 396
 397 contact_form:
 398   enabled: true
 399
 400 signup:
 401   enabled: false
 402
 403   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
 404
 405   minimum_age: 16 # Used to configure the signup form
 406
 407   # Users fill a form to register so moderators can accept/reject the registration
 408   requires_approval: true
 409   requires_email_verification: false
 410
 411   filters:
 412     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
 413       whitelist: []
 414       blacklist: []
 415
 416 user:
 417   # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
 418   # Byte format is supported ("1GB" etc)
 419   # -1 == unlimited
 420   video_quota: -1
 421   video_quota_daily: -1
 422
 423 video_channels:
 424   max_per_user: 20 # Allows each user to create up to 20 video channels.
 425
 426 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
 427 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
 428 # Please, do not disable transcoding since many uploaded videos will not work
 429 transcoding:
 430   enabled: true
 431
 432   # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
 433   allow_additional_extensions: true
 434
 435   # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
 436   allow_audio_files: true
 437
 438   # Amount of threads used by ffmpeg for 1 transcoding job
 439   threads: 1
 440   # Amount of transcoding jobs to execute in parallel
 441   concurrency: 1
 442
 443   # Choose the transcoding profile
 444   # New profiles can be added by plugins
 445   # Available in core PeerTube: 'default'
 446   profile: 'default'
 447
 448   resolutions: # Only created if the original video has a higher resolution, uses more storage!
 449     0p: false # audio-only (creates mp4 without video stream, always created when enabled)
 450     144p: false
 451     240p: false
 452     360p: false
 453     480p: false
 454     720p: false
 455     1080p: false
 456     1440p: false
 457     2160p: false
 458
 459   # Transcode and keep original resolution, even if it's above your maximum enabled resolution
 460   always_transcode_original_resolution: true
 461
 462   # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
 463   # If you also enabled the hls format, it will multiply videos storage by 2
 464   # If disabled, breaks federation with PeerTube instances < 2.1
 465   webtorrent:
 466     enabled: false
 467
 468   # /!\ Requires ffmpeg >= 4.1
 469   # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
 470   #     * Resolution change is smoother
 471   #     * Faster playback in particular with long videos
 472   #     * More stable playback (less bugs/infinite loading)
 473   # If you also enabled the webtorrent format, it will multiply videos storage by 2
 474   hls:
 475     enabled: true
 476
 477 live:
 478   enabled: false
 479
 480   # Limit lives duration
 481   # -1 == unlimited
 482   max_duration: -1 # For example: '5 hours'
 483
 484   # Limit max number of live videos created on your instance
 485   # -1 == unlimited
 486   max_instance_lives: 20
 487
 488   # Limit max number of live videos created by a user on your instance
 489   # -1 == unlimited
 490   max_user_lives: 3
 491
 492   # Allow your users to save a replay of their live
 493   # PeerTube will transcode segments in a video file
 494   # If the user daily/total quota is reached, PeerTube will stop the live
 495   # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
 496   allow_replay: true
 497
 498   # Allow your users to change latency settings (small latency/default/high latency)
 499   # Small latency live streams cannot use P2P
 500   # High latency live streams can increase P2P ratio
 501   latency_setting:
 502     enabled: true
 503
 504   # Your firewall should accept traffic from this port in TCP if you enable live
 505   rtmp:
 506     enabled: true
 507
 508     # Listening hostname/port for RTMP server
 509     # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
 510     # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
 511     hostname: null
 512     port: 1935
 513
 514     # Public hostname of your RTMP server
 515     # Use null to use the same value than `webserver.hostname`
 516     public_hostname: null
 517
 518   rtmps:
 519     enabled: false
 520
 521     # Listening hostname/port for RTMPS server
 522     # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
 523     # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
 524     hostname: null
 525     port: 1936
 526
 527     # Absolute paths
 528     key_file: ''
 529     cert_file: ''
 530
 531     # Public hostname of your RTMPS server
 532     # Use null to use the same value than `webserver.hostname`
 533     public_hostname: null
 534
 535   # Allow to transcode the live streaming in multiple live resolutions
 536   transcoding:
 537     enabled: true
 538     threads: 2
 539
 540     # Choose the transcoding profile
 541     # New profiles can be added by plugins
 542     # Available in core PeerTube: 'default'
 543     profile: 'default'
 544
 545     resolutions:
 546       144p: false
 547       240p: false
 548       360p: false
 549       480p: false
 550       720p: false
 551       1080p: false
 552       1440p: false
 553       2160p: false
 554
 555     # Also transcode original resolution, even if it's above your maximum enabled resolution
 556     always_transcode_original_resolution: true
 557
 558 video_studio:
 559   # Enable video edition by users (cut, add intro/outro, add watermark etc)
 560   # If enabled, users can create transcoding tasks as they wish
 561   enabled: false
 562
 563 import:
 564   # Add ability for your users to import remote videos (from YouTube, torrent...)
 565   videos:
 566     # Amount of import jobs to execute in parallel
 567     concurrency: 1
 568
 569     # Set a custom video import timeout to not block import queue
 570     timeout: '2 hours'
 571
 572     # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
 573     http:
 574       # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
 575       # See https://docs.joinpeertube.org/maintain/configuration#security for more information
 576       enabled: false
 577
 578       youtube_dl_release:
 579         # Direct download URL to youtube-dl binary
 580         # Github releases API is also supported
 581         # Examples:
 582         #   * https://api.github.com/repos/ytdl-org/youtube-dl/releases
 583         #   * https://api.github.com/repos/yt-dlp/yt-dlp/releases
 584         #   * https://yt-dl.org/downloads/latest/youtube-dl
 585         url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
 586
 587         # Release binary name: 'yt-dlp' or 'youtube-dl'
 588         name: 'yt-dlp'
 589
 590         # Path to the python binary to execute for youtube-dl or yt-dlp
 591         python_path: '/usr/bin/python3'
 592
 593       # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
 594       force_ipv4: false
 595
 596     # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
 597     torrent:
 598       # We recommend to only enable magnet URI/torrent import if you trust your users
 599       # See https://docs.joinpeertube.org/maintain/configuration#security for more information
 600       enabled: false
 601
 602   # Add ability for your users to synchronize their channels with external channels, playlists, etc.
 603   video_channel_synchronization:
 604     enabled: false
 605
 606     max_per_user: 10
 607
 608     check_interval: 1 hour
 609
 610     # Number of latest published videos to check and to potentially import when syncing a channel
 611     videos_limit_per_synchronization: 10
 612
 613     # Max number of videos to import when the user asks for full sync
 614     full_sync_videos_limit: 1000
 615
 616 auto_blacklist:
 617   # New videos automatically blacklisted so moderators can review before publishing
 618   videos:
 619     of_users:
 620       enabled: false
 621
 622 # Instance settings
 623 instance:
 624   name: 'PeerTube'
 625   short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
 626   description: 'Welcome to this PeerTube instance!' # Support markdown
 627   terms: 'No terms for now.' # Support markdown
 628   code_of_conduct: '' # Supports markdown
 629
 630   # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
 631   moderation_information: '' # Supports markdown
 632
 633   # Why did you create this instance?
 634   creation_reason: '' # Supports Markdown
 635
 636   # Who is behind the instance? A single person? A non profit?
 637   administrator: '' # Supports Markdown
 638
 639   # How long do you plan to maintain this instance?
 640   maintenance_lifetime: '' # Supports Markdown
 641
 642   # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
 643   business_model: '' # Supports Markdown
 644
 645   # If you want to explain on what type of hardware your PeerTube instance runs
 646   # Example: '2 vCore, 2GB RAM...'
 647   hardware_information: '' # Supports Markdown
 648
 649   # What are the main languages of your instance? To interact with your users for example
 650   # Uncomment or add the languages you want
 651   # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
 652   languages:
 653 #    - en
 654 #    - es
 655 #    - fr
 656
 657   # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
 658   # Uncomment or add the category ids you want
 659   # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
 660   categories:
 661 #    - 1  # Music
 662 #    - 2  # Films
 663 #    - 3  # Vehicles
 664 #    - 4  # Art
 665 #    - 5  # Sports
 666 #    - 6  # Travels
 667 #    - 7  # Gaming
 668 #    - 8  # People
 669 #    - 9  # Comedy
 670 #    - 10 # Entertainment
 671 #    - 11 # News & Politics
 672 #    - 12 # How To
 673 #    - 13 # Education
 674 #    - 14 # Activism
 675 #    - 15 # Science & Technology
 676 #    - 16 # Animals
 677 #    - 17 # Kids
 678 #    - 18 # Food
 679
 680   default_client_route: '/videos/trending'
 681
 682   # Whether or not the instance is dedicated to NSFW content
 683   # Enabling it will allow other administrators to know that you are mainly federating sensitive content
 684   # Moreover, the NSFW checkbox on video upload will be automatically checked by default
 685   is_nsfw: false
 686   # By default, `do_not_list` or `blur` or `display` NSFW videos
 687   # Could be overridden per user with a setting
 688   default_nsfw_policy: 'do_not_list'
 689
 690   customizations:
 691     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
 692     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
 693   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
 694   robots: |
 695     User-agent: *
 696     Disallow:
 697   # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes
 698   # To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
 699   securitytxt:
 700     '# 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:'
 701
 702 services:
 703   # Cards configuration to format video in Twitter
 704   twitter:
 705     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
 706     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
 707     # If false, we use an image link card that will redirect on your PeerTube instance
 708     # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
 709     whitelisted: false
 710
 711 followers:
 712   instance:
 713     # Allow or not other instances to follow yours
 714     enabled: true
 715     # Whether or not an administrator must manually validate a new follower
 716     manual_approval: false
 717
 718 followings:
 719   instance:
 720     # If you want to automatically follow back new instance followers
 721     # If this option is enabled, use the mute feature instead of deleting followings
 722     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 723     auto_follow_back:
 724       enabled: false
 725
 726     # If you want to automatically follow instances of the public index
 727     # If this option is enabled, use the mute feature instead of deleting followings
 728     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 729     auto_follow_index:
 730       enabled: false
 731       # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
 732       index_url: ''
 733
 734 theme:
 735   default: 'default'
 736
 737 broadcast_message:
 738   enabled: false
 739   message: '' # Support markdown
 740   level: 'info' # 'info' | 'warning' | 'error'
 741   dismissable: false
 742
 743 search:
 744   # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
 745   # If enabled, the associated group will be able to "escape" from the instance follows
 746   # That means they will be able to follow channels, watch videos, list videos of non followed instances
 747   remote_uri:
 748     users: true
 749     anonymous: false
 750
 751   # Use a third party index instead of your local index, only for search results
 752   # Useful to discover content outside of your instance
 753   # If you enable search_index, you must enable remote_uri search for users
 754   # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
 755   # instead of loading the video locally
 756   search_index:
 757     enabled: false
 758     # URL of the search index, that should use the same search API and routes
 759     # than PeerTube: https://docs.joinpeertube.org/api/rest-reference.html
 760     # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
 761     # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
 762     url: ''
 763     # You can disable local search, so users only use the search index
 764     disable_local_search: false
 765     # If you did not disable local search, you can decide to use the search index by default
 766     is_default_search: false
 767
 768 # PeerTube client/interface configuration
 769 client:
 770   videos:
 771     miniature:
 772       # By default PeerTube client displays author username
 773       prefer_author_display_name: false
 774       display_author_avatar: false
 775     resumable_upload:
 776       # Max size of upload chunks, e.g. '90MB'
 777       # If null, it will be calculated based on network speed
 778       max_chunk_size: null
 779
 780   menu:
 781     login:
 782       # If you enable only one external auth plugin
 783       # You can automatically redirect your users on this external platform when they click on the login button
 784       redirect_on_single_external_auth: false