1 # /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #
7 # Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
15 # 50 attempts in 10 seconds
19 # 15 attempts in 5 min
23 # 2 attempts in 5 min (only succeeded attempts are taken into account)
31 # 10 attempts in 10 min
35 # Proxies to trust to get real client IP
36 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
37 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
41 # Your database name will be database.name OR 'peertube'+database.suffix
52 # Redis server for short time storage
53 # You can also specify a 'socket' path to a unix socket but first need to
54 # set 'hostname' and 'port' to null
61 # SMTP server to send emails
65 # Path to sendmail command. Required if you use sendmail transport
68 port: 465 # If you use StartTLS: 587
71 tls: true # If you use StartTLS: false
72 disable_starttls: false
73 ca_file: null # Used for self signed certificates
74 from_address: 'admin@example.com'
82 # Update default PeerTube values
83 # Set by API when the field is not provided and put as default value in client
85 # Change default values when publishing a video (upload/import/go Live)
87 download_enabled: true
89 comments_enabled: true
91 # public = 1, unlisted = 2, private = 3, internal = 4
94 # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
95 # You can also choose a custom licence value added by a plugin
96 # No licence by default
100 # Enable P2P by default in PeerTube client
101 # Can be enabled/disabled by anonymous users and logged in users
105 # Enable P2P by default in PeerTube embed
106 # Can be enabled/disabled by URL option
110 # From the project root directory
112 tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
114 avatars: 'storage/avatars/'
115 videos: 'storage/videos/'
116 streaming_playlists: 'storage/streaming-playlists/'
117 redundancy: 'storage/redundancy/'
118 logs: 'storage/logs/'
119 previews: 'storage/previews/'
120 thumbnails: 'storage/thumbnails/'
121 torrents: 'storage/torrents/'
122 captions: 'storage/captions/'
123 cache: 'storage/cache/'
124 plugins: 'storage/plugins/'
125 # Overridable client files in client/dist/assets/images:
128 # - default-playlist.jpg
129 # - default-avatar-account.png
130 # - default-avatar-video-channel.png
131 # - and icons/*.png (PWA)
132 # Could contain for example assets/images/favicon.png
133 # If the file exists, peertube will serve it
134 # If not, peertube will fallback to the default file
135 client_overrides: 'storage/client-overrides/'
140 # Without protocol, will default to HTTPS
141 endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
145 # Set this ACL on each uploaded object
146 upload_acl: 'public-read'
149 # You can also use AWS_ACCESS_KEY_ID env variable
151 # You can also use AWS_SECRET_ACCESS_KEY env variable
152 secret_access_key: ''
154 # Maximum amount to upload in one request to object storage
155 max_upload_part: 100MB
158 bucket_name: 'streaming-playlists'
160 # Allows setting all buckets to the same value but with a different prefix
161 prefix: '' # Example: 'streaming-playlists:'
163 # Base url for object URL generation, scheme and host will be replaced by this URL
164 # Useful when you want to use a CDN/external proxy
165 base_url: '' # Example: 'https://mirror.example.com'
167 # Same settings but for webtorrent videos
169 bucket_name: 'videos'
174 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
177 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
183 log_ping_requests: true
184 log_tracker_unknown_infohash: true
188 # Accept warn/error logs coming from the client
189 accept_client_log: true
191 # Highly experimental support of Open Telemetry
196 # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics
203 # Send traces to a Jaeger compatible endpoint
209 interval_days: 7 # Compute trending videos for the last x days
212 - 'hot' # adaptation of Reddit's 'Hot' algorithm
213 - 'most-viewed' # default, used initially by PeerTube as the trending page
215 default: 'most-viewed'
217 # Cache remote videos on your server, to help other instances to broadcast the video
218 # You can define multiple caches using different sizes/strategies
219 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
222 check_interval: '1 hour' # How often you want to check new videos to cache
223 strategies: # Just uncomment strategies you want
226 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
227 # min_lifetime: '48 hours'
228 # strategy: 'most-views' # Cache videos that have the most views
231 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
232 # min_lifetime: '48 hours'
233 # strategy: 'trending' # Cache trending videos
236 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
237 # min_lifetime: '48 hours'
238 # strategy: 'recently-added' # Cache recently added videos
239 # min_views: 10 # Having at least x views
241 # Other instances that duplicate your content
244 # 'nobody': Do not accept remote redundancies
245 # 'anybody': Accept remote redundancies from anybody
246 # 'followings': Accept redundancies from instance followings
247 accept_from: 'anybody'
251 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
255 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
260 # If you disable the tracker, you disable the P2P on your PeerTube instance
262 # Only handle requests on your videos
263 # If you set this to false it means you have a public tracker
264 # Then, it is possible that clients overload your instance with external torrents
266 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
267 reject_too_many_announces: false
271 # If you want to limit users videos history
272 # -1 means there is no limitations
273 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
278 # PeerTube creates a database entry every hour for each video to track views over a period of time
279 # This is used in particular by the Trending page
280 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
281 # -1 means no cleanup
282 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
286 # PeerTube buffers local video views before updating and federating the video
287 local_buffer_update_interval: '30 minutes'
289 ip_view_expiration: '1 hour'
291 # Used to get country location of views of local videos
296 database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
299 # The website PeerTube will ask for available PeerTube plugins and themes
300 # This is an unmoderated plugin index, so only install plugins/themes you trust
303 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
304 url: 'https://packages.joinpeertube.org'
308 federate_unlisted: false
310 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
311 # It removes objects that do not exist anymore, and potentially fix their URLs
312 cleanup_remote_interactions: true
315 check_latest_version:
316 # Check and notify admins of new PeerTube versions
318 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
319 url: 'https://joinpeertube.org/api/v1/versions.json'
324 # Set this to false if you don't want to allow config edition in the web interface by instance admins
327 # XML, Atom or JSON feeds
330 # Default number of videos displayed in feeds
334 # Default number of comments displayed in feeds
339 size: 500 # Max number of previews you want to cache
341 size: 500 # Max number of video captions/subtitles you want to cache
343 size: 500 # Max number of video torrents you want to cache
346 # Used to generate the root user at first startup
347 # And to receive emails from the contact form
348 email: 'admin@example.com'
355 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
356 minimum_age: 16 # Used to configure the signup form
357 requires_email_verification: false
359 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
364 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
365 # Byte format is supported ("1GB" etc)
368 video_quota_daily: -1
371 max_per_user: 20 # Allows each user to create up to 20 video channels.
373 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
374 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
375 # Please, do not disable transcoding since many uploaded videos will not work
379 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
380 allow_additional_extensions: true
382 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
383 allow_audio_files: true
385 # Amount of threads used by ffmpeg for 1 transcoding job
387 # Amount of transcoding jobs to execute in parallel
390 # Choose the transcoding profile
391 # New profiles can be added by plugins
392 # Available in core PeerTube: 'default'
395 resolutions: # Only created if the original video has a higher resolution, uses more storage!
396 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
406 # Transcode and keep original resolution, even if it's above your maximum enabled resolution
407 always_transcode_original_resolution: true
409 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
410 # If you also enabled the hls format, it will multiply videos storage by 2
411 # If disabled, breaks federation with PeerTube instances < 2.1
415 # /!\ Requires ffmpeg >= 4.1
416 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
417 # * Resolution change is smoother
418 # * Faster playback in particular with long videos
419 # * More stable playback (less bugs/infinite loading)
420 # If you also enabled the webtorrent format, it will multiply videos storage by 2
427 # Limit lives duration
429 max_duration: -1 # For example: '5 hours'
431 # Limit max number of live videos created on your instance
433 max_instance_lives: 20
435 # Limit max number of live videos created by a user on your instance
439 # Allow your users to save a replay of their live
440 # PeerTube will transcode segments in a video file
441 # If the user daily/total quota is reached, PeerTube will stop the live
442 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
445 # Allow your users to change latency settings (small latency/default/high latency)
446 # Small latency live streams cannot use P2P
447 # High latency live streams can increase P2P ratio
451 # Your firewall should accept traffic from this port in TCP if you enable live
455 # Listening hostname/port for RTMP server
456 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
457 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
461 # Public hostname of your RTMP server
462 # Use null to use the same value than `webserver.hostname`
463 public_hostname: null
468 # Listening hostname/port for RTMPS server
469 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
470 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
478 # Public hostname of your RTMPS server
479 # Use null to use the same value than `webserver.hostname`
480 public_hostname: null
482 # Allow to transcode the live streaming in multiple live resolutions
487 # Choose the transcoding profile
488 # New profiles can be added by plugins
489 # Available in core PeerTube: 'default'
502 # Also transcode original resolution, even if it's above your maximum enabled resolution
503 always_transcode_original_resolution: true
506 # Enable video edition by users (cut, add intro/outro, add watermark etc)
507 # If enabled, users can create transcoding tasks as they wish
511 # Add ability for your users to import remote videos (from YouTube, torrent...)
513 # Amount of import jobs to execute in parallel
516 # Set a custom video import timeout to not block import queue
519 # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
521 # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
522 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
526 # Direct download URL to youtube-dl binary
527 # Github releases API is also supported
529 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
530 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
531 # * https://yt-dl.org/downloads/latest/youtube-dl
532 url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
534 # Release binary name: 'yt-dlp' or 'youtube-dl'
537 # Path to the python binary to execute for youtube-dl or yt-dlp
538 python_path: '/usr/bin/python3'
540 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
543 # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
545 # We recommend to only enable magnet URI/torrent import if you trust your users
546 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
549 # Add ability for your users to synchronize their channels with external channels, playlists, etc
550 video_channel_synchronization:
555 check_interval: 1 hour
557 # Number of latest published videos to check and to potentially import when syncing a channel
558 videos_limit_per_synchronization: 10
561 # New videos automatically blacklisted so moderators can review before publishing
569 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
570 description: 'Welcome to this PeerTube instance!' # Support markdown
571 terms: 'No terms for now.' # Support markdown
572 code_of_conduct: '' # Supports markdown
574 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
575 moderation_information: '' # Supports markdown
577 # Why did you create this instance?
578 creation_reason: '' # Supports Markdown
580 # Who is behind the instance? A single person? A non profit?
581 administrator: '' # Supports Markdown
583 # How long do you plan to maintain this instance?
584 maintenance_lifetime: '' # Supports Markdown
586 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
587 business_model: '' # Supports Markdown
589 # If you want to explain on what type of hardware your PeerTube instance runs
590 # Example: '2 vCore, 2GB RAM...'
591 hardware_information: '' # Supports Markdown
593 # What are the main languages of your instance? To interact with your users for example
594 # Uncomment or add the languages you want
595 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
601 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
602 # Uncomment or add the category ids you want
603 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
614 # - 10 # Entertainment
615 # - 11 # News & Politics
619 # - 15 # Science & Technology
624 default_client_route: '/videos/trending'
626 # Whether or not the instance is dedicated to NSFW content
627 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
628 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
630 # By default, `do_not_list` or `blur` or `display` NSFW videos
631 # Could be overridden per user with a setting
632 default_nsfw_policy: 'do_not_list'
635 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
636 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
637 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
641 # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes
642 # To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
644 '# 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:'
647 # Cards configuration to format video in Twitter
649 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
650 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
651 # If false, we use an image link card that will redirect on your PeerTube instance
652 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
657 # Allow or not other instances to follow yours
659 # Whether or not an administrator must manually validate a new follower
660 manual_approval: false
664 # If you want to automatically follow back new instance followers
665 # If this option is enabled, use the mute feature instead of deleting followings
666 # /!\ Don't enable this if you don't have a reactive moderation team /!\
670 # If you want to automatically follow instances of the public index
671 # If this option is enabled, use the mute feature instead of deleting followings
672 # /!\ Don't enable this if you don't have a reactive moderation team /!\
675 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
683 message: '' # Support markdown
684 level: 'info' # 'info' | 'warning' | 'error'
688 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
689 # If enabled, the associated group will be able to "escape" from the instance follows
690 # That means they will be able to follow channels, watch videos, list videos of non followed instances
695 # Use a third party index instead of your local index, only for search results
696 # Useful to discover content outside of your instance
697 # If you enable search_index, you must enable remote_uri search for users
698 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
699 # instead of loading the video locally
702 # URL of the search index, that should use the same search API and routes
703 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
704 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
705 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
707 # You can disable local search, so users only use the search index
708 disable_local_search: false
709 # If you did not disable local search, you can decide to use the search index by default
710 is_default_search: false
712 # PeerTube client/interface configuration
716 # By default PeerTube client displays author username
717 prefer_author_display_name: false
718 display_author_avatar: false
720 # Max size of upload chunks, e.g. '90MB'
721 # If null, it will be calculated based on network speed
726 # If you enable only one external auth plugin
727 # You can automatically redirect your users on this external platform when they click on the login button
728 redirect_on_single_external_auth: false