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
43 refresh_token: '2 weeks'
45 # Proxies to trust to get real client IP
46 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
47 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
51 # Your database name will be database.name OR 'peertube'+database.suffix
62 # Redis server for short time storage
63 # You can also specify a 'socket' path to a unix socket but first need to
64 # set 'hostname' and 'port' to null
71 # SMTP server to send emails
75 # Path to sendmail command. Required if you use sendmail transport
78 port: 465 # If you use StartTLS: 587
81 tls: true # If you use StartTLS: false
82 disable_starttls: false
83 ca_file: null # Used for self signed certificates
84 from_address: 'admin@example.com'
92 # Update default PeerTube values
93 # Set by API when the field is not provided and put as default value in client
95 # Change default values when publishing a video (upload/import/go Live)
97 download_enabled: true
99 comments_enabled: true
101 # public = 1, unlisted = 2, private = 3, internal = 4
104 # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
105 # You can also choose a custom licence value added by a plugin
106 # No licence by default
110 # Enable P2P by default in PeerTube client
111 # Can be enabled/disabled by anonymous users and logged in users
115 # Enable P2P by default in PeerTube embed
116 # Can be enabled/disabled by URL option
120 # From the project root directory
122 tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
124 avatars: 'storage/avatars/'
125 videos: 'storage/videos/'
126 streaming_playlists: 'storage/streaming-playlists/'
127 redundancy: 'storage/redundancy/'
128 logs: 'storage/logs/'
129 previews: 'storage/previews/'
130 thumbnails: 'storage/thumbnails/'
131 torrents: 'storage/torrents/'
132 captions: 'storage/captions/'
133 cache: 'storage/cache/'
134 plugins: 'storage/plugins/'
135 well_known: 'storage/well-known/'
136 # Overridable client files in client/dist/assets/images:
139 # - default-playlist.jpg
140 # - default-avatar-account.png
141 # - default-avatar-video-channel.png
142 # - and icons/*.png (PWA)
143 # Could contain for example assets/images/favicon.png
144 # If the file exists, peertube will serve it
145 # If not, peertube will fallback to the default file
146 client_overrides: 'storage/client-overrides/'
149 # Require and check user authentication when accessing private files (internal/private video files)
150 private_files_require_auth: true
155 # Without protocol, will default to HTTPS
156 endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
161 # Set this ACL on each uploaded object of public/unlisted videos
162 # Use null if your S3 provider does not support object ACL
163 public: 'public-read'
164 # Set this ACL on each uploaded object of private/internal videos
165 # PeerTube can proxify requests to private objects so your users can access them
166 # Use null if your S3 provider does not support object ACL
170 # If private files (private/internal video files) have a private ACL, users can't access directly the ressource
171 # PeerTube can proxify requests between your object storage service and your users
172 # If you disable PeerTube proxy, ensure you use your own proxy that is able to access the private files
173 # Or you can also set a public ACL for private files in object storage if you don't want to use a proxy
174 proxify_private_files: true
177 # You can also use AWS_ACCESS_KEY_ID env variable
179 # You can also use AWS_SECRET_ACCESS_KEY env variable
180 secret_access_key: ''
182 # Maximum amount to upload in one request to object storage
183 max_upload_part: 100MB
186 bucket_name: 'streaming-playlists'
188 # Allows setting all buckets to the same value but with a different prefix
189 prefix: '' # Example: 'streaming-playlists:'
191 # Base url for object URL generation, scheme and host will be replaced by this URL
192 # Useful when you want to use a CDN/external proxy
193 base_url: '' # Example: 'https://mirror.example.com'
195 # Same settings but for webtorrent videos
197 bucket_name: 'videos'
202 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
205 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
211 log_ping_requests: true
212 log_tracker_unknown_infohash: true
216 # Accept warn/error logs coming from the client
217 accept_client_log: true
219 # Support of Open Telemetry metrics and tracing
220 # For more information: https://docs.joinpeertube.org/maintain-observability
225 # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics
227 hostname: '127.0.0.1'
233 # Send traces to a Jaeger compatible endpoint
239 interval_days: 7 # Compute trending videos for the last x days
242 - 'hot' # adaptation of Reddit's 'Hot' algorithm
243 - 'most-viewed' # default, used initially by PeerTube as the trending page
245 default: 'most-viewed'
247 # Cache remote videos on your server, to help other instances to broadcast the video
248 # You can define multiple caches using different sizes/strategies
249 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
252 check_interval: '1 hour' # How often you want to check new videos to cache
253 strategies: # Just uncomment strategies you want
256 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
257 # min_lifetime: '48 hours'
258 # strategy: 'most-views' # Cache videos that have the most views
261 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
262 # min_lifetime: '48 hours'
263 # strategy: 'trending' # Cache trending videos
266 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
267 # min_lifetime: '48 hours'
268 # strategy: 'recently-added' # Cache recently added videos
269 # min_views: 10 # Having at least x views
271 # Other instances that duplicate your content
274 # 'nobody': Do not accept remote redundancies
275 # 'anybody': Accept remote redundancies from anybody
276 # 'followings': Accept redundancies from instance followings
277 accept_from: 'anybody'
281 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
285 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
290 # If you disable the tracker, you disable the P2P on your PeerTube instance
292 # Only handle requests on your videos
293 # If you set this to false it means you have a public tracker
294 # Then, it is possible that clients overload your instance with external torrents
296 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
297 reject_too_many_announces: false
301 # If you want to limit users videos history
302 # -1 means there is no limitations
303 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
308 # PeerTube creates a database entry every hour for each video to track views over a period of time
309 # This is used in particular by the Trending page
310 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
311 # -1 means no cleanup
312 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
316 # PeerTube buffers local video views before updating and federating the video
317 local_buffer_update_interval: '30 minutes'
319 ip_view_expiration: '1 hour'
321 # Used to get country location of views of local videos
326 database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
329 # The website PeerTube will ask for available PeerTube plugins and themes
330 # This is an unmoderated plugin index, so only install plugins/themes you trust
333 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
334 url: 'https://packages.joinpeertube.org'
338 federate_unlisted: false
340 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
341 # It removes objects that do not exist anymore, and potentially fix their URLs
342 cleanup_remote_interactions: true
345 check_latest_version:
346 # Check and notify admins of new PeerTube versions
348 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
349 url: 'https://joinpeertube.org/api/v1/versions.json'
354 # Set this to false if you don't want to allow config edition in the web interface by instance admins
357 # XML, Atom or JSON feeds
360 # Default number of videos displayed in feeds
364 # Default number of comments displayed in feeds
369 size: 500 # Max number of previews you want to cache
371 size: 500 # Max number of video captions/subtitles you want to cache
373 size: 500 # Max number of video torrents you want to cache
376 # Used to generate the root user at first startup
377 # And to receive emails from the contact form
378 email: 'admin@example.com'
386 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
388 minimum_age: 16 # Used to configure the signup form
390 # Users fill a form to register so moderators can accept/reject the registration
391 requires_approval: true
392 requires_email_verification: false
395 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
400 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
401 # Byte format is supported ("1GB" etc)
404 video_quota_daily: -1
407 max_per_user: 20 # Allows each user to create up to 20 video channels.
409 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
410 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
411 # Please, do not disable transcoding since many uploaded videos will not work
415 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
416 allow_additional_extensions: true
418 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
419 allow_audio_files: true
421 # Amount of threads used by ffmpeg for 1 transcoding job
423 # Amount of transcoding jobs to execute in parallel
426 # Choose the transcoding profile
427 # New profiles can be added by plugins
428 # Available in core PeerTube: 'default'
431 resolutions: # Only created if the original video has a higher resolution, uses more storage!
432 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
442 # Transcode and keep original resolution, even if it's above your maximum enabled resolution
443 always_transcode_original_resolution: true
445 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
446 # If you also enabled the hls format, it will multiply videos storage by 2
447 # If disabled, breaks federation with PeerTube instances < 2.1
451 # /!\ Requires ffmpeg >= 4.1
452 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
453 # * Resolution change is smoother
454 # * Faster playback in particular with long videos
455 # * More stable playback (less bugs/infinite loading)
456 # If you also enabled the webtorrent format, it will multiply videos storage by 2
463 # Limit lives duration
465 max_duration: -1 # For example: '5 hours'
467 # Limit max number of live videos created on your instance
469 max_instance_lives: 20
471 # Limit max number of live videos created by a user on your instance
475 # Allow your users to save a replay of their live
476 # PeerTube will transcode segments in a video file
477 # If the user daily/total quota is reached, PeerTube will stop the live
478 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
481 # Allow your users to change latency settings (small latency/default/high latency)
482 # Small latency live streams cannot use P2P
483 # High latency live streams can increase P2P ratio
487 # Your firewall should accept traffic from this port in TCP if you enable live
491 # Listening hostname/port for RTMP 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
497 # Public hostname of your RTMP server
498 # Use null to use the same value than `webserver.hostname`
499 public_hostname: null
504 # Listening hostname/port for RTMPS server
505 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
506 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
514 # Public hostname of your RTMPS server
515 # Use null to use the same value than `webserver.hostname`
516 public_hostname: null
518 # Allow to transcode the live streaming in multiple live resolutions
523 # Choose the transcoding profile
524 # New profiles can be added by plugins
525 # Available in core PeerTube: 'default'
538 # Also transcode original resolution, even if it's above your maximum enabled resolution
539 always_transcode_original_resolution: true
542 # Enable video edition by users (cut, add intro/outro, add watermark etc)
543 # If enabled, users can create transcoding tasks as they wish
547 # Add ability for your users to import remote videos (from YouTube, torrent...)
549 # Amount of import jobs to execute in parallel
552 # Set a custom video import timeout to not block import queue
555 # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
557 # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
558 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
562 # Direct download URL to youtube-dl binary
563 # Github releases API is also supported
565 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
566 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
567 # * https://yt-dl.org/downloads/latest/youtube-dl
568 url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
570 # Release binary name: 'yt-dlp' or 'youtube-dl'
573 # Path to the python binary to execute for youtube-dl or yt-dlp
574 python_path: '/usr/bin/python3'
576 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
579 # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
581 # We recommend to only enable magnet URI/torrent import if you trust your users
582 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
585 # Add ability for your users to synchronize their channels with external channels, playlists, etc
586 video_channel_synchronization:
591 check_interval: 1 hour
593 # Number of latest published videos to check and to potentially import when syncing a channel
594 videos_limit_per_synchronization: 10
596 # Max number of videos to import when the user asks for full sync
597 full_sync_videos_limit: 1000
600 # New videos automatically blacklisted so moderators can review before publishing
608 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
609 description: 'Welcome to this PeerTube instance!' # Support markdown
610 terms: 'No terms for now.' # Support markdown
611 code_of_conduct: '' # Supports markdown
613 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
614 moderation_information: '' # Supports markdown
616 # Why did you create this instance?
617 creation_reason: '' # Supports Markdown
619 # Who is behind the instance? A single person? A non profit?
620 administrator: '' # Supports Markdown
622 # How long do you plan to maintain this instance?
623 maintenance_lifetime: '' # Supports Markdown
625 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
626 business_model: '' # Supports Markdown
628 # If you want to explain on what type of hardware your PeerTube instance runs
629 # Example: '2 vCore, 2GB RAM...'
630 hardware_information: '' # Supports Markdown
632 # What are the main languages of your instance? To interact with your users for example
633 # Uncomment or add the languages you want
634 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
640 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
641 # Uncomment or add the category ids you want
642 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
653 # - 10 # Entertainment
654 # - 11 # News & Politics
658 # - 15 # Science & Technology
663 default_client_route: '/videos/trending'
665 # Whether or not the instance is dedicated to NSFW content
666 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
667 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
669 # By default, `do_not_list` or `blur` or `display` NSFW videos
670 # Could be overridden per user with a setting
671 default_nsfw_policy: 'do_not_list'
674 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
675 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
676 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
680 # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes
681 # To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
683 '# 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:'
686 # Cards configuration to format video in Twitter
688 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
689 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
690 # If false, we use an image link card that will redirect on your PeerTube instance
691 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
696 # Allow or not other instances to follow yours
698 # Whether or not an administrator must manually validate a new follower
699 manual_approval: false
703 # If you want to automatically follow back new instance followers
704 # If this option is enabled, use the mute feature instead of deleting followings
705 # /!\ Don't enable this if you don't have a reactive moderation team /!\
709 # If you want to automatically follow instances of the public index
710 # If this option is enabled, use the mute feature instead of deleting followings
711 # /!\ Don't enable this if you don't have a reactive moderation team /!\
714 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
722 message: '' # Support markdown
723 level: 'info' # 'info' | 'warning' | 'error'
727 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
728 # If enabled, the associated group will be able to "escape" from the instance follows
729 # That means they will be able to follow channels, watch videos, list videos of non followed instances
734 # Use a third party index instead of your local index, only for search results
735 # Useful to discover content outside of your instance
736 # If you enable search_index, you must enable remote_uri search for users
737 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
738 # instead of loading the video locally
741 # URL of the search index, that should use the same search API and routes
742 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
743 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
744 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
746 # You can disable local search in the client, so users only use the search index
747 disable_local_search: false
748 # If you did not disable local search in the client, you can decide to use the search index by default
749 is_default_search: false
751 # PeerTube client/interface configuration
755 # By default PeerTube client displays author username
756 prefer_author_display_name: false
757 display_author_avatar: false
759 # Max size of upload chunks, e.g. '90MB'
760 # If null, it will be calculated based on network speed
765 # If you enable only one external auth plugin
766 # You can automatically redirect your users on this external platform when they click on the login button
767 redirect_on_single_external_auth: false