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 # Proxies to trust to get real client IP
32 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
33 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
37 # Your database name will be database.name OR 'peertube'+database.suffix
48 # Redis server for short time storage
49 # You can also specify a 'socket' path to a unix socket but first need to
50 # set 'hostname' and 'port' to null
57 # SMTP server to send emails
61 # Path to sendmail command. Required if you use sendmail transport
64 port: 465 # If you use StartTLS: 587
67 tls: true # If you use StartTLS: false
68 disable_starttls: false
69 ca_file: null # Used for self signed certificates
70 from_address: 'admin@example.com'
78 # Update default PeerTube values
79 # Set by API when the field is not provided and put as default value in client
81 # Change default values when publishing a video (upload/import/go Live)
83 download_enabled: true
85 comments_enabled: true
87 # public = 1, unlisted = 2, private = 3, internal = 4
90 # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
91 # You can also choose a custom licence value added by a plugin
92 # No licence by default
96 # Enable P2P by default in PeerTube client
97 # Can be enabled/disabled by anonymous users and logged in users
101 # Enable P2P by default in PeerTube embed
102 # Can be enabled/disabled by URL option
106 # From the project root directory
108 tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
110 avatars: 'storage/avatars/'
111 videos: 'storage/videos/'
112 streaming_playlists: 'storage/streaming-playlists/'
113 redundancy: 'storage/redundancy/'
114 logs: 'storage/logs/'
115 previews: 'storage/previews/'
116 thumbnails: 'storage/thumbnails/'
117 torrents: 'storage/torrents/'
118 captions: 'storage/captions/'
119 cache: 'storage/cache/'
120 plugins: 'storage/plugins/'
121 # Overridable client files in client/dist/assets/images:
124 # - default-playlist.jpg
125 # - default-avatar-account.png
126 # - default-avatar-video-channel.png
127 # - and icons/*.png (PWA)
128 # Could contain for example assets/images/favicon.png
129 # If the file exists, peertube will serve it
130 # If not, peertube will fallback to the default file
131 client_overrides: 'storage/client-overrides/'
136 # Without protocol, will default to HTTPS
137 endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
141 # Set this ACL on each uploaded object
142 upload_acl: 'public-read'
145 # You can also use AWS_ACCESS_KEY_ID env variable
147 # You can also use AWS_SECRET_ACCESS_KEY env variable
148 secret_access_key: ''
150 # Maximum amount to upload in one request to object storage
154 bucket_name: 'streaming-playlists'
156 # Allows setting all buckets to the same value but with a different prefix
157 prefix: '' # Example: 'streaming-playlists:'
159 # Base url for object URL generation, scheme and host will be replaced by this URL
160 # Useful when you want to use a CDN/external proxy
161 base_url: '' # Example: 'https://mirror.example.com'
163 # Same settings but for webtorrent videos
165 bucket_name: 'videos'
170 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
172 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
176 log_ping_requests: true
181 interval_days: 7 # Compute trending videos for the last x days
184 - 'best' # adaptation of Reddit's 'Best' algorithm (Hot minus History)
185 - 'hot' # adaptation of Reddit's 'Hot' algorithm
186 - 'most-viewed' # default, used initially by PeerTube as the trending page
188 default: 'most-viewed'
190 # Cache remote videos on your server, to help other instances to broadcast the video
191 # You can define multiple caches using different sizes/strategies
192 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
195 check_interval: '1 hour' # How often you want to check new videos to cache
196 strategies: # Just uncomment strategies you want
199 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
200 # min_lifetime: '48 hours'
201 # strategy: 'most-views' # Cache videos that have the most views
204 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
205 # min_lifetime: '48 hours'
206 # strategy: 'trending' # Cache trending videos
209 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
210 # min_lifetime: '48 hours'
211 # strategy: 'recently-added' # Cache recently added videos
212 # min_views: 10 # Having at least x views
214 # Other instances that duplicate your content
217 # 'nobody': Do not accept remote redundancies
218 # 'anybody': Accept remote redundancies from anybody
219 # 'followings': Accept redundancies from instance followings
220 accept_from: 'anybody'
224 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
228 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
233 # If you disable the tracker, you disable the P2P on your PeerTube instance
235 # Only handle requests on your videos
236 # If you set this to false it means you have a public tracker
237 # Then, it is possible that clients overload your instance with external torrents
239 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
240 reject_too_many_announces: false
244 # If you want to limit users videos history
245 # -1 means there is no limitations
246 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
251 # PeerTube creates a database entry every hour for each video to track views over a period of time
252 # This is used in particular by the Trending page
253 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
254 # -1 means no cleanup
255 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
259 # PeerTube buffers local video views before updating and federating the video
260 local_buffer_update_interval: '30 minutes'
262 ip_view_expiration: '1 hour'
264 # Used to get country location of views of local videos
269 database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
272 # The website PeerTube will ask for available PeerTube plugins and themes
273 # This is an unmoderated plugin index, so only install plugins/themes you trust
276 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
277 url: 'https://packages.joinpeertube.org'
281 federate_unlisted: false
283 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
284 # It removes objects that do not exist anymore, and potentially fix their URLs
285 cleanup_remote_interactions: true
288 check_latest_version:
289 # Check and notify admins of new PeerTube versions
291 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
292 url: 'https://joinpeertube.org/api/v1/versions.json'
297 # Set this to false if you don't want to allow config edition in the web interface by instance admins
302 size: 500 # Max number of previews you want to cache
304 size: 500 # Max number of video captions/subtitles you want to cache
306 size: 500 # Max number of video torrents you want to cache
309 # Used to generate the root user at first startup
310 # And to receive emails from the contact form
311 email: 'admin@example.com'
318 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
319 minimum_age: 16 # Used to configure the signup form
320 requires_email_verification: false
322 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
327 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
328 # Byte format is supported ("1GB" etc)
331 video_quota_daily: -1
334 max_per_user: 20 # Allows each user to create up to 20 video channels.
336 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
337 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
338 # Please, do not disable transcoding since many uploaded videos will not work
342 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
343 allow_additional_extensions: true
345 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
346 allow_audio_files: true
348 # Amount of threads used by ffmpeg for 1 transcoding job
350 # Amount of transcoding jobs to execute in parallel
353 # Choose the transcoding profile
354 # New profiles can be added by plugins
355 # Available in core PeerTube: 'default'
358 resolutions: # Only created if the original video has a higher resolution, uses more storage!
359 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
369 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
370 # If you also enabled the hls format, it will multiply videos storage by 2
371 # If disabled, breaks federation with PeerTube instances < 2.1
375 # /!\ Requires ffmpeg >= 4.1
376 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
377 # * Resolution change is smoother
378 # * Faster playback in particular with long videos
379 # * More stable playback (less bugs/infinite loading)
380 # If you also enabled the webtorrent format, it will multiply videos storage by 2
387 # Limit lives duration
389 max_duration: -1 # For example: '5 hours'
391 # Limit max number of live videos created on your instance
393 max_instance_lives: 20
395 # Limit max number of live videos created by a user on your instance
399 # Allow your users to save a replay of their live
400 # PeerTube will transcode segments in a video file
401 # If the user daily/total quota is reached, PeerTube will stop the live
402 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
405 # Allow your users to change latency settings (small latency/default/high latency)
406 # Small latency live streams cannot use P2P
407 # High latency live streams can increase P2P ratio
411 # Your firewall should accept traffic from this port in TCP if you enable live
415 # Listening hostname/port for RTMP server
416 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
417 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
421 # Public hostname of your RTMP server
422 # Use null to use the same value than `webserver.hostname`
423 public_hostname: null
428 # Listening hostname/port for RTMPS server
429 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
430 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
438 # Public hostname of your RTMPS server
439 # Use null to use the same value than `webserver.hostname`
440 public_hostname: null
442 # Allow to transcode the live streaming in multiple live resolutions
447 # Choose the transcoding profile
448 # New profiles can be added by plugins
449 # Available in core PeerTube: 'default'
463 # Enable video edition by users (cut, add intro/outro, add watermark etc)
467 # Add ability for your users to import remote videos (from YouTube, torrent...)
469 # Amount of import jobs to execute in parallel
472 # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
474 # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
475 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
479 # Direct download URL to youtube-dl binary
480 # Github releases API is also supported
482 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
483 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
484 url: 'https://yt-dl.org/downloads/latest/youtube-dl'
486 # youtube-dl binary name
487 # yt-dlp is also supported
490 # Path to the python binary to execute for youtube-dl or yt-dlp
491 python_path: '/usr/bin/python3'
493 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
496 # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
498 # We recommend to only enable magnet URI/torrent import if you trust your users
499 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
503 # New videos automatically blacklisted so moderators can review before publishing
511 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
512 description: 'Welcome to this PeerTube instance!' # Support markdown
513 terms: 'No terms for now.' # Support markdown
514 code_of_conduct: '' # Supports markdown
516 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
517 moderation_information: '' # Supports markdown
519 # Why did you create this instance?
520 creation_reason: '' # Supports Markdown
522 # Who is behind the instance? A single person? A non profit?
523 administrator: '' # Supports Markdown
525 # How long do you plan to maintain this instance?
526 maintenance_lifetime: '' # Supports Markdown
528 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
529 business_model: '' # Supports Markdown
531 # If you want to explain on what type of hardware your PeerTube instance runs
532 # Example: '2 vCore, 2GB RAM...'
533 hardware_information: '' # Supports Markdown
535 # What are the main languages of your instance? To interact with your users for example
536 # Uncomment or add the languages you want
537 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
543 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
544 # Uncomment or add the category ids you want
545 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
556 # - 10 # Entertainment
557 # - 11 # News & Politics
561 # - 15 # Science & Technology
566 default_client_route: '/videos/trending'
568 # Whether or not the instance is dedicated to NSFW content
569 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
570 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
572 # By default, `do_not_list` or `blur` or `display` NSFW videos
573 # Could be overridden per user with a setting
574 default_nsfw_policy: 'do_not_list'
577 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
578 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
579 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
583 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
585 '# 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:'
588 # Cards configuration to format video in Twitter
590 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
591 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
592 # If false, we use an image link card that will redirect on your PeerTube instance
593 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
598 # Allow or not other instances to follow yours
600 # Whether or not an administrator must manually validate a new follower
601 manual_approval: false
605 # If you want to automatically follow back new instance followers
606 # If this option is enabled, use the mute feature instead of deleting followings
607 # /!\ Don't enable this if you don't have a reactive moderation team /!\
611 # If you want to automatically follow instances of the public index
612 # If this option is enabled, use the mute feature instead of deleting followings
613 # /!\ Don't enable this if you don't have a reactive moderation team /!\
616 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
624 message: '' # Support markdown
625 level: 'info' # 'info' | 'warning' | 'error'
629 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
630 # If enabled, the associated group will be able to "escape" from the instance follows
631 # That means they will be able to follow channels, watch videos, list videos of non followed instances
636 # Use a third party index instead of your local index, only for search results
637 # Useful to discover content outside of your instance
638 # If you enable search_index, you must enable remote_uri search for users
639 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
640 # instead of loading the video locally
643 # URL of the search index, that should use the same search API and routes
644 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
645 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
646 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
648 # You can disable local search, so users only use the search index
649 disable_local_search: false
650 # If you did not disable local search, you can decide to use the search index by default
651 is_default_search: false
653 # PeerTube client/interface configuration
657 # By default PeerTube client displays author username
658 prefer_author_display_name: false
659 display_author_avatar: false
661 # Max size of upload chunks, e.g. '90MB'
662 # If null, it will be calculated based on network speed
667 # If you enable only one external auth plugin
668 # You can automatically redirect your users on this external platform when they click on the login button
669 redirect_on_single_external_auth: false