config/default.yaml

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