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)
13 # Secrets you need to generate the first time you run PeerTube
19 # 50 attempts in 10 seconds
23 # 15 attempts in 5 min
27 # 2 attempts in 5 min (only succeeded attempts are taken into account)
35 # 10 attempts in 10 min
39 # Proxies to trust to get real client IP
40 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
41 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
45 # Your database name will be database.name OR 'peertube'+database.suffix
56 # Redis server for short time storage
57 # You can also specify a 'socket' path to a unix socket but first need to
58 # set 'hostname' and 'port' to null
65 # SMTP server to send emails
69 # Path to sendmail command. Required if you use sendmail transport
72 port: 465 # If you use StartTLS: 587
75 tls: true # If you use StartTLS: false
76 disable_starttls: false
77 ca_file: null # Used for self signed certificates
78 from_address: 'admin@example.com'
86 # Update default PeerTube values
87 # Set by API when the field is not provided and put as default value in client
89 # Change default values when publishing a video (upload/import/go Live)
91 download_enabled: true
93 comments_enabled: true
95 # public = 1, unlisted = 2, private = 3, internal = 4
98 # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
99 # You can also choose a custom licence value added by a plugin
100 # No licence by default
104 # Enable P2P by default in PeerTube client
105 # Can be enabled/disabled by anonymous users and logged in users
109 # Enable P2P by default in PeerTube embed
110 # Can be enabled/disabled by URL option
114 # From the project root directory
116 tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
118 avatars: 'storage/avatars/'
119 videos: 'storage/videos/'
120 streaming_playlists: 'storage/streaming-playlists/'
121 redundancy: 'storage/redundancy/'
122 logs: 'storage/logs/'
123 previews: 'storage/previews/'
124 thumbnails: 'storage/thumbnails/'
125 torrents: 'storage/torrents/'
126 captions: 'storage/captions/'
127 cache: 'storage/cache/'
128 plugins: 'storage/plugins/'
129 well_known: 'storage/well-known/'
130 # Overridable client files in client/dist/assets/images:
133 # - default-playlist.jpg
134 # - default-avatar-account.png
135 # - default-avatar-video-channel.png
136 # - and icons/*.png (PWA)
137 # Could contain for example assets/images/favicon.png
138 # If the file exists, peertube will serve it
139 # If not, peertube will fallback to the default file
140 client_overrides: 'storage/client-overrides/'
145 # Without protocol, will default to HTTPS
146 endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
150 # Set this ACL on each uploaded object
151 upload_acl: 'public-read'
154 # You can also use AWS_ACCESS_KEY_ID env variable
156 # You can also use AWS_SECRET_ACCESS_KEY env variable
157 secret_access_key: ''
159 # Maximum amount to upload in one request to object storage
160 max_upload_part: 100MB
163 bucket_name: 'streaming-playlists'
165 # Allows setting all buckets to the same value but with a different prefix
166 prefix: '' # Example: 'streaming-playlists:'
168 # Base url for object URL generation, scheme and host will be replaced by this URL
169 # Useful when you want to use a CDN/external proxy
170 base_url: '' # Example: 'https://mirror.example.com'
172 # Same settings but for webtorrent videos
174 bucket_name: 'videos'
179 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
182 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
188 log_ping_requests: true
189 log_tracker_unknown_infohash: true
193 # Accept warn/error logs coming from the client
194 accept_client_log: true
196 # Highly experimental support of Open Telemetry
201 # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics
208 # Send traces to a Jaeger compatible endpoint
214 interval_days: 7 # Compute trending videos for the last x days
217 - 'hot' # adaptation of Reddit's 'Hot' algorithm
218 - 'most-viewed' # default, used initially by PeerTube as the trending page
220 default: 'most-viewed'
222 # Cache remote videos on your server, to help other instances to broadcast the video
223 # You can define multiple caches using different sizes/strategies
224 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
227 check_interval: '1 hour' # How often you want to check new videos to cache
228 strategies: # Just uncomment strategies you want
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: 'most-views' # Cache videos that have the most views
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: 'trending' # Cache trending videos
241 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
242 # min_lifetime: '48 hours'
243 # strategy: 'recently-added' # Cache recently added videos
244 # min_views: 10 # Having at least x views
246 # Other instances that duplicate your content
249 # 'nobody': Do not accept remote redundancies
250 # 'anybody': Accept remote redundancies from anybody
251 # 'followings': Accept redundancies from instance followings
252 accept_from: 'anybody'
256 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
260 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
265 # If you disable the tracker, you disable the P2P on your PeerTube instance
267 # Only handle requests on your videos
268 # If you set this to false it means you have a public tracker
269 # Then, it is possible that clients overload your instance with external torrents
271 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
272 reject_too_many_announces: false
276 # If you want to limit users videos history
277 # -1 means there is no limitations
278 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
283 # PeerTube creates a database entry every hour for each video to track views over a period of time
284 # This is used in particular by the Trending page
285 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
286 # -1 means no cleanup
287 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
291 # PeerTube buffers local video views before updating and federating the video
292 local_buffer_update_interval: '30 minutes'
294 ip_view_expiration: '1 hour'
296 # Used to get country location of views of local videos
301 database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
304 # The website PeerTube will ask for available PeerTube plugins and themes
305 # This is an unmoderated plugin index, so only install plugins/themes you trust
308 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
309 url: 'https://packages.joinpeertube.org'
313 federate_unlisted: false
315 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
316 # It removes objects that do not exist anymore, and potentially fix their URLs
317 cleanup_remote_interactions: true
320 check_latest_version:
321 # Check and notify admins of new PeerTube versions
323 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
324 url: 'https://joinpeertube.org/api/v1/versions.json'
329 # Set this to false if you don't want to allow config edition in the web interface by instance admins
332 # XML, Atom or JSON feeds
335 # Default number of videos displayed in feeds
339 # Default number of comments displayed in feeds
344 size: 500 # Max number of previews you want to cache
346 size: 500 # Max number of video captions/subtitles you want to cache
348 size: 500 # Max number of video torrents you want to cache
351 # Used to generate the root user at first startup
352 # And to receive emails from the contact form
353 email: 'admin@example.com'
360 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
361 minimum_age: 16 # Used to configure the signup form
362 requires_email_verification: false
364 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
369 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
370 # Byte format is supported ("1GB" etc)
373 video_quota_daily: -1
376 max_per_user: 20 # Allows each user to create up to 20 video channels.
378 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
379 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
380 # Please, do not disable transcoding since many uploaded videos will not work
384 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
385 allow_additional_extensions: true
387 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
388 allow_audio_files: true
390 # Amount of threads used by ffmpeg for 1 transcoding job
392 # Amount of transcoding jobs to execute in parallel
395 # Choose the transcoding profile
396 # New profiles can be added by plugins
397 # Available in core PeerTube: 'default'
400 resolutions: # Only created if the original video has a higher resolution, uses more storage!
401 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
411 # Transcode and keep original resolution, even if it's above your maximum enabled resolution
412 always_transcode_original_resolution: true
414 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
415 # If you also enabled the hls format, it will multiply videos storage by 2
416 # If disabled, breaks federation with PeerTube instances < 2.1
420 # /!\ Requires ffmpeg >= 4.1
421 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
422 # * Resolution change is smoother
423 # * Faster playback in particular with long videos
424 # * More stable playback (less bugs/infinite loading)
425 # If you also enabled the webtorrent format, it will multiply videos storage by 2
432 # Limit lives duration
434 max_duration: -1 # For example: '5 hours'
436 # Limit max number of live videos created on your instance
438 max_instance_lives: 20
440 # Limit max number of live videos created by a user on your instance
444 # Allow your users to save a replay of their live
445 # PeerTube will transcode segments in a video file
446 # If the user daily/total quota is reached, PeerTube will stop the live
447 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
450 # Allow your users to change latency settings (small latency/default/high latency)
451 # Small latency live streams cannot use P2P
452 # High latency live streams can increase P2P ratio
456 # Your firewall should accept traffic from this port in TCP if you enable live
460 # Listening hostname/port for RTMP server
461 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
462 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
466 # Public hostname of your RTMP server
467 # Use null to use the same value than `webserver.hostname`
468 public_hostname: null
473 # Listening hostname/port for RTMPS server
474 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
475 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
483 # Public hostname of your RTMPS server
484 # Use null to use the same value than `webserver.hostname`
485 public_hostname: null
487 # Allow to transcode the live streaming in multiple live resolutions
492 # Choose the transcoding profile
493 # New profiles can be added by plugins
494 # Available in core PeerTube: 'default'
507 # Also transcode original resolution, even if it's above your maximum enabled resolution
508 always_transcode_original_resolution: true
511 # Enable video edition by users (cut, add intro/outro, add watermark etc)
512 # If enabled, users can create transcoding tasks as they wish
516 # Add ability for your users to import remote videos (from YouTube, torrent...)
518 # Amount of import jobs to execute in parallel
521 # Set a custom video import timeout to not block import queue
524 # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
526 # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
527 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
531 # Direct download URL to youtube-dl binary
532 # Github releases API is also supported
534 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
535 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
536 # * https://yt-dl.org/downloads/latest/youtube-dl
537 url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
539 # Release binary name: 'yt-dlp' or 'youtube-dl'
542 # Path to the python binary to execute for youtube-dl or yt-dlp
543 python_path: '/usr/bin/python3'
545 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
548 # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
550 # We recommend to only enable magnet URI/torrent import if you trust your users
551 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
554 # Add ability for your users to synchronize their channels with external channels, playlists, etc
555 video_channel_synchronization:
560 check_interval: 1 hour
562 # Number of latest published videos to check and to potentially import when syncing a channel
563 videos_limit_per_synchronization: 10
566 # New videos automatically blacklisted so moderators can review before publishing
574 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
575 description: 'Welcome to this PeerTube instance!' # Support markdown
576 terms: 'No terms for now.' # Support markdown
577 code_of_conduct: '' # Supports markdown
579 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
580 moderation_information: '' # Supports markdown
582 # Why did you create this instance?
583 creation_reason: '' # Supports Markdown
585 # Who is behind the instance? A single person? A non profit?
586 administrator: '' # Supports Markdown
588 # How long do you plan to maintain this instance?
589 maintenance_lifetime: '' # Supports Markdown
591 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
592 business_model: '' # Supports Markdown
594 # If you want to explain on what type of hardware your PeerTube instance runs
595 # Example: '2 vCore, 2GB RAM...'
596 hardware_information: '' # Supports Markdown
598 # What are the main languages of your instance? To interact with your users for example
599 # Uncomment or add the languages you want
600 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
606 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
607 # Uncomment or add the category ids you want
608 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
619 # - 10 # Entertainment
620 # - 11 # News & Politics
624 # - 15 # Science & Technology
629 default_client_route: '/videos/trending'
631 # Whether or not the instance is dedicated to NSFW content
632 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
633 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
635 # By default, `do_not_list` or `blur` or `display` NSFW videos
636 # Could be overridden per user with a setting
637 default_nsfw_policy: 'do_not_list'
640 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
641 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
642 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
646 # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes
647 # To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
649 '# 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:'
652 # Cards configuration to format video in Twitter
654 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
655 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
656 # If false, we use an image link card that will redirect on your PeerTube instance
657 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
662 # Allow or not other instances to follow yours
664 # Whether or not an administrator must manually validate a new follower
665 manual_approval: false
669 # If you want to automatically follow back new instance followers
670 # If this option is enabled, use the mute feature instead of deleting followings
671 # /!\ Don't enable this if you don't have a reactive moderation team /!\
675 # If you want to automatically follow instances of the public index
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 /!\
680 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
688 message: '' # Support markdown
689 level: 'info' # 'info' | 'warning' | 'error'
693 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
694 # If enabled, the associated group will be able to "escape" from the instance follows
695 # That means they will be able to follow channels, watch videos, list videos of non followed instances
700 # Use a third party index instead of your local index, only for search results
701 # Useful to discover content outside of your instance
702 # If you enable search_index, you must enable remote_uri search for users
703 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
704 # instead of loading the video locally
707 # URL of the search index, that should use the same search API and routes
708 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
709 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
710 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
712 # You can disable local search, so users only use the search index
713 disable_local_search: false
714 # If you did not disable local search, you can decide to use the search index by default
715 is_default_search: false
717 # PeerTube client/interface configuration
721 # By default PeerTube client displays author username
722 prefer_author_display_name: false
723 display_author_avatar: false
725 # Max size of upload chunks, e.g. '90MB'
726 # If null, it will be calculated based on network speed
731 # If you enable only one external auth plugin
732 # You can automatically redirect your users on this external platform when they click on the login button
733 redirect_on_single_external_auth: false