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