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 webserver:
   8   https: false
   9   hostname: 'localhost'
  10   port: 9000
  11
  12 # Proxies to trust to get real client IP
  13 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
  14 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
  15 trust_proxy:
  16   - 'loopback'
  17
  18 # Your database name will be "peertube"+database.suffix
  19 database:
  20   hostname: 'localhost'
  21   port: 5432
  22   suffix: '_dev'
  23   username: 'peertube'
  24   password: 'peertube'
  25   pool:
  26     max: 5
  27
  28 # You can also specify a 'socket' path to a unix socket but first need to
  29 # comment out hostname and port
  30 redis:
  31   hostname: 'localhost'
  32   port: 6379
  33   auth: null
  34   db: 0
  35
  36 smtp:
  37   hostname: null
  38   port: 465
  39   username: null
  40   password: null
  41   tls: true
  42   disable_starttls: false
  43   ca_file: null # Used for self signed certificates
  44   from_address: 'admin@example.com'
  45
  46 # From the project root directory
  47 storage:
  48   avatars: 'storage/avatars/'
  49   videos: 'storage/videos/'
  50   logs: 'storage/logs/'
  51   previews: 'storage/previews/'
  52   thumbnails: 'storage/thumbnails/'
  53   torrents: 'storage/torrents/'
  54   captions: 'storage/captions/'
  55   cache: 'storage/cache/'
  56
  57 log:
  58   level: 'info' # debug/info/warning/error
  59
  60 search:
  61   remote_uri: # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
  62     users: true
  63     anonymous: false
  64
  65 trending:
  66   videos:
  67     interval_days: 7 # Compute trending videos for the last x days
  68
  69 # Cache remote videos on your server, to help other instances to broadcast the video
  70 # You can define multiple caches using different sizes/strategies
  71 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
  72 redundancy:
  73   videos:
  74     strategies:
  75 #      -
  76 #        size: '10GB'
  77 #        strategy: 'most-views' # Cache videos that have the most views
  78 #      -
  79 #        size: '10GB'
  80 #        strategy: 'trending' # Cache trending videos
  81 #      -
  82 #        size: '10GB'
  83 #        strategy: 'recently-added' # Cache recently added videos
  84 #        minViews: 10 # Having at least x views
  85
  86 cache:
  87   previews:
  88     size: 500 # Max number of previews you want to cache
  89   captions:
  90     size: 500 # Max number of video captions/subtitles you want to cache
  91
  92 admin:
  93   email: 'admin@example.com' # Your personal email as administrator
  94
  95 signup:
  96   enabled: false
  97   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
  98   requires_email_verification: false
  99   filters:
 100     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
 101       whitelist: []
 102       blacklist: []
 103
 104 user:
 105   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
 106   # -1 == unlimited
 107   video_quota: -1
 108   video_quota_daily: -1
 109
 110 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
 111 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
 112 # Please, do not disable transcoding since many uploaded videos will not work
 113 transcoding:
 114   enabled: true
 115   threads: 1
 116   resolutions: # Only created if the original video has a higher resolution, uses more storage!
 117     240p: false
 118     360p: false
 119     480p: false
 120     720p: false
 121     1080p: false
 122
 123 import:
 124   # Add ability for your users to import remote videos (from YouTube, torrent...)
 125   videos:
 126     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
 127       enabled: false
 128     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
 129       enabled: false
 130
 131 instance:
 132   name: 'PeerTube'
 133   short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
 134   description: 'Welcome to this PeerTube instance!' # Support markdown
 135   terms: 'No terms for now.' # Support markdown
 136   default_client_route: '/videos/trending'
 137   # By default, "do_not_list" or "blur" or "display" NSFW videos
 138   # Could be overridden per user with a setting
 139   default_nsfw_policy: 'do_not_list'
 140   customizations:
 141     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
 142     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
 143   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
 144   robots: |
 145     User-agent: *
 146     Disallow:
 147   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
 148   securitytxt:
 149     "# 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:"
 150
 151 services:
 152   # Cards configuration to format video in Twitter
 153   twitter:
 154     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
 155     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
 156     # If false, we use an image link card that will redirect on your PeerTube instance
 157     # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
 158     whitelisted: false