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   tmp: 'storage/tmp/' # Used to download data (imports etc), store uploaded files before processing...
  49   avatars: 'storage/avatars/'
  50   videos: 'storage/videos/'
  51   redundancy: 'storage/redundancy/'
  52   logs: 'storage/logs/'
  53   previews: 'storage/previews/'
  54   thumbnails: 'storage/thumbnails/'
  55   torrents: 'storage/torrents/'
  56   captions: 'storage/captions/'
  57   cache: 'storage/cache/'
  58
  59 log:
  60   level: 'info' # debug/info/warning/error
  61
  62 search:
  63   # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
  64   # If enabled, the associated group will be able to "escape" from the instance follows
  65   # That means they will be able to follow channels, watch videos, list videos of non followed instances
  66   remote_uri:
  67     users: true
  68     anonymous: false
  69
  70 trending:
  71   videos:
  72     interval_days: 7 # Compute trending videos for the last x days
  73
  74 # Cache remote videos on your server, to help other instances to broadcast the video
  75 # You can define multiple caches using different sizes/strategies
  76 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
  77 redundancy:
  78   videos:
  79     check_interval: '1 hour' # How often you want to check new videos to cache
  80     strategies: # Just uncomment strategies you want
  81 #      -
  82 #        size: '10GB'
  83 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
  84 #        min_lifetime: '48 hours'
  85 #        strategy: 'most-views' # Cache videos that have the most views
  86 #      -
  87 #        size: '10GB'
  88 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
  89 #        min_lifetime: '48 hours'
  90 #        strategy: 'trending' # Cache trending videos
  91 #      -
  92 #        size: '10GB'
  93 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
  94 #        min_lifetime: '48 hours'
  95 #        strategy: 'recently-added' # Cache recently added videos
  96 #        min_views: 10 # Having at least x views
  97
  98 cache:
  99   previews:
 100     size: 500 # Max number of previews you want to cache
 101   captions:
 102     size: 500 # Max number of video captions/subtitles you want to cache
 103
 104 admin:
 105   email: 'admin@example.com' # Your personal email as administrator
 106
 107 signup:
 108   enabled: false
 109   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
 110   requires_email_verification: false
 111   filters:
 112     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
 113       whitelist: []
 114       blacklist: []
 115
 116 user:
 117   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
 118   # -1 == unlimited
 119   video_quota: -1
 120   video_quota_daily: -1
 121
 122 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
 123 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
 124 # Please, do not disable transcoding since many uploaded videos will not work
 125 transcoding:
 126   enabled: true
 127   # Allow your users to upload .mkv, .mov, .avi, .flv videos
 128   allow_additional_extensions: true
 129   threads: 1
 130   resolutions: # Only created if the original video has a higher resolution, uses more storage!
 131     240p: false
 132     360p: false
 133     480p: false
 134     720p: false
 135     1080p: false
 136
 137 import:
 138   # Add ability for your users to import remote videos (from YouTube, torrent...)
 139   videos:
 140     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
 141       enabled: false
 142     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
 143       enabled: false
 144
 145 instance:
 146   name: 'PeerTube'
 147   short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
 148   description: 'Welcome to this PeerTube instance!' # Support markdown
 149   terms: 'No terms for now.' # Support markdown
 150   default_client_route: '/videos/trending'
 151   # By default, "do_not_list" or "blur" or "display" NSFW videos
 152   # Could be overridden per user with a setting
 153   default_nsfw_policy: 'do_not_list'
 154   customizations:
 155     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
 156     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
 157   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
 158   robots: |
 159     User-agent: *
 160     Disallow:
 161   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
 162   securitytxt:
 163     "# 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:"
 164
 165 services:
 166   # You can provide a reporting endpoint for Content Security Policy violations
 167   csp-logger:
 168   # Cards configuration to format video in Twitter
 169   twitter:
 170     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
 171     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
 172     # If false, we use an image link card that will redirect on your PeerTube instance
 173     # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
 174     whitelisted: false