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     check_interval: '1 hour' # How often you want to check new videos to cache
  75     strategies:
  76 #      -
  77 #        size: '10GB'
  78 #        strategy: 'most-views' # Cache videos that have the most views
  79 #      -
  80 #        size: '10GB'
  81 #        strategy: 'trending' # Cache trending videos
  82 #      -
  83 #        size: '10GB'
  84 #        strategy: 'recently-added' # Cache recently added videos
  85 #        minViews: 10 # Having at least x views
  86
  87 cache:
  88   previews:
  89     size: 500 # Max number of previews you want to cache
  90   captions:
  91     size: 500 # Max number of video captions/subtitles you want to cache
  92
  93 admin:
  94   email: 'admin@example.com' # Your personal email as administrator
  95
  96 signup:
  97   enabled: false
  98   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
  99   requires_email_verification: false
 100   filters:
 101     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
 102       whitelist: []
 103       blacklist: []
 104
 105 user:
 106   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
 107   # -1 == unlimited
 108   video_quota: -1
 109   video_quota_daily: -1
 110
 111 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
 112 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
 113 # Please, do not disable transcoding since many uploaded videos will not work
 114 transcoding:
 115   enabled: true
 116   threads: 1
 117   resolutions: # Only created if the original video has a higher resolution, uses more storage!
 118     240p: false
 119     360p: false
 120     480p: false
 121     720p: false
 122     1080p: false
 123
 124 import:
 125   # Add ability for your users to import remote videos (from YouTube, torrent...)
 126   videos:
 127     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
 128       enabled: false
 129     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
 130       enabled: false
 131
 132 instance:
 133   name: 'PeerTube'
 134   short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
 135   description: 'Welcome to this PeerTube instance!' # Support markdown
 136   terms: 'No terms for now.' # Support markdown
 137   default_client_route: '/videos/trending'
 138   # By default, "do_not_list" or "blur" or "display" NSFW videos
 139   # Could be overridden per user with a setting
 140   default_nsfw_policy: 'do_not_list'
 141   customizations:
 142     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
 143     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
 144   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
 145   robots: |
 146     User-agent: *
 147     Disallow:
 148   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
 149   securitytxt:
 150     "# 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:"
 151
 152 services:
 153   # Cards configuration to format video in Twitter
 154   twitter:
 155     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
 156     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
 157     # If false, we use an image link card that will redirect on your PeerTube instance
 158     # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
 159     whitelisted: false