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