5 # Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
8 hostname: 'example.com'
13 # 50 attempts in 10 seconds
17 # 15 attempts in 5 min
21 # 2 attempts in 5 min (only succeeded attempts are taken into account)
29 # Proxies to trust to get real client IP
30 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
31 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
35 # Your database name will be database.name OR "peertube"+database.suffix
46 # Redis server for short time storage
47 # You can also specify a 'socket' path to a unix socket but first need to
48 # comment out hostname and port
55 # SMTP server to send emails
59 # Path to sendmail command. Required if you use sendmail transport
62 port: 465 # If you use StartTLS: 587
65 tls: true # If you use StartTLS: false
66 disable_starttls: false
67 ca_file: null # Used for self signed certificates
68 from_address: 'admin@example.com'
76 # From the project root directory
78 tmp: '/var/www/peertube/storage/tmp/' # Use to download data (imports etc), store uploaded files before processing...
79 avatars: '/var/www/peertube/storage/avatars/'
80 videos: '/var/www/peertube/storage/videos/'
81 streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
82 redundancy: '/var/www/peertube/storage/redundancy/'
83 logs: '/var/www/peertube/storage/logs/'
84 previews: '/var/www/peertube/storage/previews/'
85 thumbnails: '/var/www/peertube/storage/thumbnails/'
86 torrents: '/var/www/peertube/storage/torrents/'
87 captions: '/var/www/peertube/storage/captions/'
88 cache: '/var/www/peertube/storage/cache/'
89 plugins: '/var/www/peertube/storage/plugins/'
90 # Overridable client files : logo.svg, favicon.png and icons/*.png (PWA) in client/dist/assets/images
91 # Could contain for example assets/images/favicon.png
92 # If the file exists, peertube will serve it
93 # If not, peertube will fallback to the default fil
94 client_overrides: '/var/www/peertube/storage/client-overrides/'
97 level: 'info' # debug/info/warning/error
99 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
103 log_ping_requests: true
108 interval_days: 7 # Compute trending videos for the last x days
111 - 'best' # adaptation of Reddit's 'Best' algorithm (Hot minus History)
112 - 'hot' # adaptation of Reddit's 'Hot' algorithm
113 - 'most-viewed' # default, used initially by PeerTube as the trending page
115 default: 'most-viewed'
117 # Cache remote videos on your server, to help other instances to broadcast the video
118 # You can define multiple caches using different sizes/strategies
119 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
122 check_interval: '1 hour' # How often you want to check new videos to cache
123 strategies: # Just uncomment strategies you want
126 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
127 # min_lifetime: '48 hours'
128 # strategy: 'most-views' # Cache videos that have the most views
131 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
132 # min_lifetime: '48 hours'
133 # strategy: 'trending' # Cache trending videos
136 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
137 # min_lifetime: '48 hours'
138 # strategy: 'recently-added' # Cache recently added videos
139 # min_views: 10 # Having at least x views
141 # Other instances that duplicate your content
144 # 'nobody': Do not accept remote redundancies
145 # 'anybody': Accept remote redundancies from anybody
146 # 'followings': Accept redundancies from instance followings
147 accept_from: 'anybody'
151 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
155 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
160 # If you disable the tracker, you disable the P2P aspect of PeerTube
162 # Only handle requests on your videos.
163 # If you set this to false it means you have a public tracker.
164 # Then, it is possible that clients overload your instance with external torrents
166 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
167 reject_too_many_announces: false
171 # If you want to limit users videos history
172 # -1 means there is no limitations
173 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
178 # PeerTube creates a database entry every hour for each video to track views over a period of time
179 # This is used in particular by the Trending page
180 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
181 # -1 means no cleanup
182 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
187 # The website PeerTube will ask for available PeerTube plugins and themes
188 # This is an unmoderated plugin index, so only install plugins/themes you trust
191 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
192 url: 'https://packages.joinpeertube.org'
196 federate_unlisted: false
198 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
199 # It removes objects that do not exist anymore, and potentially fix their URLs
200 # This setting is opt-in because due to an old bug in PeerTube, remote rates sent by instance before PeerTube 3.0 will be deleted
201 # We still suggest you to enable this setting even if your users will loose most of their video's likes/dislikes
202 cleanup_remote_interactions: false
205 check_latest_version:
206 # Check and notify admins of new PeerTube versions
208 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
209 url: 'https://joinpeertube.org/api/v1/versions.json'
211 ###############################################################################
213 # From this point, all the following keys can be overridden by the web interface
214 # (local-production.json file). If you need to change some values, prefer to
215 # use the web interface because the configuration will be automatically
216 # reloaded without any need to restart PeerTube.
218 # /!\ If you already have a local-production.json file, the modification of the
219 # following keys will have no effect /!\.
221 ###############################################################################
225 size: 500 # Max number of previews you want to cache
227 size: 500 # Max number of video captions/subtitles you want to cache
229 size: 500 # Max number of video torrents you want to cache
232 # Used to generate the root user at first startup
233 # And to receive emails from the contact form
234 email: 'admin@example.com'
241 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
242 requires_email_verification: false
244 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
249 # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
252 video_quota_daily: -1
254 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
255 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
256 # Please, do not disable transcoding since many uploaded videos will not work
260 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
261 allow_additional_extensions: true
263 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
264 allow_audio_files: true
266 # Amount of threads used by ffmpeg for 1 transcoding job
268 # Amount of transcoding jobs to execute in parallel
271 # Choose the transcoding profile
272 # New profiles can be added by plugins
273 # Available in core PeerTube: 'default'
276 resolutions: # Only created if the original video has a higher resolution, uses more storage!
277 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
286 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
287 # If you also enabled the hls format, it will multiply videos storage by 2
288 # If disabled, breaks federation with PeerTube instances < 2.1
292 # /!\ Requires ffmpeg >= 4.1
293 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
294 # * Resolution change is smoother
295 # * Faster playback in particular with long videos
296 # * More stable playback (less bugs/infinite loading)
297 # If you also enabled the webtorrent format, it will multiply videos storage by 2
304 # Limit lives duration
306 max_duration: -1 # For example: '5 hours'
308 # Limit max number of live videos created on your instance
310 max_instance_lives: 20
312 # Limit max number of live videos created by a user on your instance
316 # Allow your users to save a replay of their live
317 # PeerTube will transcode segments in a video file
318 # If the user daily/total quota is reached, PeerTube will stop the live
319 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
322 # Your firewall should accept traffic from this port in TCP if you enable live
326 # Allow to transcode the live streaming in multiple live resolutions
331 # Choose the transcoding profile
332 # New profiles can be added by plugins
333 # Available in core PeerTube: 'default'
346 # Add ability for your users to import remote videos (from YouTube, torrent...)
348 # Amount of import jobs to execute in parallel
351 http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
354 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
357 # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
361 torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
365 # New videos automatically blacklisted so moderators can review before publishing
373 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
374 description: 'Welcome to this PeerTube instance!' # Support markdown
375 terms: 'No terms for now.' # Support markdown
376 code_of_conduct: '' # Supports markdown
378 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
379 moderation_information: '' # Supports markdown
381 # Why did you create this instance?
382 creation_reason: '' # Supports Markdown
384 # Who is behind the instance? A single person? A non profit?
385 administrator: '' # Supports Markdown
387 # How long do you plan to maintain this instance?
388 maintenance_lifetime: '' # Supports Markdown
390 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
391 business_model: '' # Supports Markdown
393 # If you want to explain on what type of hardware your PeerTube instance runs
394 # Example: "2 vCore, 2GB RAM..."
395 hardware_information: '' # Supports Markdown
397 # What are the main languages of your instance? To interact with your users for example
398 # Uncomment or add the languages you want
399 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
405 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
406 # Uncomment or add the category ids you want
407 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
418 # - 10 # Entertainment
419 # - 11 # News & Politics
423 # - 15 # Science & Technology
428 default_client_route: '/videos/trending'
430 # Whether or not the instance is dedicated to NSFW content
431 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
432 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
434 # By default, "do_not_list" or "blur" or "display" NSFW videos
435 # Could be overridden per user with a setting
436 default_nsfw_policy: 'do_not_list'
439 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
440 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
441 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
445 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
447 "# 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:"
450 # Cards configuration to format video in Twitter
452 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
453 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
454 # If false, we use an image link card that will redirect on your PeerTube instance
455 # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
460 # Allow or not other instances to follow yours
462 # Whether or not an administrator must manually validate a new follower
463 manual_approval: false
467 # If you want to automatically follow back new instance followers
468 # If this option is enabled, use the mute feature instead of deleting followings
469 # /!\ Don't enable this if you don't have a reactive moderation team /!\
473 # If you want to automatically follow instances of the public index
474 # If this option is enabled, use the mute feature instead of deleting followings
475 # /!\ Don't enable this if you don't have a reactive moderation team /!\
478 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
486 message: '' # Support markdown
487 level: 'info' # 'info' | 'warning' | 'error'
491 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
492 # If enabled, the associated group will be able to "escape" from the instance follows
493 # That means they will be able to follow channels, watch videos, list videos of non followed instances
498 # Use a third party index instead of your local index, only for search results
499 # Useful to discover content outside of your instance
500 # If you enable search_index, you must enable remote_uri search for users
501 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
502 # instead of loading the video locally
505 # URL of the search index, that should use the same search API and routes
506 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
507 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
508 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
510 # You can disable local search, so users only use the search index
511 disable_local_search: false
512 # If you did not disable local search, you can decide to use the search index by default
513 is_default_search: false