config/default.yaml

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