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