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