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