config/production.yaml.example

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