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