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