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   # smtp or sendmail
  57   transport: smtp
  58   # Path to sendmail command. Required if you use sendmail transport
  59   sendmail: null
  60   hostname: null
  61   port: 465 # If you use StartTLS: 587
  62   username: null
  63   password: null
  64   tls: true # If you use StartTLS: false
  65   disable_starttls: false
  66   ca_file: null # Used for self signed certificates
  67   from_address: 'admin@example.com'
  68
  69 email:
  70   body:
  71     signature: "PeerTube"
  72   subject:
  73     prefix: "[PeerTube]"
  74
  75 # From the project root directory
  76 storage:
  77   tmp: '/var/www/peertube/storage/tmp/' # Use to download data (imports etc), store uploaded files before processing...
  78   avatars: '/var/www/peertube/storage/avatars/'
  79   videos: '/var/www/peertube/storage/videos/'
  80   streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
  81   redundancy: '/var/www/peertube/storage/redundancy/'
  82   logs: '/var/www/peertube/storage/logs/'
  83   previews: '/var/www/peertube/storage/previews/'
  84   thumbnails: '/var/www/peertube/storage/thumbnails/'
  85   torrents: '/var/www/peertube/storage/torrents/'
  86   captions: '/var/www/peertube/storage/captions/'
  87   cache: '/var/www/peertube/storage/cache/'
  88   plugins: '/var/www/peertube/storage/plugins/'
  89
  90 log:
  91   level: 'info' # debug/info/warning/error
  92   rotation:
  93     enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
  94     maxFileSize: 12MB
  95     maxFiles: 20
  96   anonymizeIP: false
  97
  98 search:
  99   # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
 100   # If enabled, the associated group will be able to "escape" from the instance follows
 101   # That means they will be able to follow channels, watch videos, list videos of non followed instances
 102   remote_uri:
 103     users: true
 104     anonymous: false
 105
 106 trending:
 107   videos:
 108     interval_days: 7 # Compute trending videos for the last x days
 109
 110 # Cache remote videos on your server, to help other instances to broadcast the video
 111 # You can define multiple caches using different sizes/strategies
 112 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
 113 redundancy:
 114   videos:
 115     check_interval: '1 hour' # How often you want to check new videos to cache
 116     strategies: # Just uncomment strategies you want
 117 #      -
 118 #        size: '10GB'
 119 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 120 #        min_lifetime: '48 hours'
 121 #        strategy: 'most-views' # Cache videos that have the most views
 122 #      -
 123 #        size: '10GB'
 124 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 125 #        min_lifetime: '48 hours'
 126 #        strategy: 'trending' # Cache trending videos
 127 #      -
 128 #        size: '10GB'
 129 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
 130 #        min_lifetime: '48 hours'
 131 #        strategy: 'recently-added' # Cache recently added videos
 132 #        min_views: 10 # Having at least x views
 133
 134 # Other instances that duplicate your content
 135 remote_redundancy:
 136   videos:
 137     # 'nobody': Do not accept remote redundancies
 138     # 'anybody': Accept remote redundancies from anybody
 139     # 'followings': Accept redundancies from instance followings
 140     accept_from: 'anybody'
 141
 142 csp:
 143   enabled: false
 144   report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
 145   report_uri:
 146
 147 tracker:
 148   # If you disable the tracker, you disable the P2P aspect of PeerTube
 149   enabled: true
 150   # Only handle requests on your videos.
 151   # If you set this to false it means you have a public tracker.
 152   # Then, it is possible that clients overload your instance with external torrents
 153   private: true
 154   # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
 155   reject_too_many_announces: false
 156
 157 history:
 158   videos:
 159     # If you want to limit users videos history
 160     # -1 means there is no limitations
 161     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 162     max_age: -1
 163
 164 views:
 165   videos:
 166     # PeerTube creates a database entry every hour for each video to track views over a period of time
 167     # This is used in particular by the Trending page
 168     # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
 169     # -1 means no cleanup
 170     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
 171     remote:
 172       max_age: -1
 173
 174 plugins:
 175   # The website PeerTube will ask for available PeerTube plugins and themes
 176   # This is an unmoderated plugin index, so only install plugins/themes you trust
 177   index:
 178     enabled: true
 179     check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
 180     url: 'https://packages.joinpeertube.org'
 181
 182 federation:
 183   videos:
 184     federate_unlisted: true
 185
 186
 187 ###############################################################################
 188 #
 189 # From this point, all the following keys can be overridden by the web interface
 190 # (local-production.json file). If you need to change some values, prefer to
 191 # use the web interface because the configuration will be automatically
 192 # reloaded without any need to restart PeerTube.
 193 #
 194 # /!\ If you already have a local-production.json file, the modification of the
 195 # following keys will have no effect /!\.
 196 #
 197 ###############################################################################
 198
 199 cache:
 200   previews:
 201     size: 500 # Max number of previews you want to cache
 202   captions:
 203     size: 500 # Max number of video captions/subtitles you want to cache
 204
 205 admin:
 206   # Used to generate the root user at first startup
 207   # And to receive emails from the contact form
 208   email: 'admin@example.com'
 209
 210 contact_form:
 211   enabled: true
 212
 213 signup:
 214   enabled: false
 215   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
 216   requires_email_verification: false
 217   filters:
 218     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
 219       whitelist: []
 220       blacklist: []
 221
 222 user:
 223   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
 224   # -1 == unlimited
 225   video_quota: -1
 226   video_quota_daily: -1
 227
 228 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
 229 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
 230 # Please, do not disable transcoding since many uploaded videos will not work
 231 transcoding:
 232   enabled: true
 233   # Allow your users to upload .mkv, .mov, .avi, .flv videos
 234   allow_additional_extensions: true
 235   # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
 236   allow_audio_files: true
 237   threads: 1
 238   resolutions: # Only created if the original video has a higher resolution, uses more storage!
 239     0p: false # audio-only (creates mp4 without video stream, always created when enabled)
 240     240p: false
 241     360p: false
 242     480p: false
 243     720p: false
 244     1080p: false
 245     2160p: false
 246
 247   # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
 248   # If you also enabled the hls format, it will multiply videos storage by 2
 249   # If disabled, breaks federation with PeerTube instances < 2.1
 250   webtorrent:
 251     enabled: true
 252
 253   # /!\ Requires ffmpeg >= 4.1
 254   # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
 255   #     * Resolution change is smoother
 256   #     * Faster playback in particular with long videos
 257   #     * More stable playback (less bugs/infinite loading)
 258   # If you also enabled the webtorrent format, it will multiply videos storage by 2
 259   hls:
 260     enabled: false
 261
 262 import:
 263   # Add ability for your users to import remote videos (from YouTube, torrent...)
 264   videos:
 265     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
 266       enabled: false
 267       # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
 268       proxy:
 269         enabled: false
 270         url: ""
 271     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
 272       enabled: false
 273
 274 auto_blacklist:
 275   # New videos automatically blacklisted so moderators can review before publishing
 276   videos:
 277     of_users:
 278       enabled: false
 279
 280 # Instance settings
 281 instance:
 282   name: 'PeerTube'
 283   short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
 284   description: 'Welcome to this PeerTube instance!' # Support markdown
 285   terms: 'No terms for now.' # Support markdown
 286   code_of_conduct: '' # Supports markdown
 287
 288   # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
 289   moderation_information: '' # Supports markdown
 290
 291   # Why did you create this instance?
 292   creation_reason: ''
 293
 294   # Who is behind the instance? A single person? A non profit?
 295   administrator: ''
 296
 297   # How long do you plan to maintain this instance?
 298   maintenance_lifetime: ''
 299
 300   # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
 301   business_model: ''
 302
 303   # If you want to explain on what type of hardware your PeerTube instance runs
 304   # Example: "2 vCore, 2GB RAM..."
 305   hardware_information: '' # Supports Markdown
 306
 307   # What are the main languages of your instance? To interact with your users for example
 308   # Uncomment or add the languages you want
 309   # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
 310   languages:
 311 #    - en
 312 #    - es
 313 #    - fr
 314
 315   # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
 316   # Uncomment or add the category ids you want
 317   # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
 318   categories:
 319 #    - 1  # Music
 320 #    - 2  # Films
 321 #    - 3  # Vehicles
 322 #    - 4  # Art
 323 #    - 5  # Sports
 324 #    - 6  # Travels
 325 #    - 7  # Gaming
 326 #    - 8  # People
 327 #    - 9  # Comedy
 328 #    - 10 # Entertainment
 329 #    - 11 # News & Politics
 330 #    - 12 # How To
 331 #    - 13 # Education
 332 #    - 14 # Activism
 333 #    - 15 # Science & Technology
 334 #    - 16 # Animals
 335 #    - 17 # Kids
 336 #    - 18 # Food
 337
 338   default_client_route: '/videos/trending'
 339
 340   # Whether or not the instance is dedicated to NSFW content
 341   # Enabling it will allow other administrators to know that you are mainly federating sensitive content
 342   # Moreover, the NSFW checkbox on video upload will be automatically checked by default
 343   is_nsfw: false
 344   # By default, "do_not_list" or "blur" or "display" NSFW videos
 345   # Could be overridden per user with a setting
 346   default_nsfw_policy: 'do_not_list'
 347
 348   customizations:
 349     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
 350     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
 351   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
 352   robots: |
 353     User-agent: *
 354     Disallow:
 355   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
 356   securitytxt:
 357     "# 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:"
 358
 359 services:
 360   # Cards configuration to format video in Twitter
 361   twitter:
 362     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
 363     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
 364     # If false, we use an image link card that will redirect on your PeerTube instance
 365     # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
 366     whitelisted: false
 367
 368 followers:
 369   instance:
 370     # Allow or not other instances to follow yours
 371     enabled: true
 372     # Whether or not an administrator must manually validate a new follower
 373     manual_approval: false
 374
 375 followings:
 376   instance:
 377     # If you want to automatically follow back new instance followers
 378     # If this option is enabled, use the mute feature instead of deleting followings
 379     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 380     auto_follow_back:
 381       enabled: false
 382
 383     # If you want to automatically follow instances of the public index
 384     # If this option is enabled, use the mute feature instead of deleting followings
 385     # /!\ Don't enable this if you don't have a reactive moderation team /!\
 386     auto_follow_index:
 387       enabled: false
 388       # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
 389       index_url: ''
 390
 391 theme:
 392   default: 'default'
 393
 394 broadcast_message:
 395   enabled: false
 396   message: '' # Support markdown
 397   level: 'info' # 'info' | 'warning' | 'error'
 398   dismissable: false