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