5 # Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
8 hostname: 'example.com'
11 # Secrets you need to generate the first time you run PeerTube
17 # 50 attempts in 10 seconds
21 # 15 attempts in 5 min
25 # 2 attempts in 5 min (only succeeded attempts are taken into account)
33 # 10 attempts in 10 min
37 # Proxies to trust to get real client IP
38 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
39 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
43 # Your database name will be database.name OR 'peertube'+database.suffix
54 # Redis server for short time storage
55 # You can also specify a 'socket' path to a unix socket but first need to
56 # set 'hostname' and 'port' to null
63 # SMTP server to send emails
67 # Path to sendmail command. Required if you use sendmail transport
70 port: 465 # If you use StartTLS: 587
73 tls: true # If you use StartTLS: false
74 disable_starttls: false
75 ca_file: null # Used for self signed certificates
76 from_address: 'admin@example.com'
84 # Update default PeerTube values
85 # Set by API when the field is not provided and put as default value in client
87 # Change default values when publishing a video (upload/import/go Live)
89 download_enabled: true
91 comments_enabled: true
93 # public = 1, unlisted = 2, private = 3, internal = 4
96 # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
97 # You can also choose a custom licence value added by a plugin
98 # No licence by default
102 # Enable P2P by default in PeerTube client
103 # Can be enabled/disabled by anonymous users and logged in users
107 # Enable P2P by default in PeerTube embed
108 # Can be enabled/disabled by URL option
112 # From the project root directory
114 tmp: '/var/www/peertube/storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
115 bin: '/var/www/peertube/storage/bin/'
116 avatars: '/var/www/peertube/storage/avatars/'
117 videos: '/var/www/peertube/storage/videos/'
118 streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
119 redundancy: '/var/www/peertube/storage/redundancy/'
120 logs: '/var/www/peertube/storage/logs/'
121 previews: '/var/www/peertube/storage/previews/'
122 thumbnails: '/var/www/peertube/storage/thumbnails/'
123 torrents: '/var/www/peertube/storage/torrents/'
124 captions: '/var/www/peertube/storage/captions/'
125 cache: '/var/www/peertube/storage/cache/'
126 plugins: '/var/www/peertube/storage/plugins/'
127 well_known: '/var/www/peertube/storage/well-known/'
128 # Overridable client files in client/dist/assets/images:
131 # - default-playlist.jpg
132 # - default-avatar-account.png
133 # - default-avatar-video-channel.png
134 # - and icons/*.png (PWA)
135 # Could contain for example assets/images/favicon.png
136 # If the file exists, peertube will serve it
137 # If not, peertube will fallback to the default file
138 client_overrides: '/var/www/peertube/storage/client-overrides/'
143 # Without protocol, will default to HTTPS
144 endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
148 # Set this ACL on each uploaded object
149 upload_acl: 'public-read'
152 # You can also use AWS_ACCESS_KEY_ID env variable
154 # You can also use AWS_SECRET_ACCESS_KEY env variable
155 secret_access_key: ''
157 # Maximum amount to upload in one request to object storage
158 max_upload_part: 100MB
161 bucket_name: 'streaming-playlists'
163 # Allows setting all buckets to the same value but with a different prefix
164 prefix: '' # Example: 'streaming-playlists:'
166 # Base url for object URL generation, scheme and host will be replaced by this URL
167 # Useful when you want to use a CDN/external proxy
168 base_url: '' # Example: 'https://mirror.example.com'
170 # Same settings but for webtorrent videos
172 bucket_name: 'videos'
177 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
180 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
186 log_ping_requests: true
187 log_tracker_unknown_infohash: true
191 # Accept warn/error logs coming from the client
192 accept_client_log: true
194 # Highly experimental support of Open Telemetry
199 # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics
206 # Send traces to a Jaeger compatible endpoint
212 interval_days: 7 # Compute trending videos for the last x days
215 - 'hot' # adaptation of Reddit's 'Hot' algorithm
216 - 'most-viewed' # default, used initially by PeerTube as the trending page
218 default: 'most-viewed'
220 # Cache remote videos on your server, to help other instances to broadcast the video
221 # You can define multiple caches using different sizes/strategies
222 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
225 check_interval: '1 hour' # How often you want to check new videos to cache
226 strategies: # Just uncomment strategies you want
229 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
230 # min_lifetime: '48 hours'
231 # strategy: 'most-views' # Cache videos that have the most views
234 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
235 # min_lifetime: '48 hours'
236 # strategy: 'trending' # Cache trending videos
239 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
240 # min_lifetime: '48 hours'
241 # strategy: 'recently-added' # Cache recently added videos
242 # min_views: 10 # Having at least x views
244 # Other instances that duplicate your content
247 # 'nobody': Do not accept remote redundancies
248 # 'anybody': Accept remote redundancies from anybody
249 # 'followings': Accept redundancies from instance followings
250 accept_from: 'anybody'
254 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
258 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
263 # If you disable the tracker, you disable the P2P on your PeerTube instance
265 # Only handle requests on your videos
266 # If you set this to false it means you have a public tracker
267 # Then, it is possible that clients overload your instance with external torrents
269 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
270 reject_too_many_announces: false
274 # If you want to limit users videos history
275 # -1 means there is no limitations
276 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
281 # PeerTube creates a database entry every hour for each video to track views over a period of time
282 # This is used in particular by the Trending page
283 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
284 # -1 means no cleanup
285 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
289 # PeerTube buffers local video views before updating and federating the video
290 local_buffer_update_interval: '30 minutes'
292 ip_view_expiration: '1 hour'
294 # Used to get country location of views of local videos
299 database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
302 # The website PeerTube will ask for available PeerTube plugins and themes
303 # This is an unmoderated plugin index, so only install plugins/themes you trust
306 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
307 url: 'https://packages.joinpeertube.org'
311 federate_unlisted: false
313 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
314 # It removes objects that do not exist anymore, and potentially fix their URLs
315 cleanup_remote_interactions: true
318 check_latest_version:
319 # Check and notify admins of new PeerTube versions
321 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
322 url: 'https://joinpeertube.org/api/v1/versions.json'
327 # Set this to false if you don't want to allow config edition in the web interface by instance admins
330 # XML, Atom or JSON feeds
333 # Default number of videos displayed in feeds
337 # Default number of comments displayed in feeds
340 ###############################################################################
342 # From this point, almost all following keys can be overridden by the web interface
343 # (local-production.json file). If you need to change some values, prefer to
344 # use the web interface because the configuration will be automatically
345 # reloaded without any need to restart PeerTube
347 # /!\ If you already have a local-production.json file, modification of some of
348 # the following keys will have no effect /!\
350 ###############################################################################
354 size: 500 # Max number of previews you want to cache
356 size: 500 # Max number of video captions/subtitles you want to cache
358 size: 500 # Max number of video torrents you want to cache
361 # Used to generate the root user at first startup
362 # And to receive emails from the contact form
363 email: 'admin@example.com'
370 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
371 minimum_age: 16 # Used to configure the signup form
372 requires_email_verification: false
374 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
379 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
380 # Byte format is supported ("1GB" etc)
383 video_quota_daily: -1
386 max_per_user: 20 # Allows each user to create up to 20 video channels.
388 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
389 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
390 # Please, do not disable transcoding since many uploaded videos will not work
394 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
395 allow_additional_extensions: true
397 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
398 allow_audio_files: true
400 # Amount of threads used by ffmpeg for 1 transcoding job
402 # Amount of transcoding jobs to execute in parallel
405 # Choose the transcoding profile
406 # New profiles can be added by plugins
407 # Available in core PeerTube: 'default'
410 resolutions: # Only created if the original video has a higher resolution, uses more storage!
411 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
421 # Transcode and keep original resolution, even if it's above your maximum enabled resolution
422 always_transcode_original_resolution: true
424 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
425 # If you also enabled the hls format, it will multiply videos storage by 2
426 # If disabled, breaks federation with PeerTube instances < 2.1
430 # /!\ Requires ffmpeg >= 4.1
431 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
432 # * Resolution change is smoother
433 # * Faster playback in particular with long videos
434 # * More stable playback (less bugs/infinite loading)
435 # If you also enabled the webtorrent format, it will multiply videos storage by 2
442 # Limit lives duration
444 max_duration: -1 # For example: '5 hours'
446 # Limit max number of live videos created on your instance
448 max_instance_lives: 20
450 # Limit max number of live videos created by a user on your instance
454 # Allow your users to save a replay of their live
455 # PeerTube will transcode segments in a video file
456 # If the user daily/total quota is reached, PeerTube will stop the live
457 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
460 # Allow your users to change latency settings (small latency/default/high latency)
461 # Small latency live streams cannot use P2P
462 # High latency live streams can increase P2P ratio
466 # Your firewall should accept traffic from this port in TCP if you enable live
470 # Listening hostname/port for RTMP server
471 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
472 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
476 # Public hostname of your RTMP server
477 # Use null to use the same value than `webserver.hostname`
478 public_hostname: null
483 # Listening hostname/port for RTMPS server
484 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
485 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
493 # Public hostname of your RTMPS server
494 # Use null to use the same value than `webserver.hostname`
495 public_hostname: null
497 # Allow to transcode the live streaming in multiple live resolutions
502 # Choose the transcoding profile
503 # New profiles can be added by plugins
504 # Available in core PeerTube: 'default'
517 # Also transcode original resolution, even if it's above your maximum enabled resolution
518 always_transcode_original_resolution: true
521 # Enable video edition by users (cut, add intro/outro, add watermark etc)
522 # If enabled, users can create transcoding tasks as they wish
526 # Add ability for your users to import remote videos (from YouTube, torrent...)
528 # Amount of import jobs to execute in parallel
531 # Set a custom video import timeout to not block import queue
534 # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
536 # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
537 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
541 # Direct download URL to youtube-dl binary
542 # Github releases API is also supported
544 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
545 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
546 # * https://yt-dl.org/downloads/latest/youtube-dl
547 url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
549 # Release binary name: 'yt-dlp' or 'youtube-dl'
552 # Path to the python binary to execute for youtube-dl or yt-dlp
553 python_path: '/usr/bin/python3'
555 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
558 # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
560 # We recommend to only enable magnet URI/torrent import if you trust your users
561 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
564 # Add ability for your users to synchronize their channels with external channels, playlists, etc.
565 video_channel_synchronization:
570 check_interval: 1 hour
572 # Number of latest published videos to check and to potentially import when syncing a channel
573 videos_limit_per_synchronization: 10
576 # New videos automatically blacklisted so moderators can review before publishing
584 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
585 description: 'Welcome to this PeerTube instance!' # Support markdown
586 terms: 'No terms for now.' # Support markdown
587 code_of_conduct: '' # Supports markdown
589 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
590 moderation_information: '' # Supports markdown
592 # Why did you create this instance?
593 creation_reason: '' # Supports Markdown
595 # Who is behind the instance? A single person? A non profit?
596 administrator: '' # Supports Markdown
598 # How long do you plan to maintain this instance?
599 maintenance_lifetime: '' # Supports Markdown
601 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
602 business_model: '' # Supports Markdown
604 # If you want to explain on what type of hardware your PeerTube instance runs
605 # Example: '2 vCore, 2GB RAM...'
606 hardware_information: '' # Supports Markdown
608 # What are the main languages of your instance? To interact with your users for example
609 # Uncomment or add the languages you want
610 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
616 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
617 # Uncomment or add the category ids you want
618 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
629 # - 10 # Entertainment
630 # - 11 # News & Politics
634 # - 15 # Science & Technology
639 default_client_route: '/videos/trending'
641 # Whether or not the instance is dedicated to NSFW content
642 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
643 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
645 # By default, `do_not_list` or `blur` or `display` NSFW videos
646 # Could be overridden per user with a setting
647 default_nsfw_policy: 'do_not_list'
650 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
651 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
652 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
656 # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes
657 # To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
659 '# 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:'
662 # Cards configuration to format video in Twitter
664 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
665 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
666 # If false, we use an image link card that will redirect on your PeerTube instance
667 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
672 # Allow or not other instances to follow yours
674 # Whether or not an administrator must manually validate a new follower
675 manual_approval: false
679 # If you want to automatically follow back new instance followers
680 # If this option is enabled, use the mute feature instead of deleting followings
681 # /!\ Don't enable this if you don't have a reactive moderation team /!\
685 # If you want to automatically follow instances of the public index
686 # If this option is enabled, use the mute feature instead of deleting followings
687 # /!\ Don't enable this if you don't have a reactive moderation team /!\
690 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
698 message: '' # Support markdown
699 level: 'info' # 'info' | 'warning' | 'error'
703 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
704 # If enabled, the associated group will be able to "escape" from the instance follows
705 # That means they will be able to follow channels, watch videos, list videos of non followed instances
710 # Use a third party index instead of your local index, only for search results
711 # Useful to discover content outside of your instance
712 # If you enable search_index, you must enable remote_uri search for users
713 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
714 # instead of loading the video locally
717 # URL of the search index, that should use the same search API and routes
718 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
719 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
720 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
722 # You can disable local search, so users only use the search index
723 disable_local_search: false
724 # If you did not disable local search, you can decide to use the search index by default
725 is_default_search: false
727 # PeerTube client/interface configuration
731 # By default PeerTube client displays author username
732 prefer_author_display_name: false
733 display_author_avatar: false
735 # Max size of upload chunks, e.g. '90MB'
736 # If null, it will be calculated based on network speed
741 # If you enable only one external auth plugin
742 # You can automatically redirect your users on this external platform when they click on the login button
743 redirect_on_single_external_auth: false