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