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 well_known: 'storage/well-known/'
126 # Overridable client files in client/dist/assets/images:
129 # - default-playlist.jpg
130 # - default-avatar-account.png
131 # - default-avatar-video-channel.png
132 # - and icons/*.png (PWA)
133 # Could contain for example assets/images/favicon.png
134 # If the file exists, peertube will serve it
135 # If not, peertube will fallback to the default file
136 client_overrides: 'storage/client-overrides/'
141 # Without protocol, will default to HTTPS
142 endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
146 # Set this ACL on each uploaded object
147 upload_acl: 'public-read'
150 # You can also use AWS_ACCESS_KEY_ID env variable
152 # You can also use AWS_SECRET_ACCESS_KEY env variable
153 secret_access_key: ''
155 # Maximum amount to upload in one request to object storage
156 max_upload_part: 100MB
159 bucket_name: 'streaming-playlists'
161 # Allows setting all buckets to the same value but with a different prefix
162 prefix: '' # Example: 'streaming-playlists:'
164 # Base url for object URL generation, scheme and host will be replaced by this URL
165 # Useful when you want to use a CDN/external proxy
166 base_url: '' # Example: 'https://mirror.example.com'
168 # Same settings but for webtorrent videos
170 bucket_name: 'videos'
175 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
178 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
184 log_ping_requests: true
185 log_tracker_unknown_infohash: true
189 # Accept warn/error logs coming from the client
190 accept_client_log: true
192 # Highly experimental support of Open Telemetry
197 # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics
204 # Send traces to a Jaeger compatible endpoint
210 interval_days: 7 # Compute trending videos for the last x days
213 - 'hot' # adaptation of Reddit's 'Hot' algorithm
214 - 'most-viewed' # default, used initially by PeerTube as the trending page
216 default: 'most-viewed'
218 # Cache remote videos on your server, to help other instances to broadcast the video
219 # You can define multiple caches using different sizes/strategies
220 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
223 check_interval: '1 hour' # How often you want to check new videos to cache
224 strategies: # Just uncomment strategies you want
227 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
228 # min_lifetime: '48 hours'
229 # strategy: 'most-views' # Cache videos that have the most views
232 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
233 # min_lifetime: '48 hours'
234 # strategy: 'trending' # Cache trending videos
237 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
238 # min_lifetime: '48 hours'
239 # strategy: 'recently-added' # Cache recently added videos
240 # min_views: 10 # Having at least x views
242 # Other instances that duplicate your content
245 # 'nobody': Do not accept remote redundancies
246 # 'anybody': Accept remote redundancies from anybody
247 # 'followings': Accept redundancies from instance followings
248 accept_from: 'anybody'
252 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
256 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
261 # If you disable the tracker, you disable the P2P on your PeerTube instance
263 # Only handle requests on your videos
264 # If you set this to false it means you have a public tracker
265 # Then, it is possible that clients overload your instance with external torrents
267 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
268 reject_too_many_announces: false
272 # If you want to limit users videos history
273 # -1 means there is no limitations
274 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
279 # PeerTube creates a database entry every hour for each video to track views over a period of time
280 # This is used in particular by the Trending page
281 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
282 # -1 means no cleanup
283 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
287 # PeerTube buffers local video views before updating and federating the video
288 local_buffer_update_interval: '30 minutes'
290 ip_view_expiration: '1 hour'
292 # Used to get country location of views of local videos
297 database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
300 # The website PeerTube will ask for available PeerTube plugins and themes
301 # This is an unmoderated plugin index, so only install plugins/themes you trust
304 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
305 url: 'https://packages.joinpeertube.org'
309 federate_unlisted: false
311 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
312 # It removes objects that do not exist anymore, and potentially fix their URLs
313 cleanup_remote_interactions: true
316 check_latest_version:
317 # Check and notify admins of new PeerTube versions
319 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
320 url: 'https://joinpeertube.org/api/v1/versions.json'
325 # Set this to false if you don't want to allow config edition in the web interface by instance admins
328 # XML, Atom or JSON feeds
331 # Default number of videos displayed in feeds
335 # Default number of comments displayed in feeds
340 size: 500 # Max number of previews you want to cache
342 size: 500 # Max number of video captions/subtitles you want to cache
344 size: 500 # Max number of video torrents you want to cache
347 # Used to generate the root user at first startup
348 # And to receive emails from the contact form
349 email: 'admin@example.com'
356 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
357 minimum_age: 16 # Used to configure the signup form
358 requires_email_verification: false
360 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
365 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
366 # Byte format is supported ("1GB" etc)
369 video_quota_daily: -1
372 max_per_user: 20 # Allows each user to create up to 20 video channels.
374 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
375 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
376 # Please, do not disable transcoding since many uploaded videos will not work
380 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
381 allow_additional_extensions: true
383 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
384 allow_audio_files: true
386 # Amount of threads used by ffmpeg for 1 transcoding job
388 # Amount of transcoding jobs to execute in parallel
391 # Choose the transcoding profile
392 # New profiles can be added by plugins
393 # Available in core PeerTube: 'default'
396 resolutions: # Only created if the original video has a higher resolution, uses more storage!
397 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
407 # Transcode and keep original resolution, even if it's above your maximum enabled resolution
408 always_transcode_original_resolution: true
410 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
411 # If you also enabled the hls format, it will multiply videos storage by 2
412 # If disabled, breaks federation with PeerTube instances < 2.1
416 # /!\ Requires ffmpeg >= 4.1
417 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
418 # * Resolution change is smoother
419 # * Faster playback in particular with long videos
420 # * More stable playback (less bugs/infinite loading)
421 # If you also enabled the webtorrent format, it will multiply videos storage by 2
428 # Limit lives duration
430 max_duration: -1 # For example: '5 hours'
432 # Limit max number of live videos created on your instance
434 max_instance_lives: 20
436 # Limit max number of live videos created by a user on your instance
440 # Allow your users to save a replay of their live
441 # PeerTube will transcode segments in a video file
442 # If the user daily/total quota is reached, PeerTube will stop the live
443 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
446 # Allow your users to change latency settings (small latency/default/high latency)
447 # Small latency live streams cannot use P2P
448 # High latency live streams can increase P2P ratio
452 # Your firewall should accept traffic from this port in TCP if you enable live
456 # Listening hostname/port for RTMP server
457 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
458 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
462 # Public hostname of your RTMP server
463 # Use null to use the same value than `webserver.hostname`
464 public_hostname: null
469 # Listening hostname/port for RTMPS server
470 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
471 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
479 # Public hostname of your RTMPS server
480 # Use null to use the same value than `webserver.hostname`
481 public_hostname: null
483 # Allow to transcode the live streaming in multiple live resolutions
488 # Choose the transcoding profile
489 # New profiles can be added by plugins
490 # Available in core PeerTube: 'default'
503 # Also transcode original resolution, even if it's above your maximum enabled resolution
504 always_transcode_original_resolution: true
507 # Enable video edition by users (cut, add intro/outro, add watermark etc)
508 # If enabled, users can create transcoding tasks as they wish
512 # Add ability for your users to import remote videos (from YouTube, torrent...)
514 # Amount of import jobs to execute in parallel
517 # Set a custom video import timeout to not block import queue
520 # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
522 # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
523 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
527 # Direct download URL to youtube-dl binary
528 # Github releases API is also supported
530 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
531 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
532 # * https://yt-dl.org/downloads/latest/youtube-dl
533 url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
535 # Release binary name: 'yt-dlp' or 'youtube-dl'
538 # Path to the python binary to execute for youtube-dl or yt-dlp
539 python_path: '/usr/bin/python3'
541 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
544 # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
546 # We recommend to only enable magnet URI/torrent import if you trust your users
547 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
550 # Add ability for your users to synchronize their channels with external channels, playlists, etc
551 video_channel_synchronization:
556 check_interval: 1 hour
558 # Number of latest published videos to check and to potentially import when syncing a channel
559 videos_limit_per_synchronization: 10
562 # New videos automatically blacklisted so moderators can review before publishing
570 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
571 description: 'Welcome to this PeerTube instance!' # Support markdown
572 terms: 'No terms for now.' # Support markdown
573 code_of_conduct: '' # Supports markdown
575 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
576 moderation_information: '' # Supports markdown
578 # Why did you create this instance?
579 creation_reason: '' # Supports Markdown
581 # Who is behind the instance? A single person? A non profit?
582 administrator: '' # Supports Markdown
584 # How long do you plan to maintain this instance?
585 maintenance_lifetime: '' # Supports Markdown
587 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
588 business_model: '' # Supports Markdown
590 # If you want to explain on what type of hardware your PeerTube instance runs
591 # Example: '2 vCore, 2GB RAM...'
592 hardware_information: '' # Supports Markdown
594 # What are the main languages of your instance? To interact with your users for example
595 # Uncomment or add the languages you want
596 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
602 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
603 # Uncomment or add the category ids you want
604 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
615 # - 10 # Entertainment
616 # - 11 # News & Politics
620 # - 15 # Science & Technology
625 default_client_route: '/videos/trending'
627 # Whether or not the instance is dedicated to NSFW content
628 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
629 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
631 # By default, `do_not_list` or `blur` or `display` NSFW videos
632 # Could be overridden per user with a setting
633 default_nsfw_policy: 'do_not_list'
636 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
637 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
638 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
642 # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes
643 # To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
645 '# 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:'
648 # Cards configuration to format video in Twitter
650 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
651 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
652 # If false, we use an image link card that will redirect on your PeerTube instance
653 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
658 # Allow or not other instances to follow yours
660 # Whether or not an administrator must manually validate a new follower
661 manual_approval: false
665 # If you want to automatically follow back new instance followers
666 # If this option is enabled, use the mute feature instead of deleting followings
667 # /!\ Don't enable this if you don't have a reactive moderation team /!\
671 # If you want to automatically follow instances of the public index
672 # If this option is enabled, use the mute feature instead of deleting followings
673 # /!\ Don't enable this if you don't have a reactive moderation team /!\
676 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
684 message: '' # Support markdown
685 level: 'info' # 'info' | 'warning' | 'error'
689 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
690 # If enabled, the associated group will be able to "escape" from the instance follows
691 # That means they will be able to follow channels, watch videos, list videos of non followed instances
696 # Use a third party index instead of your local index, only for search results
697 # Useful to discover content outside of your instance
698 # If you enable search_index, you must enable remote_uri search for users
699 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
700 # instead of loading the video locally
703 # URL of the search index, that should use the same search API and routes
704 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
705 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
706 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
708 # You can disable local search, so users only use the search index
709 disable_local_search: false
710 # If you did not disable local search, you can decide to use the search index by default
711 is_default_search: false
713 # PeerTube client/interface configuration
717 # By default PeerTube client displays author username
718 prefer_author_display_name: false
719 display_author_avatar: false
721 # Max size of upload chunks, e.g. '90MB'
722 # If null, it will be calculated based on network speed
727 # If you enable only one external auth plugin
728 # You can automatically redirect your users on this external platform when they click on the login button
729 redirect_on_single_external_auth: false