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