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 rates_limit:
  12   login:
  13     # 15 attempts in 5 min
  14     window: 5 minutes
  15     max: 15
  16   ask_send_email:
  17     # 3 attempts in 5 min
  18     window: 5 minutes
  19     max: 3
  20
  21 # Proxies to trust to get real client IP
  22 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
  23 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
  24 trust_proxy:
  25   - 'loopback'
  26
  27 # Your database name will be "peertube"+database.suffix
  28 database:
  29   hostname: 'localhost'
  30   port: 5432
  31   suffix: '_prod'
  32   username: 'peertube'
  33   password: 'peertube'
  34   pool:
  35     max: 5
  36
  37 # Redis server for short time storage
  38 # You can also specify a 'socket' path to a unix socket but first need to
  39 # comment out hostname and port
  40 redis:
  41   hostname: 'localhost'
  42   port: 6379
  43   auth: null
  44   db: 0
  45
  46 # SMTP server to send emails
  47 smtp:
  48   hostname: null
  49   port: 465 # If you use StartTLS: 587
  50   username: null
  51   password: null
  52   tls: true # If you use StartTLS: false
  53   disable_starttls: false
  54   ca_file: null # Used for self signed certificates
  55   from_address: 'admin@example.com'
  56
  57 email:
  58   body:
  59     signature: "PeerTube"
  60   object:
  61     prefix: "[PeerTube]"
  62
  63 # From the project root directory
  64 storage:
  65   tmp: '/var/www/peertube/storage/tmp/' # Used to download data (imports etc), store uploaded files before processing...
  66   avatars: '/var/www/peertube/storage/avatars/'
  67   videos: '/var/www/peertube/storage/videos/'
  68   streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
  69   redundancy: '/var/www/peertube/storage/videos/'
  70   logs: '/var/www/peertube/storage/logs/'
  71   previews: '/var/www/peertube/storage/previews/'
  72   thumbnails: '/var/www/peertube/storage/thumbnails/'
  73   torrents: '/var/www/peertube/storage/torrents/'
  74   captions: '/var/www/peertube/storage/captions/'
  75   cache: '/var/www/peertube/storage/cache/'
  76
  77 log:
  78   level: 'info' # debug/info/warning/error
  79
  80 search:
  81   # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
  82   # If enabled, the associated group will be able to "escape" from the instance follows
  83   # That means they will be able to follow channels, watch videos, list videos of non followed instances
  84   remote_uri:
  85     users: true
  86     anonymous: false
  87
  88 trending:
  89   videos:
  90     interval_days: 7 # Compute trending videos for the last x days
  91
  92 # Cache remote videos on your server, to help other instances to broadcast the video
  93 # You can define multiple caches using different sizes/strategies
  94 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
  95 redundancy:
  96   videos:
  97     check_interval: '1 hour' # How often you want to check new videos to cache
  98     strategies: # Just uncomment strategies you want
  99 #      -
 100 #        size: '10GB'
 101 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 102 #        min_lifetime: '48 hours'
 103 #        strategy: 'most-views' # Cache videos that have the most views
 104 #      -
 105 #        size: '10GB'
 106 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 107 #        min_lifetime: '48 hours'
 108 #        strategy: 'trending' # Cache trending videos
 109 #      -
 110 #        size: '10GB'
 111 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 112 #        min_lifetime: '48 hours'
 113 #        strategy: 'recently-added' # Cache recently added videos
 114 #        min_views: 10 # Having at least x views
 115
 116 csp:
 117   enabled: false
 118   report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
 119   report_uri:
 120
 121 tracker:
 122   # If you disable the tracker, you disable the P2P aspect of PeerTube
 123   enabled: true
 124   # Only handle requests on your videos.
 125   # If you set this to false it means you have a public tracker.
 126   # Then, it is possible that clients overload your instance with external torrents
 127   private: true
 128   # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
 129   reject_too_many_announces: false
 130
 131 history:
 132   videos:
 133     # If you want to limit users videos history
 134     # -1 means there is no limitations
 135     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 136     max_age: -1
 137
 138 views:
 139   videos:
 140     # PeerTube creates a database entry every hour for each video to track views over a period of time
 141     # This is used in particular by the Trending page
 142     # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
 143     # -1 means no cleanup
 144     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 145     remote:
 146       max_age: -1
 147
 148
 149 ###############################################################################
 150 #
 151 # From this point, all the following keys can be overridden by the web interface
 152 # (local-production.json file). If you need to change some values, prefer to
 153 # use the web interface because the configuration will be automatically
 154 # reloaded without any need to restart PeerTube.
 155 #
 156 # /!\ If you already have a local-production.json file, the modification of the
 157 # following keys will have no effect /!\.
 158 #
 159 ###############################################################################
 160
 161 cache:
 162   previews:
 163     size: 500 # Max number of previews you want to cache
 164   captions:
 165     size: 500 # Max number of video captions/subtitles you want to cache
 166
 167 admin:
 168   # Used to generate the root user at first startup
 169   # And to receive emails from the contact form
 170   email: 'admin@example.com'
 171
 172 contact_form:
 173   enabled: true
 174
 175 signup:
 176   enabled: false
 177   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
 178   requires_email_verification: false
 179   filters:
 180     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
 181       whitelist: []
 182       blacklist: []
 183
 184 user:
 185   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
 186   # -1 == unlimited
 187   video_quota: -1
 188   video_quota_daily: -1
 189
 190 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
 191 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
 192 # Please, do not disable transcoding since many uploaded videos will not work
 193 transcoding:
 194   enabled: true
 195   # Allow your users to upload .mkv, .mov, .avi, .flv videos
 196   allow_additional_extensions: true
 197   # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
 198   allow_audio_files: true
 199   threads: 1
 200   resolutions: # Only created if the original video has a higher resolution, uses more storage!
 201     240p: false
 202     360p: false
 203     480p: false
 204     720p: false
 205     1080p: false
 206     2160p: false
 207   # /!\ EXPERIMENTAL /!\
 208   # /!\ Requires ffmpeg >= 4
 209   # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
 210   #     * Resolution change is smoother
 211   #     * Faster playback in particular with long videos
 212   #     * More stable playback (less bugs/infinite loading)
 213   # /!\ Multiplies videos storage by 2 /!\
 214   hls:
 215     enabled: false
 216
 217 import:
 218   # Add ability for your users to import remote videos (from YouTube, torrent...)
 219   videos:
 220     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
 221       enabled: false
 222     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
 223       enabled: false
 224
 225 auto_blacklist:
 226   # New videos automatically blacklisted so moderators can review before publishing
 227   videos:
 228     of_users:
 229       enabled: false
 230
 231 # Instance settings
 232 instance:
 233   name: 'PeerTube'
 234   short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
 235   description: '' # Support markdown
 236   terms: '' # Support markdown
 237   default_client_route: '/videos/trending'
 238   # Whether or not the instance is dedicated to NSFW content
 239   # Enabling it will allow other administrators to know that you are mainly federating sensitive content
 240   # Moreover, the NSFW checkbox on video upload will be automatically checked by default
 241   is_nsfw: false
 242   # By default, "do_not_list" or "blur" or "display" NSFW videos
 243   # Could be overridden per user with a setting
 244   default_nsfw_policy: 'do_not_list'
 245   customizations:
 246     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
 247     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
 248   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
 249   robots: |
 250     User-agent: *
 251     Disallow:
 252   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
 253   securitytxt:
 254     "# 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:"
 255
 256 services:
 257   # Cards configuration to format video in Twitter
 258   twitter:
 259     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
 260     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
 261     # If false, we use an image link card that will redirect on your PeerTube instance
 262     # Test on https://cards-dev.twitter.com/validator to see if you are whitelisted
 263     whitelisted: false
 264
 265 followers:
 266   instance:
 267     # Allow or not other instances to follow yours
 268     enabled: true
 269     # Whether or not an administrator must manually validate a new follower
 270     manual_approval: false