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/'
144 # Require and check user authentication when accessing private files (internal/private video files)
145 private_files_require_auth: true
150 # Without protocol, will default to HTTPS
151 endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
156 # Set this ACL on each uploaded object of public/unlisted videos
157 public: 'public-read'
158 # Set this ACL on each uploaded object of private/internal videos
159 # PeerTube can proxify requests to private objects so your users can access them
163 # If private files (private/internal video files) have a private ACL, users can't access directly the ressource
164 # PeerTube can proxify requests between your object storage service and your users
165 # If you disable PeerTube proxy, ensure you use your own proxy that is able to access the private files
166 # Or you can also set a public ACL for private files in object storage if you don't want to use a proxy
167 proxify_private_files: true
170 # You can also use AWS_ACCESS_KEY_ID env variable
172 # You can also use AWS_SECRET_ACCESS_KEY env variable
173 secret_access_key: ''
175 # Maximum amount to upload in one request to object storage
176 max_upload_part: 100MB
179 bucket_name: 'streaming-playlists'
181 # Allows setting all buckets to the same value but with a different prefix
182 prefix: '' # Example: 'streaming-playlists:'
184 # Base url for object URL generation, scheme and host will be replaced by this URL
185 # Useful when you want to use a CDN/external proxy
186 base_url: '' # Example: 'https://mirror.example.com'
188 # Same settings but for webtorrent videos
190 bucket_name: 'videos'
195 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
198 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
204 log_ping_requests: true
205 log_tracker_unknown_infohash: true
209 # Accept warn/error logs coming from the client
210 accept_client_log: true
212 # Support of Open Telemetry metrics and tracing
213 # For more information: https://docs.joinpeertube.org/maintain-observability
218 # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics
220 hostname: '127.0.0.1'
226 # Send traces to a Jaeger compatible endpoint
232 interval_days: 7 # Compute trending videos for the last x days
235 - 'hot' # adaptation of Reddit's 'Hot' algorithm
236 - 'most-viewed' # default, used initially by PeerTube as the trending page
238 default: 'most-viewed'
240 # Cache remote videos on your server, to help other instances to broadcast the video
241 # You can define multiple caches using different sizes/strategies
242 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
245 check_interval: '1 hour' # How often you want to check new videos to cache
246 strategies: # Just uncomment strategies you want
249 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
250 # min_lifetime: '48 hours'
251 # strategy: 'most-views' # Cache videos that have the most views
254 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
255 # min_lifetime: '48 hours'
256 # strategy: 'trending' # Cache trending videos
259 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
260 # min_lifetime: '48 hours'
261 # strategy: 'recently-added' # Cache recently added videos
262 # min_views: 10 # Having at least x views
264 # Other instances that duplicate your content
267 # 'nobody': Do not accept remote redundancies
268 # 'anybody': Accept remote redundancies from anybody
269 # 'followings': Accept redundancies from instance followings
270 accept_from: 'anybody'
274 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
278 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
283 # If you disable the tracker, you disable the P2P on your PeerTube instance
285 # Only handle requests on your videos
286 # If you set this to false it means you have a public tracker
287 # Then, it is possible that clients overload your instance with external torrents
289 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
290 reject_too_many_announces: false
294 # If you want to limit users videos history
295 # -1 means there is no limitations
296 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
301 # PeerTube creates a database entry every hour for each video to track views over a period of time
302 # This is used in particular by the Trending page
303 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
304 # -1 means no cleanup
305 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
309 # PeerTube buffers local video views before updating and federating the video
310 local_buffer_update_interval: '30 minutes'
312 ip_view_expiration: '1 hour'
314 # Used to get country location of views of local videos
319 database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
322 # The website PeerTube will ask for available PeerTube plugins and themes
323 # This is an unmoderated plugin index, so only install plugins/themes you trust
326 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
327 url: 'https://packages.joinpeertube.org'
331 federate_unlisted: false
333 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
334 # It removes objects that do not exist anymore, and potentially fix their URLs
335 cleanup_remote_interactions: true
338 check_latest_version:
339 # Check and notify admins of new PeerTube versions
341 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
342 url: 'https://joinpeertube.org/api/v1/versions.json'
347 # Set this to false if you don't want to allow config edition in the web interface by instance admins
350 # XML, Atom or JSON feeds
353 # Default number of videos displayed in feeds
357 # Default number of comments displayed in feeds
362 size: 500 # Max number of previews you want to cache
364 size: 500 # Max number of video captions/subtitles you want to cache
366 size: 500 # Max number of video torrents you want to cache
369 # Used to generate the root user at first startup
370 # And to receive emails from the contact form
371 email: 'admin@example.com'
378 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
379 minimum_age: 16 # Used to configure the signup form
380 requires_email_verification: false
382 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
387 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
388 # Byte format is supported ("1GB" etc)
391 video_quota_daily: -1
394 max_per_user: 20 # Allows each user to create up to 20 video channels.
396 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
397 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
398 # Please, do not disable transcoding since many uploaded videos will not work
402 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
403 allow_additional_extensions: true
405 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
406 allow_audio_files: true
408 # Amount of threads used by ffmpeg for 1 transcoding job
410 # Amount of transcoding jobs to execute in parallel
413 # Choose the transcoding profile
414 # New profiles can be added by plugins
415 # Available in core PeerTube: 'default'
418 resolutions: # Only created if the original video has a higher resolution, uses more storage!
419 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
429 # Transcode and keep original resolution, even if it's above your maximum enabled resolution
430 always_transcode_original_resolution: true
432 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
433 # If you also enabled the hls format, it will multiply videos storage by 2
434 # If disabled, breaks federation with PeerTube instances < 2.1
438 # /!\ Requires ffmpeg >= 4.1
439 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
440 # * Resolution change is smoother
441 # * Faster playback in particular with long videos
442 # * More stable playback (less bugs/infinite loading)
443 # If you also enabled the webtorrent format, it will multiply videos storage by 2
450 # Limit lives duration
452 max_duration: -1 # For example: '5 hours'
454 # Limit max number of live videos created on your instance
456 max_instance_lives: 20
458 # Limit max number of live videos created by a user on your instance
462 # Allow your users to save a replay of their live
463 # PeerTube will transcode segments in a video file
464 # If the user daily/total quota is reached, PeerTube will stop the live
465 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
468 # Allow your users to change latency settings (small latency/default/high latency)
469 # Small latency live streams cannot use P2P
470 # High latency live streams can increase P2P ratio
474 # Your firewall should accept traffic from this port in TCP if you enable live
478 # Listening hostname/port for RTMP server
479 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
480 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
484 # Public hostname of your RTMP server
485 # Use null to use the same value than `webserver.hostname`
486 public_hostname: null
491 # Listening hostname/port for RTMPS server
492 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
493 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
501 # Public hostname of your RTMPS server
502 # Use null to use the same value than `webserver.hostname`
503 public_hostname: null
505 # Allow to transcode the live streaming in multiple live resolutions
510 # Choose the transcoding profile
511 # New profiles can be added by plugins
512 # Available in core PeerTube: 'default'
525 # Also transcode original resolution, even if it's above your maximum enabled resolution
526 always_transcode_original_resolution: true
529 # Enable video edition by users (cut, add intro/outro, add watermark etc)
530 # If enabled, users can create transcoding tasks as they wish
534 # Add ability for your users to import remote videos (from YouTube, torrent...)
536 # Amount of import jobs to execute in parallel
539 # Set a custom video import timeout to not block import queue
542 # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
544 # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
545 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
549 # Direct download URL to youtube-dl binary
550 # Github releases API is also supported
552 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
553 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
554 # * https://yt-dl.org/downloads/latest/youtube-dl
555 url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
557 # Release binary name: 'yt-dlp' or 'youtube-dl'
560 # Path to the python binary to execute for youtube-dl or yt-dlp
561 python_path: '/usr/bin/python3'
563 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
566 # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
568 # We recommend to only enable magnet URI/torrent import if you trust your users
569 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
572 # Add ability for your users to synchronize their channels with external channels, playlists, etc
573 video_channel_synchronization:
578 check_interval: 1 hour
580 # Number of latest published videos to check and to potentially import when syncing a channel
581 videos_limit_per_synchronization: 10
583 # Max number of videos to import when the user asks for full sync
584 full_sync_videos_limit: 1000
587 # New videos automatically blacklisted so moderators can review before publishing
595 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
596 description: 'Welcome to this PeerTube instance!' # Support markdown
597 terms: 'No terms for now.' # Support markdown
598 code_of_conduct: '' # Supports markdown
600 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
601 moderation_information: '' # Supports markdown
603 # Why did you create this instance?
604 creation_reason: '' # Supports Markdown
606 # Who is behind the instance? A single person? A non profit?
607 administrator: '' # Supports Markdown
609 # How long do you plan to maintain this instance?
610 maintenance_lifetime: '' # Supports Markdown
612 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
613 business_model: '' # Supports Markdown
615 # If you want to explain on what type of hardware your PeerTube instance runs
616 # Example: '2 vCore, 2GB RAM...'
617 hardware_information: '' # Supports Markdown
619 # What are the main languages of your instance? To interact with your users for example
620 # Uncomment or add the languages you want
621 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
627 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
628 # Uncomment or add the category ids you want
629 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
640 # - 10 # Entertainment
641 # - 11 # News & Politics
645 # - 15 # Science & Technology
650 default_client_route: '/videos/trending'
652 # Whether or not the instance is dedicated to NSFW content
653 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
654 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
656 # By default, `do_not_list` or `blur` or `display` NSFW videos
657 # Could be overridden per user with a setting
658 default_nsfw_policy: 'do_not_list'
661 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
662 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
663 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
667 # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes
668 # To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
670 '# 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:'
673 # Cards configuration to format video in Twitter
675 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
676 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
677 # If false, we use an image link card that will redirect on your PeerTube instance
678 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
683 # Allow or not other instances to follow yours
685 # Whether or not an administrator must manually validate a new follower
686 manual_approval: false
690 # If you want to automatically follow back new instance followers
691 # If this option is enabled, use the mute feature instead of deleting followings
692 # /!\ Don't enable this if you don't have a reactive moderation team /!\
696 # If you want to automatically follow instances of the public index
697 # If this option is enabled, use the mute feature instead of deleting followings
698 # /!\ Don't enable this if you don't have a reactive moderation team /!\
701 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
709 message: '' # Support markdown
710 level: 'info' # 'info' | 'warning' | 'error'
714 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
715 # If enabled, the associated group will be able to "escape" from the instance follows
716 # That means they will be able to follow channels, watch videos, list videos of non followed instances
721 # Use a third party index instead of your local index, only for search results
722 # Useful to discover content outside of your instance
723 # If you enable search_index, you must enable remote_uri search for users
724 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
725 # instead of loading the video locally
728 # URL of the search index, that should use the same search API and routes
729 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
730 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
731 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
733 # You can disable local search, so users only use the search index
734 disable_local_search: false
735 # If you did not disable local search, you can decide to use the search index by default
736 is_default_search: false
738 # PeerTube client/interface configuration
742 # By default PeerTube client displays author username
743 prefer_author_display_name: false
744 display_author_avatar: false
746 # Max size of upload chunks, e.g. '90MB'
747 # If null, it will be calculated based on network speed
752 # If you enable only one external auth plugin
753 # You can automatically redirect your users on this external platform when they click on the login button
754 redirect_on_single_external_auth: false