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 rates_limit:
  14   api:
  15     # 50 attempts in 10 seconds
  16     window: 10 seconds
  17     max: 50
  18   login:
  19     # 15 attempts in 5 min
  20     window: 5 minutes
  21     max: 15
  22   signup:
  23     # 2 attempts in 5 min (only succeeded attempts are taken into account)
  24     window: 5 minutes
  25     max: 2
  26   ask_send_email:
  27     # 3 attempts in 5 min
  28     window: 5 minutes
  29     max: 3
  30
  31 # Proxies to trust to get real client IP
  32 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
  33 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
  34 trust_proxy:
  35   - 'loopback'
  36
  37 # Your database name will be database.name OR "peertube"+database.suffix
  38 database:
  39   hostname: 'localhost'
  40   port: 5432
  41   ssl: false
  42   suffix: '_dev'
  43   username: 'peertube'
  44   password: 'peertube'
  45   pool:
  46     max: 5
  47
  48 # Redis server for short time storage
  49 # You can also specify a 'socket' path to a unix socket but first need to
  50 # comment out hostname and port
  51 redis:
  52   hostname: 'localhost'
  53   port: 6379
  54   auth: null
  55   db: 0
  56
  57 # SMTP server to send emails
  58 smtp:
  59   # smtp or sendmail
  60   transport: smtp
  61   # Path to sendmail command. Required if you use sendmail transport
  62   sendmail: null
  63   hostname: null
  64   port: 465 # If you use StartTLS: 587
  65   username: null
  66   password: null
  67   tls: true # If you use StartTLS: false
  68   disable_starttls: false
  69   ca_file: null # Used for self signed certificates
  70   from_address: 'admin@example.com'
  71
  72 email:
  73   body:
  74     signature: "PeerTube"
  75   subject:
  76     prefix: "[PeerTube]"
  77
  78 # From the project root directory
  79 storage:
  80   tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
  81   avatars: 'storage/avatars/'
  82   videos: 'storage/videos/'
  83   streaming_playlists: 'storage/streaming-playlists/'
  84   redundancy: 'storage/redundancy/'
  85   logs: 'storage/logs/'
  86   previews: 'storage/previews/'
  87   thumbnails: 'storage/thumbnails/'
  88   torrents: 'storage/torrents/'
  89   captions: 'storage/captions/'
  90   cache: 'storage/cache/'
  91   plugins: 'storage/plugins/'
  92   # Overridable client files in client/dist/assets/images :
  93   # - logo.svg
  94   # - favicon.png
  95   # - default-playlist.jpg
  96   # - default-avatar-account.png
  97   # - default-avatar-video-channel.png
  98   # - and icons/*.png (PWA)
  99   # Could contain for example assets/images/favicon.png
 100   # If the file exists, peertube will serve it
 101   # If not, peertube will fallback to the default fil
 102   client_overrides: 'storage/client-overrides/'
 103
 104 object_storage:
 105   enabled: false
 106
 107   # Without protocol, will default to HTTPS
 108   endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
 109
 110   region: 'us-east-1'
 111
 112   credentials:
 113     # You can also use AWS_ACCESS_KEY_ID env variable
 114     access_key_id: ''
 115     # You can also use AWS_SECRET_ACCESS_KEY env variable
 116     secret_access_key: ''
 117
 118   # Maximum amount to upload in one request to object storage
 119   max_upload_part: 2GB
 120
 121   streaming_playlists:
 122     bucket_name: 'streaming-playlists'
 123
 124     # Allows setting all buckets to the same value but with a different prefix
 125     prefix: '' # Example: 'streaming-playlists:'
 126
 127     # Base url for object URL generation, scheme and host will be replaced by this URL
 128     # Useful when you want to use a CDN/external proxy
 129     base_url: '' # Example: 'https://mirror.example.com'
 130
 131   # Same settings but for webtorrent videos
 132   videos:
 133     bucket_name: 'videos'
 134     prefix: ''
 135     base_url: ''
 136
 137 log:
 138   level: 'info' # 'debug' | 'info' | 'warn' | 'error'
 139   rotation:
 140     enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
 141     maxFileSize: 12MB
 142     maxFiles: 20
 143   anonymizeIP: false
 144   log_ping_requests: true
 145   prettify_sql: false
 146
 147 trending:
 148   videos:
 149     interval_days: 7 # Compute trending videos for the last x days
 150     algorithms:
 151       enabled:
 152         - 'best' # adaptation of Reddit's 'Best' algorithm (Hot minus History)
 153         - 'hot' # adaptation of Reddit's 'Hot' algorithm
 154         - 'most-viewed' # default, used initially by PeerTube as the trending page
 155         - 'most-liked'
 156       default: 'most-viewed'
 157
 158 # Cache remote videos on your server, to help other instances to broadcast the video
 159 # You can define multiple caches using different sizes/strategies
 160 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
 161 redundancy:
 162   videos:
 163     check_interval: '1 hour' # How often you want to check new videos to cache
 164     strategies: # Just uncomment strategies you want
 165 #      -
 166 #        size: '10GB'
 167 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 168 #        min_lifetime: '48 hours'
 169 #        strategy: 'most-views' # Cache videos that have the most views
 170 #      -
 171 #        size: '10GB'
 172 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 173 #        min_lifetime: '48 hours'
 174 #        strategy: 'trending' # Cache trending videos
 175 #      -
 176 #        size: '10GB'
 177 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 178 #        min_lifetime: '48 hours'
 179 #        strategy: 'recently-added' # Cache recently added videos
 180 #        min_views: 10 # Having at least x views
 181
 182 # Other instances that duplicate your content
 183 remote_redundancy:
 184   videos:
 185     # 'nobody': Do not accept remote redundancies
 186     # 'anybody': Accept remote redundancies from anybody
 187     # 'followings': Accept redundancies from instance followings
 188     accept_from: 'anybody'
 189
 190 csp:
 191   enabled: false
 192   report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
 193   report_uri:
 194
 195 security:
 196   # Set the X-Frame-Options header to help to mitigate clickjacking attacks
 197   frameguard:
 198     enabled: true
 199
 200 tracker:
 201   # If you disable the tracker, you disable the P2P aspect of PeerTube
 202   enabled: true
 203   # Only handle requests on your videos.
 204   # If you set this to false it means you have a public tracker.
 205   # Then, it is possible that clients overload your instance with external torrents
 206   private: true
 207   # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
 208   reject_too_many_announces: false
 209
 210 history:
 211   videos:
 212     # If you want to limit users videos history
 213     # -1 means there is no limitations
 214     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 215     max_age: -1
 216
 217 views:
 218   videos:
 219     # PeerTube creates a database entry every hour for each video to track views over a period of time
 220     # This is used in particular by the Trending page
 221     # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
 222     # -1 means no cleanup
 223     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 224     remote:
 225       max_age: '30 days'
 226
 227 plugins:
 228   # The website PeerTube will ask for available PeerTube plugins and themes
 229   # This is an unmoderated plugin index, so only install plugins/themes you trust
 230   index:
 231     enabled: true
 232     check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
 233     url: 'https://packages.joinpeertube.org'
 234
 235 federation:
 236   videos:
 237     federate_unlisted: false
 238
 239     # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
 240     # It removes objects that do not exist anymore, and potentially fix their URLs
 241     # This setting is opt-in because due to an old bug in PeerTube, remote rates sent by instance before PeerTube 3.0 will be deleted
 242     # We still suggest you to enable this setting even if your users will loose most of their video's likes/dislikes
 243     cleanup_remote_interactions: false
 244
 245 peertube:
 246   check_latest_version:
 247     # Check and notify admins of new PeerTube versions
 248     enabled: true
 249     # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
 250     url: 'https://joinpeertube.org/api/v1/versions.json'
 251
 252 webadmin:
 253   configuration:
 254     edit:
 255       allowed: true
 256
 257 cache:
 258   previews:
 259     size: 500 # Max number of previews you want to cache
 260   captions:
 261     size: 500 # Max number of video captions/subtitles you want to cache
 262   torrents:
 263     size: 500 # Max number of video torrents you want to cache
 264
 265 admin:
 266   # Used to generate the root user at first startup
 267   # And to receive emails from the contact form
 268   email: 'admin@example.com'
 269
 270 contact_form:
 271   enabled: true
 272
 273 signup:
 274   enabled: false
 275   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
 276   minimum_age: 16 # Used to configure the signup form
 277   requires_email_verification: false
 278   filters:
 279     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
 280       whitelist: []
 281       blacklist: []
 282
 283 user:
 284   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
 285   # -1 == unlimited
 286   video_quota: -1
 287   video_quota_daily: -1
 288
 289 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
 290 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
 291 # Please, do not disable transcoding since many uploaded videos will not work
 292 transcoding:
 293   enabled: true
 294
 295   # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
 296   allow_additional_extensions: true
 297
 298   # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
 299   allow_audio_files: true
 300
 301   # Amount of threads used by ffmpeg for 1 transcoding job
 302   threads: 1
 303   # Amount of transcoding jobs to execute in parallel
 304   concurrency: 1
 305
 306   # Choose the transcoding profile
 307   # New profiles can be added by plugins
 308   # Available in core PeerTube: 'default'
 309   profile: 'default'
 310
 311   resolutions: # Only created if the original video has a higher resolution, uses more storage!
 312     0p: false # audio-only (creates mp4 without video stream, always created when enabled)
 313     240p: false
 314     360p: false
 315     480p: false
 316     720p: false
 317     1080p: false
 318     1440p: false
 319     2160p: false
 320
 321   # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
 322   # If you also enabled the hls format, it will multiply videos storage by 2
 323   # If disabled, breaks federation with PeerTube instances < 2.1
 324   webtorrent:
 325     enabled: false
 326
 327   # /!\ Requires ffmpeg >= 4.1
 328   # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
 329   #     * Resolution change is smoother
 330   #     * Faster playback in particular with long videos
 331   #     * More stable playback (less bugs/infinite loading)
 332   # If you also enabled the webtorrent format, it will multiply videos storage by 2
 333   hls:
 334     enabled: true
 335
 336 live:
 337   enabled: false
 338
 339   # Limit lives duration
 340   # -1 == unlimited
 341   max_duration: -1 # For example: '5 hours'
 342
 343   # Limit max number of live videos created on your instance
 344   # -1 == unlimited
 345   max_instance_lives: 20
 346
 347   # Limit max number of live videos created by a user on your instance
 348   # -1 == unlimited
 349   max_user_lives: 3
 350
 351   # Allow your users to save a replay of their live
 352   # PeerTube will transcode segments in a video file
 353   # If the user daily/total quota is reached, PeerTube will stop the live
 354   # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
 355   allow_replay: true
 356
 357   # Your firewall should accept traffic from this port in TCP if you enable live
 358   rtmp:
 359     port: 1935
 360
 361   # Allow to transcode the live streaming in multiple live resolutions
 362   transcoding:
 363     enabled: true
 364     threads: 2
 365
 366     # Choose the transcoding profile
 367     # New profiles can be added by plugins
 368     # Available in core PeerTube: 'default'
 369     profile: 'default'
 370
 371     resolutions:
 372       240p: false
 373       360p: false
 374       480p: false
 375       720p: false
 376       1080p: false
 377       1440p: false
 378       2160p: false
 379
 380 import:
 381   # Add ability for your users to import remote videos (from YouTube, torrent...)
 382   videos:
 383     # Amount of import jobs to execute in parallel
 384     concurrency: 1
 385
 386     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
 387       enabled: false
 388
 389       # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
 390       force_ipv4: false
 391
 392       # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
 393       proxy:
 394         enabled: false
 395         url: ""
 396     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
 397       enabled: false
 398
 399 auto_blacklist:
 400   # New videos automatically blacklisted so moderators can review before publishing
 401   videos:
 402     of_users:
 403       enabled: false
 404
 405 # Instance settings
 406 instance:
 407   name: 'PeerTube'
 408   short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
 409   description: 'Welcome to this PeerTube instance!' # Support markdown
 410   terms: 'No terms for now.' # Support markdown
 411   code_of_conduct: '' # Supports markdown
 412
 413   # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
 414   moderation_information: '' # Supports markdown
 415
 416   # Why did you create this instance?
 417   creation_reason: '' # Supports Markdown
 418
 419   # Who is behind the instance? A single person? A non profit?
 420   administrator: '' # Supports Markdown
 421
 422   # How long do you plan to maintain this instance?
 423   maintenance_lifetime: '' # Supports Markdown
 424
 425   # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
 426   business_model: '' # Supports Markdown
 427
 428   # If you want to explain on what type of hardware your PeerTube instance runs
 429   # Example: "2 vCore, 2GB RAM..."
 430   hardware_information: '' # Supports Markdown
 431
 432   # What are the main languages of your instance? To interact with your users for example
 433   # Uncomment or add the languages you want
 434   # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
 435   languages:
 436 #    - en
 437 #    - es
 438 #    - fr
 439
 440   # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
 441   # Uncomment or add the category ids you want
 442   # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
 443   categories:
 444 #    - 1  # Music
 445 #    - 2  # Films
 446 #    - 3  # Vehicles
 447 #    - 4  # Art
 448 #    - 5  # Sports
 449 #    - 6  # Travels
 450 #    - 7  # Gaming
 451 #    - 8  # People
 452 #    - 9  # Comedy
 453 #    - 10 # Entertainment
 454 #    - 11 # News & Politics
 455 #    - 12 # How To
 456 #    - 13 # Education
 457 #    - 14 # Activism
 458 #    - 15 # Science & Technology
 459 #    - 16 # Animals
 460 #    - 17 # Kids
 461 #    - 18 # Food
 462
 463   default_client_route: '/videos/trending'
 464
 465   # Whether or not the instance is dedicated to NSFW content
 466   # Enabling it will allow other administrators to know that you are mainly federating sensitive content
 467   # Moreover, the NSFW checkbox on video upload will be automatically checked by default
 468   is_nsfw: false
 469   # By default, "do_not_list" or "blur" or "display" NSFW videos
 470   # Could be overridden per user with a setting
 471   default_nsfw_policy: 'do_not_list'
 472
 473   customizations:
 474     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
 475     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
 476   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
 477   robots: |
 478     User-agent: *
 479     Disallow:
 480   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
 481   securitytxt:
 482     "# 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:"
 483
 484 services:
 485   # Cards configuration to format video in Twitter
 486   twitter:
 487     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
 488     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
 489     # If false, we use an image link card that will redirect on your PeerTube instance
 490     # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
 491     whitelisted: false
 492
 493 followers:
 494   instance:
 495     # Allow or not other instances to follow yours
 496     enabled: true
 497     # Whether or not an administrator must manually validate a new follower
 498     manual_approval: false
 499
 500 followings:
 501   instance:
 502     # If you want to automatically follow back new instance followers
 503     # If this option is enabled, use the mute feature instead of deleting followings
 504     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 505     auto_follow_back:
 506       enabled: false
 507
 508     # If you want to automatically follow instances of the public index
 509     # If this option is enabled, use the mute feature instead of deleting followings
 510     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 511     auto_follow_index:
 512       enabled: false
 513       # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
 514       index_url: ''
 515
 516 theme:
 517   default: 'default'
 518
 519 broadcast_message:
 520   enabled: false
 521   message: '' # Support markdown
 522   level: 'info' # 'info' | 'warning' | 'error'
 523   dismissable: false
 524
 525 search:
 526   # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
 527   # If enabled, the associated group will be able to "escape" from the instance follows
 528   # That means they will be able to follow channels, watch videos, list videos of non followed instances
 529   remote_uri:
 530     users: true
 531     anonymous: false
 532
 533   # Use a third party index instead of your local index, only for search results
 534   # Useful to discover content outside of your instance
 535   # If you enable search_index, you must enable remote_uri search for users
 536   # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
 537   # instead of loading the video locally
 538   search_index:
 539     enabled: false
 540     # URL of the search index, that should use the same search API and routes
 541     # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
 542     # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
 543     # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
 544     url: ''
 545     # You can disable local search, so users only use the search index
 546     disable_local_search: false
 547     # If you did not disable local search, you can decide to use the search index by default
 548     is_default_search: false