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 # 10 attempts in 10 min
33 # Proxies to trust to get real client IP
34 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
35 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
39 # Your database name will be database.name OR 'peertube'+database.suffix
50 # Redis server for short time storage
51 # You can also specify a 'socket' path to a unix socket but first need to
52 # set 'hostname' and 'port' to null
59 # SMTP server to send emails
63 # Path to sendmail command. Required if you use sendmail transport
66 port: 465 # If you use StartTLS: 587
69 tls: true # If you use StartTLS: false
70 disable_starttls: false
71 ca_file: null # Used for self signed certificates
72 from_address: 'admin@example.com'
80 # Update default PeerTube values
81 # Set by API when the field is not provided and put as default value in client
83 # Change default values when publishing a video (upload/import/go Live)
85 download_enabled: true
87 comments_enabled: true
89 # public = 1, unlisted = 2, private = 3, internal = 4
92 # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
93 # You can also choose a custom licence value added by a plugin
94 # No licence by default
98 # Enable P2P by default in PeerTube client
99 # Can be enabled/disabled by anonymous users and logged in users
103 # Enable P2P by default in PeerTube embed
104 # Can be enabled/disabled by URL option
108 # From the project root directory
110 tmp: '/var/www/peertube/storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
111 bin: '/var/www/peertube/storage/bin/'
112 avatars: '/var/www/peertube/storage/avatars/'
113 videos: '/var/www/peertube/storage/videos/'
114 streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
115 redundancy: '/var/www/peertube/storage/redundancy/'
116 logs: '/var/www/peertube/storage/logs/'
117 previews: '/var/www/peertube/storage/previews/'
118 thumbnails: '/var/www/peertube/storage/thumbnails/'
119 torrents: '/var/www/peertube/storage/torrents/'
120 captions: '/var/www/peertube/storage/captions/'
121 cache: '/var/www/peertube/storage/cache/'
122 plugins: '/var/www/peertube/storage/plugins/'
123 well_known: '/var/www/peertube/storage/well-known/'
124 # Overridable client files in client/dist/assets/images:
127 # - default-playlist.jpg
128 # - default-avatar-account.png
129 # - default-avatar-video-channel.png
130 # - and icons/*.png (PWA)
131 # Could contain for example assets/images/favicon.png
132 # If the file exists, peertube will serve it
133 # If not, peertube will fallback to the default file
134 client_overrides: '/var/www/peertube/storage/client-overrides/'
139 # Without protocol, will default to HTTPS
140 endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
144 # Set this ACL on each uploaded object
145 upload_acl: 'public-read'
148 # You can also use AWS_ACCESS_KEY_ID env variable
150 # You can also use AWS_SECRET_ACCESS_KEY env variable
151 secret_access_key: ''
153 # Maximum amount to upload in one request to object storage
154 max_upload_part: 100MB
157 bucket_name: 'streaming-playlists'
159 # Allows setting all buckets to the same value but with a different prefix
160 prefix: '' # Example: 'streaming-playlists:'
162 # Base url for object URL generation, scheme and host will be replaced by this URL
163 # Useful when you want to use a CDN/external proxy
164 base_url: '' # Example: 'https://mirror.example.com'
166 # Same settings but for webtorrent videos
168 bucket_name: 'videos'
173 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
176 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
182 log_ping_requests: true
183 log_tracker_unknown_infohash: true
187 # Accept warn/error logs coming from the client
188 accept_client_log: true
190 # Highly experimental support of Open Telemetry
195 # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics
202 # Send traces to a Jaeger compatible endpoint
208 interval_days: 7 # Compute trending videos for the last x days
211 - 'hot' # adaptation of Reddit's 'Hot' algorithm
212 - 'most-viewed' # default, used initially by PeerTube as the trending page
214 default: 'most-viewed'
216 # Cache remote videos on your server, to help other instances to broadcast the video
217 # You can define multiple caches using different sizes/strategies
218 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
221 check_interval: '1 hour' # How often you want to check new videos to cache
222 strategies: # Just uncomment strategies you want
225 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
226 # min_lifetime: '48 hours'
227 # strategy: 'most-views' # Cache videos that have the most views
230 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
231 # min_lifetime: '48 hours'
232 # strategy: 'trending' # Cache trending videos
235 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
236 # min_lifetime: '48 hours'
237 # strategy: 'recently-added' # Cache recently added videos
238 # min_views: 10 # Having at least x views
240 # Other instances that duplicate your content
243 # 'nobody': Do not accept remote redundancies
244 # 'anybody': Accept remote redundancies from anybody
245 # 'followings': Accept redundancies from instance followings
246 accept_from: 'anybody'
250 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
254 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
259 # If you disable the tracker, you disable the P2P on your PeerTube instance
261 # Only handle requests on your videos
262 # If you set this to false it means you have a public tracker
263 # Then, it is possible that clients overload your instance with external torrents
265 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
266 reject_too_many_announces: false
270 # If you want to limit users videos history
271 # -1 means there is no limitations
272 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
277 # PeerTube creates a database entry every hour for each video to track views over a period of time
278 # This is used in particular by the Trending page
279 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
280 # -1 means no cleanup
281 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
285 # PeerTube buffers local video views before updating and federating the video
286 local_buffer_update_interval: '30 minutes'
288 ip_view_expiration: '1 hour'
290 # Used to get country location of views of local videos
295 database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
298 # The website PeerTube will ask for available PeerTube plugins and themes
299 # This is an unmoderated plugin index, so only install plugins/themes you trust
302 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
303 url: 'https://packages.joinpeertube.org'
307 federate_unlisted: false
309 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
310 # It removes objects that do not exist anymore, and potentially fix their URLs
311 cleanup_remote_interactions: true
314 check_latest_version:
315 # Check and notify admins of new PeerTube versions
317 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
318 url: 'https://joinpeertube.org/api/v1/versions.json'
323 # Set this to false if you don't want to allow config edition in the web interface by instance admins
326 # XML, Atom or JSON feeds
329 # Default number of videos displayed in feeds
333 # Default number of comments displayed in feeds
336 ###############################################################################
338 # From this point, almost all following keys can be overridden by the web interface
339 # (local-production.json file). If you need to change some values, prefer to
340 # use the web interface because the configuration will be automatically
341 # reloaded without any need to restart PeerTube
343 # /!\ If you already have a local-production.json file, modification of some of
344 # the following keys will have no effect /!\
346 ###############################################################################
350 size: 500 # Max number of previews you want to cache
352 size: 500 # Max number of video captions/subtitles you want to cache
354 size: 500 # Max number of video torrents you want to cache
357 # Used to generate the root user at first startup
358 # And to receive emails from the contact form
359 email: 'admin@example.com'
366 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
367 minimum_age: 16 # Used to configure the signup form
368 requires_email_verification: false
370 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
375 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
376 # Byte format is supported ("1GB" etc)
379 video_quota_daily: -1
382 max_per_user: 20 # Allows each user to create up to 20 video channels.
384 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
385 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
386 # Please, do not disable transcoding since many uploaded videos will not work
390 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
391 allow_additional_extensions: true
393 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
394 allow_audio_files: true
396 # Amount of threads used by ffmpeg for 1 transcoding job
398 # Amount of transcoding jobs to execute in parallel
401 # Choose the transcoding profile
402 # New profiles can be added by plugins
403 # Available in core PeerTube: 'default'
406 resolutions: # Only created if the original video has a higher resolution, uses more storage!
407 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
417 # Transcode and keep original resolution, even if it's above your maximum enabled resolution
418 always_transcode_original_resolution: true
420 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
421 # If you also enabled the hls format, it will multiply videos storage by 2
422 # If disabled, breaks federation with PeerTube instances < 2.1
426 # /!\ Requires ffmpeg >= 4.1
427 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
428 # * Resolution change is smoother
429 # * Faster playback in particular with long videos
430 # * More stable playback (less bugs/infinite loading)
431 # If you also enabled the webtorrent format, it will multiply videos storage by 2
438 # Limit lives duration
440 max_duration: -1 # For example: '5 hours'
442 # Limit max number of live videos created on your instance
444 max_instance_lives: 20
446 # Limit max number of live videos created by a user on your instance
450 # Allow your users to save a replay of their live
451 # PeerTube will transcode segments in a video file
452 # If the user daily/total quota is reached, PeerTube will stop the live
453 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
456 # Allow your users to change latency settings (small latency/default/high latency)
457 # Small latency live streams cannot use P2P
458 # High latency live streams can increase P2P ratio
462 # Your firewall should accept traffic from this port in TCP if you enable live
466 # Listening hostname/port for RTMP server
467 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
468 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
472 # Public hostname of your RTMP server
473 # Use null to use the same value than `webserver.hostname`
474 public_hostname: null
479 # Listening hostname/port for RTMPS server
480 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
481 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
489 # Public hostname of your RTMPS server
490 # Use null to use the same value than `webserver.hostname`
491 public_hostname: null
493 # Allow to transcode the live streaming in multiple live resolutions
498 # Choose the transcoding profile
499 # New profiles can be added by plugins
500 # Available in core PeerTube: 'default'
513 # Also transcode original resolution, even if it's above your maximum enabled resolution
514 always_transcode_original_resolution: true
517 # Enable video edition by users (cut, add intro/outro, add watermark etc)
518 # If enabled, users can create transcoding tasks as they wish
522 # Add ability for your users to import remote videos (from YouTube, torrent...)
524 # Amount of import jobs to execute in parallel
527 # Set a custom video import timeout to not block import queue
530 # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
532 # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
533 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
537 # Direct download URL to youtube-dl binary
538 # Github releases API is also supported
540 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
541 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
542 # * https://yt-dl.org/downloads/latest/youtube-dl
543 url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
545 # Release binary name: 'yt-dlp' or 'youtube-dl'
548 # Path to the python binary to execute for youtube-dl or yt-dlp
549 python_path: '/usr/bin/python3'
551 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
554 # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
556 # We recommend to only enable magnet URI/torrent import if you trust your users
557 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
560 # Add ability for your users to synchronize their channels with external channels, playlists, etc.
561 video_channel_synchronization:
566 check_interval: 1 hour
568 # Number of latest published videos to check and to potentially import when syncing a channel
569 videos_limit_per_synchronization: 10
572 # New videos automatically blacklisted so moderators can review before publishing
580 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
581 description: 'Welcome to this PeerTube instance!' # Support markdown
582 terms: 'No terms for now.' # Support markdown
583 code_of_conduct: '' # Supports markdown
585 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
586 moderation_information: '' # Supports markdown
588 # Why did you create this instance?
589 creation_reason: '' # Supports Markdown
591 # Who is behind the instance? A single person? A non profit?
592 administrator: '' # Supports Markdown
594 # How long do you plan to maintain this instance?
595 maintenance_lifetime: '' # Supports Markdown
597 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
598 business_model: '' # Supports Markdown
600 # If you want to explain on what type of hardware your PeerTube instance runs
601 # Example: '2 vCore, 2GB RAM...'
602 hardware_information: '' # Supports Markdown
604 # What are the main languages of your instance? To interact with your users for example
605 # Uncomment or add the languages you want
606 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
612 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
613 # Uncomment or add the category ids you want
614 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
625 # - 10 # Entertainment
626 # - 11 # News & Politics
630 # - 15 # Science & Technology
635 default_client_route: '/videos/trending'
637 # Whether or not the instance is dedicated to NSFW content
638 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
639 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
641 # By default, `do_not_list` or `blur` or `display` NSFW videos
642 # Could be overridden per user with a setting
643 default_nsfw_policy: 'do_not_list'
646 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
647 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
648 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
652 # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes
653 # To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
655 '# 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:'
658 # Cards configuration to format video in Twitter
660 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
661 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
662 # If false, we use an image link card that will redirect on your PeerTube instance
663 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
668 # Allow or not other instances to follow yours
670 # Whether or not an administrator must manually validate a new follower
671 manual_approval: false
675 # If you want to automatically follow back new instance followers
676 # If this option is enabled, use the mute feature instead of deleting followings
677 # /!\ Don't enable this if you don't have a reactive moderation team /!\
681 # If you want to automatically follow instances of the public index
682 # If this option is enabled, use the mute feature instead of deleting followings
683 # /!\ Don't enable this if you don't have a reactive moderation team /!\
686 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
694 message: '' # Support markdown
695 level: 'info' # 'info' | 'warning' | 'error'
699 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
700 # If enabled, the associated group will be able to "escape" from the instance follows
701 # That means they will be able to follow channels, watch videos, list videos of non followed instances
706 # Use a third party index instead of your local index, only for search results
707 # Useful to discover content outside of your instance
708 # If you enable search_index, you must enable remote_uri search for users
709 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
710 # instead of loading the video locally
713 # URL of the search index, that should use the same search API and routes
714 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
715 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
716 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
718 # You can disable local search, so users only use the search index
719 disable_local_search: false
720 # If you did not disable local search, you can decide to use the search index by default
721 is_default_search: false
723 # PeerTube client/interface configuration
727 # By default PeerTube client displays author username
728 prefer_author_display_name: false
729 display_author_avatar: false
731 # Max size of upload chunks, e.g. '90MB'
732 # If null, it will be calculated based on network speed
737 # If you enable only one external auth plugin
738 # You can automatically redirect your users on this external platform when they click on the login button
739 redirect_on_single_external_auth: false