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
15 # Generate one using `openssl rand -hex 32`
20 # 50 attempts in 10 seconds
24 # 15 attempts in 5 min
28 # 2 attempts in 5 min (only succeeded attempts are taken into account)
36 # 10 attempts in 10 min
40 # Proxies to trust to get real client IP
41 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
42 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
46 # Your database name will be database.name OR 'peertube'+database.suffix
57 # Redis server for short time storage
58 # You can also specify a 'socket' path to a unix socket but first need to
59 # set 'hostname' and 'port' to null
66 # SMTP server to send emails
70 # Path to sendmail command. Required if you use sendmail transport
73 port: 465 # If you use StartTLS: 587
76 tls: true # If you use StartTLS: false
77 disable_starttls: false
78 ca_file: null # Used for self signed certificates
79 from_address: 'admin@example.com'
87 # Update default PeerTube values
88 # Set by API when the field is not provided and put as default value in client
90 # Change default values when publishing a video (upload/import/go Live)
92 download_enabled: true
94 comments_enabled: true
96 # public = 1, unlisted = 2, private = 3, internal = 4
99 # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
100 # You can also choose a custom licence value added by a plugin
101 # No licence by default
105 # Enable P2P by default in PeerTube client
106 # Can be enabled/disabled by anonymous users and logged in users
110 # Enable P2P by default in PeerTube embed
111 # Can be enabled/disabled by URL option
115 # From the project root directory
117 tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
119 avatars: 'storage/avatars/'
120 videos: 'storage/videos/'
121 streaming_playlists: 'storage/streaming-playlists/'
122 redundancy: 'storage/redundancy/'
123 logs: 'storage/logs/'
124 previews: 'storage/previews/'
125 thumbnails: 'storage/thumbnails/'
126 torrents: 'storage/torrents/'
127 captions: 'storage/captions/'
128 cache: 'storage/cache/'
129 plugins: 'storage/plugins/'
130 well_known: 'storage/well-known/'
131 # Overridable client files in client/dist/assets/images:
134 # - default-playlist.jpg
135 # - default-avatar-account.png
136 # - default-avatar-video-channel.png
137 # - and icons/*.png (PWA)
138 # Could contain for example assets/images/favicon.png
139 # If the file exists, peertube will serve it
140 # If not, peertube will fallback to the default file
141 client_overrides: 'storage/client-overrides/'
146 # Without protocol, will default to HTTPS
147 endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
152 # Set this ACL on each uploaded object of public/unlisted videos
153 public: 'public-read'
154 # Set this ACL on each uploaded object of private/internal videos
158 # You can also use AWS_ACCESS_KEY_ID env variable
160 # You can also use AWS_SECRET_ACCESS_KEY env variable
161 secret_access_key: ''
163 # Maximum amount to upload in one request to object storage
164 max_upload_part: 100MB
167 bucket_name: 'streaming-playlists'
169 # Allows setting all buckets to the same value but with a different prefix
170 prefix: '' # Example: 'streaming-playlists:'
172 # Base url for object URL generation, scheme and host will be replaced by this URL
173 # Useful when you want to use a CDN/external proxy
174 base_url: '' # Example: 'https://mirror.example.com'
176 # Same settings but for webtorrent videos
178 bucket_name: 'videos'
183 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
186 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
192 log_ping_requests: true
193 log_tracker_unknown_infohash: true
197 # Accept warn/error logs coming from the client
198 accept_client_log: true
200 # Highly experimental support of Open Telemetry
205 # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics
212 # Send traces to a Jaeger compatible endpoint
218 interval_days: 7 # Compute trending videos for the last x days
221 - 'hot' # adaptation of Reddit's 'Hot' algorithm
222 - 'most-viewed' # default, used initially by PeerTube as the trending page
224 default: 'most-viewed'
226 # Cache remote videos on your server, to help other instances to broadcast the video
227 # You can define multiple caches using different sizes/strategies
228 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
231 check_interval: '1 hour' # How often you want to check new videos to cache
232 strategies: # Just uncomment strategies you want
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: 'most-views' # Cache videos that have the most views
240 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
241 # min_lifetime: '48 hours'
242 # strategy: 'trending' # Cache trending videos
245 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
246 # min_lifetime: '48 hours'
247 # strategy: 'recently-added' # Cache recently added videos
248 # min_views: 10 # Having at least x views
250 # Other instances that duplicate your content
253 # 'nobody': Do not accept remote redundancies
254 # 'anybody': Accept remote redundancies from anybody
255 # 'followings': Accept redundancies from instance followings
256 accept_from: 'anybody'
260 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
264 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
269 # If you disable the tracker, you disable the P2P on your PeerTube instance
271 # Only handle requests on your videos
272 # If you set this to false it means you have a public tracker
273 # Then, it is possible that clients overload your instance with external torrents
275 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
276 reject_too_many_announces: false
280 # If you want to limit users videos history
281 # -1 means there is no limitations
282 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
287 # PeerTube creates a database entry every hour for each video to track views over a period of time
288 # This is used in particular by the Trending page
289 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
290 # -1 means no cleanup
291 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
295 # PeerTube buffers local video views before updating and federating the video
296 local_buffer_update_interval: '30 minutes'
298 ip_view_expiration: '1 hour'
300 # Used to get country location of views of local videos
305 database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
308 # The website PeerTube will ask for available PeerTube plugins and themes
309 # This is an unmoderated plugin index, so only install plugins/themes you trust
312 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
313 url: 'https://packages.joinpeertube.org'
317 federate_unlisted: false
319 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
320 # It removes objects that do not exist anymore, and potentially fix their URLs
321 cleanup_remote_interactions: true
324 check_latest_version:
325 # Check and notify admins of new PeerTube versions
327 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
328 url: 'https://joinpeertube.org/api/v1/versions.json'
333 # Set this to false if you don't want to allow config edition in the web interface by instance admins
336 # XML, Atom or JSON feeds
339 # Default number of videos displayed in feeds
343 # Default number of comments displayed in feeds
348 size: 500 # Max number of previews you want to cache
350 size: 500 # Max number of video captions/subtitles you want to cache
352 size: 500 # Max number of video torrents you want to cache
355 # Used to generate the root user at first startup
356 # And to receive emails from the contact form
357 email: 'admin@example.com'
364 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
365 minimum_age: 16 # Used to configure the signup form
366 requires_email_verification: false
368 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
373 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
374 # Byte format is supported ("1GB" etc)
377 video_quota_daily: -1
380 max_per_user: 20 # Allows each user to create up to 20 video channels.
382 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
383 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
384 # Please, do not disable transcoding since many uploaded videos will not work
388 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
389 allow_additional_extensions: true
391 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
392 allow_audio_files: true
394 # Amount of threads used by ffmpeg for 1 transcoding job
396 # Amount of transcoding jobs to execute in parallel
399 # Choose the transcoding profile
400 # New profiles can be added by plugins
401 # Available in core PeerTube: 'default'
404 resolutions: # Only created if the original video has a higher resolution, uses more storage!
405 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
415 # Transcode and keep original resolution, even if it's above your maximum enabled resolution
416 always_transcode_original_resolution: true
418 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
419 # If you also enabled the hls format, it will multiply videos storage by 2
420 # If disabled, breaks federation with PeerTube instances < 2.1
424 # /!\ Requires ffmpeg >= 4.1
425 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
426 # * Resolution change is smoother
427 # * Faster playback in particular with long videos
428 # * More stable playback (less bugs/infinite loading)
429 # If you also enabled the webtorrent format, it will multiply videos storage by 2
436 # Limit lives duration
438 max_duration: -1 # For example: '5 hours'
440 # Limit max number of live videos created on your instance
442 max_instance_lives: 20
444 # Limit max number of live videos created by a user on your instance
448 # Allow your users to save a replay of their live
449 # PeerTube will transcode segments in a video file
450 # If the user daily/total quota is reached, PeerTube will stop the live
451 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
454 # Allow your users to change latency settings (small latency/default/high latency)
455 # Small latency live streams cannot use P2P
456 # High latency live streams can increase P2P ratio
460 # Your firewall should accept traffic from this port in TCP if you enable live
464 # Listening hostname/port for RTMP server
465 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
466 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
470 # Public hostname of your RTMP server
471 # Use null to use the same value than `webserver.hostname`
472 public_hostname: null
477 # Listening hostname/port for RTMPS server
478 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
479 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
487 # Public hostname of your RTMPS server
488 # Use null to use the same value than `webserver.hostname`
489 public_hostname: null
491 # Allow to transcode the live streaming in multiple live resolutions
496 # Choose the transcoding profile
497 # New profiles can be added by plugins
498 # Available in core PeerTube: 'default'
511 # Also transcode original resolution, even if it's above your maximum enabled resolution
512 always_transcode_original_resolution: true
515 # Enable video edition by users (cut, add intro/outro, add watermark etc)
516 # If enabled, users can create transcoding tasks as they wish
520 # Add ability for your users to import remote videos (from YouTube, torrent...)
522 # Amount of import jobs to execute in parallel
525 # Set a custom video import timeout to not block import queue
528 # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
530 # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
531 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
535 # Direct download URL to youtube-dl binary
536 # Github releases API is also supported
538 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
539 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
540 # * https://yt-dl.org/downloads/latest/youtube-dl
541 url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
543 # Release binary name: 'yt-dlp' or 'youtube-dl'
546 # Path to the python binary to execute for youtube-dl or yt-dlp
547 python_path: '/usr/bin/python3'
549 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
552 # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
554 # We recommend to only enable magnet URI/torrent import if you trust your users
555 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
558 # Add ability for your users to synchronize their channels with external channels, playlists, etc
559 video_channel_synchronization:
564 check_interval: 1 hour
566 # Number of latest published videos to check and to potentially import when syncing a channel
567 videos_limit_per_synchronization: 10
570 # New videos automatically blacklisted so moderators can review before publishing
578 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
579 description: 'Welcome to this PeerTube instance!' # Support markdown
580 terms: 'No terms for now.' # Support markdown
581 code_of_conduct: '' # Supports markdown
583 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
584 moderation_information: '' # Supports markdown
586 # Why did you create this instance?
587 creation_reason: '' # Supports Markdown
589 # Who is behind the instance? A single person? A non profit?
590 administrator: '' # Supports Markdown
592 # How long do you plan to maintain this instance?
593 maintenance_lifetime: '' # Supports Markdown
595 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
596 business_model: '' # Supports Markdown
598 # If you want to explain on what type of hardware your PeerTube instance runs
599 # Example: '2 vCore, 2GB RAM...'
600 hardware_information: '' # Supports Markdown
602 # What are the main languages of your instance? To interact with your users for example
603 # Uncomment or add the languages you want
604 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
610 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
611 # Uncomment or add the category ids you want
612 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
623 # - 10 # Entertainment
624 # - 11 # News & Politics
628 # - 15 # Science & Technology
633 default_client_route: '/videos/trending'
635 # Whether or not the instance is dedicated to NSFW content
636 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
637 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
639 # By default, `do_not_list` or `blur` or `display` NSFW videos
640 # Could be overridden per user with a setting
641 default_nsfw_policy: 'do_not_list'
644 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
645 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
646 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
650 # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes
651 # To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
653 '# 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:'
656 # Cards configuration to format video in Twitter
658 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
659 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
660 # If false, we use an image link card that will redirect on your PeerTube instance
661 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
666 # Allow or not other instances to follow yours
668 # Whether or not an administrator must manually validate a new follower
669 manual_approval: false
673 # If you want to automatically follow back new instance followers
674 # If this option is enabled, use the mute feature instead of deleting followings
675 # /!\ Don't enable this if you don't have a reactive moderation team /!\
679 # If you want to automatically follow instances of the public index
680 # If this option is enabled, use the mute feature instead of deleting followings
681 # /!\ Don't enable this if you don't have a reactive moderation team /!\
684 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
692 message: '' # Support markdown
693 level: 'info' # 'info' | 'warning' | 'error'
697 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
698 # If enabled, the associated group will be able to "escape" from the instance follows
699 # That means they will be able to follow channels, watch videos, list videos of non followed instances
704 # Use a third party index instead of your local index, only for search results
705 # Useful to discover content outside of your instance
706 # If you enable search_index, you must enable remote_uri search for users
707 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
708 # instead of loading the video locally
711 # URL of the search index, that should use the same search API and routes
712 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
713 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
714 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
716 # You can disable local search, so users only use the search index
717 disable_local_search: false
718 # If you did not disable local search, you can decide to use the search index by default
719 is_default_search: false
721 # PeerTube client/interface configuration
725 # By default PeerTube client displays author username
726 prefer_author_display_name: false
727 display_author_avatar: false
729 # Max size of upload chunks, e.g. '90MB'
730 # If null, it will be calculated based on network speed
735 # If you enable only one external auth plugin
736 # You can automatically redirect your users on this external platform when they click on the login button
737 redirect_on_single_external_auth: false