config/production.yaml.example

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