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