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 tracker:
 106   # If you disable the tracker, you disable the P2P aspect of PeerTube
 107   enabled: true
 108   # Only handle requests on your videos.
 109   # If you set this to false it means you have a public tracker.
 110   # Then, it is possible that clients overload your instance with external torrents
 111   private: true
 112   # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
 113   reject_too_many_announces: false
 114
 115 history:
 116   videos:
 117     # If you want to limit users videos history
 118     # -1 means there is no limitations
 119     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 120     max_age: -1
 121
 122 views:
 123   videos:
 124     # PeerTube creates a database entry every hour for each video to track views over a period of time
 125     # This is used in particular by the Trending page
 126     # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
 127     # -1 means no cleanup
 128     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 129     remote:
 130       max_age: -1
 131
 132
 133 ###############################################################################
 134 #
 135 # From this point, all the following keys can be overridden by the web interface
 136 # (local-production.json file). If you need to change some values, prefer to
 137 # use the web interface because the configuration will be automatically
 138 # reloaded without any need to restart PeerTube.
 139 #
 140 # /!\ If you already have a local-production.json file, the modification of the
 141 # following keys will have no effect /!\.
 142 #
 143 ###############################################################################
 144
 145 cache:
 146   previews:
 147     size: 500 # Max number of previews you want to cache
 148   captions:
 149     size: 500 # Max number of video captions/subtitles you want to cache
 150
 151 admin:
 152   # Used to generate the root user at first startup
 153   # And to receive emails from the contact form
 154   email: 'admin@example.com'
 155
 156 contact_form:
 157   enabled: true
 158
 159 signup:
 160   enabled: false
 161   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
 162   requires_email_verification: false
 163   filters:
 164     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
 165       whitelist: []
 166       blacklist: []
 167
 168 user:
 169   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
 170   # -1 == unlimited
 171   video_quota: -1
 172   video_quota_daily: -1
 173
 174 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
 175 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
 176 # Please, do not disable transcoding since many uploaded videos will not work
 177 transcoding:
 178   enabled: true
 179   # Allow your users to upload .mkv, .mov, .avi, .flv videos
 180   allow_additional_extensions: true
 181   threads: 1
 182   resolutions: # Only created if the original video has a higher resolution, uses more storage!
 183     240p: false
 184     360p: false
 185     480p: false
 186     720p: false
 187     1080p: false
 188   # /!\ EXPERIMENTAL /!\
 189   # /!\ Requires ffmpeg >= 4
 190   # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
 191   #     * Resolution change is smoother
 192   #     * Faster playback in particular with long videos
 193   #     * More stable playback (less bugs/infinite loading)
 194   # /!\ Multiply videos storage by 2 /!\
 195   hls:
 196     enabled: false
 197
 198 import:
 199   # Add ability for your users to import remote videos (from YouTube, torrent...)
 200   videos:
 201     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
 202       enabled: false
 203     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
 204       enabled: false
 205
 206 auto_blacklist:
 207   # New videos automatically blacklisted so moderators can review before publishing
 208   videos:
 209     of_users:
 210       enabled: false
 211
 212 # Instance settings
 213 instance:
 214   name: 'PeerTube'
 215   short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
 216   description: '' # Support markdown
 217   terms: '' # Support markdown
 218   default_client_route: '/videos/trending'
 219   # Whether or not the instance is dedicated to NSFW content
 220   # Enabling it will allow other administrators to know that you are mainly federating sensitive content
 221   # Moreover, the NSFW checkbox on video upload will be automatically checked by default
 222   is_nsfw: false
 223   # By default, "do_not_list" or "blur" or "display" NSFW videos
 224   # Could be overridden per user with a setting
 225   default_nsfw_policy: 'do_not_list'
 226   customizations:
 227     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
 228     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
 229   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
 230   robots: |
 231     User-agent: *
 232     Disallow:
 233   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
 234   securitytxt:
 235     "# 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:"
 236
 237 services:
 238   # You can provide a reporting endpoint for Content Security Policy violations
 239   csp-logger:
 240   # Cards configuration to format video in Twitter
 241   twitter:
 242     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
 243     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
 244     # If false, we use an image link card that will redirect on your PeerTube instance
 245     # Test on https://cards-dev.twitter.com/validator to see if you are whitelisted
 246     whitelisted: false
 247
 248 followers:
 249   instance:
 250     # Allow or not other instances to follow yours
 251     enabled: true
 252     # Whether or not an administrator must manually validate a new follower
 253     manual_approval: false