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