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