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 # comment out hostname and port
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
97 # Can be enabled/disabled by anonymous users and logged in users
100 # From the project root directory
102 tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
104 avatars: 'storage/avatars/'
105 videos: 'storage/videos/'
106 streaming_playlists: 'storage/streaming-playlists/'
107 redundancy: 'storage/redundancy/'
108 logs: 'storage/logs/'
109 previews: 'storage/previews/'
110 thumbnails: 'storage/thumbnails/'
111 torrents: 'storage/torrents/'
112 captions: 'storage/captions/'
113 cache: 'storage/cache/'
114 plugins: 'storage/plugins/'
115 # Overridable client files in client/dist/assets/images:
118 # - default-playlist.jpg
119 # - default-avatar-account.png
120 # - default-avatar-video-channel.png
121 # - and icons/*.png (PWA)
122 # Could contain for example assets/images/favicon.png
123 # If the file exists, peertube will serve it
124 # If not, peertube will fallback to the default file
125 client_overrides: 'storage/client-overrides/'
130 # Without protocol, will default to HTTPS
131 endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
136 # You can also use AWS_ACCESS_KEY_ID env variable
138 # You can also use AWS_SECRET_ACCESS_KEY env variable
139 secret_access_key: ''
141 # Maximum amount to upload in one request to object storage
145 bucket_name: 'streaming-playlists'
147 # Allows setting all buckets to the same value but with a different prefix
148 prefix: '' # Example: 'streaming-playlists:'
150 # Base url for object URL generation, scheme and host will be replaced by this URL
151 # Useful when you want to use a CDN/external proxy
152 base_url: '' # Example: 'https://mirror.example.com'
154 # Same settings but for webtorrent videos
156 bucket_name: 'videos'
161 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
163 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
167 log_ping_requests: true
172 interval_days: 7 # Compute trending videos for the last x days
175 - 'best' # adaptation of Reddit's 'Best' algorithm (Hot minus History)
176 - 'hot' # adaptation of Reddit's 'Hot' algorithm
177 - 'most-viewed' # default, used initially by PeerTube as the trending page
179 default: 'most-viewed'
181 # Cache remote videos on your server, to help other instances to broadcast the video
182 # You can define multiple caches using different sizes/strategies
183 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
186 check_interval: '1 hour' # How often you want to check new videos to cache
187 strategies: # Just uncomment strategies you want
190 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
191 # min_lifetime: '48 hours'
192 # strategy: 'most-views' # Cache videos that have the most views
195 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
196 # min_lifetime: '48 hours'
197 # strategy: 'trending' # Cache trending videos
200 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
201 # min_lifetime: '48 hours'
202 # strategy: 'recently-added' # Cache recently added videos
203 # min_views: 10 # Having at least x views
205 # Other instances that duplicate your content
208 # 'nobody': Do not accept remote redundancies
209 # 'anybody': Accept remote redundancies from anybody
210 # 'followings': Accept redundancies from instance followings
211 accept_from: 'anybody'
215 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
219 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
224 # If you disable the tracker, you disable the P2P on your PeerTube instance
226 # Only handle requests on your videos
227 # If you set this to false it means you have a public tracker
228 # Then, it is possible that clients overload your instance with external torrents
230 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
231 reject_too_many_announces: false
235 # If you want to limit users videos history
236 # -1 means there is no limitations
237 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
242 # PeerTube creates a database entry every hour for each video to track views over a period of time
243 # This is used in particular by the Trending page
244 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
245 # -1 means no cleanup
246 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
250 # PeerTube buffers local video views before updating and federating the video
251 local_buffer_update_interval: '30 minutes'
253 ip_view_expiration: '1 hour'
256 # The website PeerTube will ask for available PeerTube plugins and themes
257 # This is an unmoderated plugin index, so only install plugins/themes you trust
260 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
261 url: 'https://packages.joinpeertube.org'
265 federate_unlisted: false
267 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
268 # It removes objects that do not exist anymore, and potentially fix their URLs
269 cleanup_remote_interactions: true
272 check_latest_version:
273 # Check and notify admins of new PeerTube versions
275 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
276 url: 'https://joinpeertube.org/api/v1/versions.json'
281 # Set this to false if you don't want to allow config edition in the web interface by instance admins
286 size: 500 # Max number of previews you want to cache
288 size: 500 # Max number of video captions/subtitles you want to cache
290 size: 500 # Max number of video torrents you want to cache
293 # Used to generate the root user at first startup
294 # And to receive emails from the contact form
295 email: 'admin@example.com'
302 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
303 minimum_age: 16 # Used to configure the signup form
304 requires_email_verification: false
306 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
311 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
312 # Byte format is supported ("1GB" etc)
315 video_quota_daily: -1
318 max_per_user: 20 # Allows each user to create up to 20 video channels.
320 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
321 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
322 # Please, do not disable transcoding since many uploaded videos will not work
326 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
327 allow_additional_extensions: true
329 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
330 allow_audio_files: true
332 # Amount of threads used by ffmpeg for 1 transcoding job
334 # Amount of transcoding jobs to execute in parallel
337 # Choose the transcoding profile
338 # New profiles can be added by plugins
339 # Available in core PeerTube: 'default'
342 resolutions: # Only created if the original video has a higher resolution, uses more storage!
343 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
353 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
354 # If you also enabled the hls format, it will multiply videos storage by 2
355 # If disabled, breaks federation with PeerTube instances < 2.1
359 # /!\ Requires ffmpeg >= 4.1
360 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
361 # * Resolution change is smoother
362 # * Faster playback in particular with long videos
363 # * More stable playback (less bugs/infinite loading)
364 # If you also enabled the webtorrent format, it will multiply videos storage by 2
371 # Limit lives duration
373 max_duration: -1 # For example: '5 hours'
375 # Limit max number of live videos created on your instance
377 max_instance_lives: 20
379 # Limit max number of live videos created by a user on your instance
383 # Allow your users to save a replay of their live
384 # PeerTube will transcode segments in a video file
385 # If the user daily/total quota is reached, PeerTube will stop the live
386 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
389 # Your firewall should accept traffic from this port in TCP if you enable live
402 # Allow to transcode the live streaming in multiple live resolutions
407 # Choose the transcoding profile
408 # New profiles can be added by plugins
409 # Available in core PeerTube: 'default'
423 # Add ability for your users to import remote videos (from YouTube, torrent...)
425 # Amount of import jobs to execute in parallel
428 http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
432 # Direct download URL to youtube-dl binary
433 # Github releases API is also supported
435 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
436 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
437 url: 'https://yt-dl.org/downloads/latest/youtube-dl'
439 # youtube-dl binary name
440 # yt-dlp is also supported
443 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
446 torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
450 # New videos automatically blacklisted so moderators can review before publishing
458 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
459 description: 'Welcome to this PeerTube instance!' # Support markdown
460 terms: 'No terms for now.' # Support markdown
461 code_of_conduct: '' # Supports markdown
463 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
464 moderation_information: '' # Supports markdown
466 # Why did you create this instance?
467 creation_reason: '' # Supports Markdown
469 # Who is behind the instance? A single person? A non profit?
470 administrator: '' # Supports Markdown
472 # How long do you plan to maintain this instance?
473 maintenance_lifetime: '' # Supports Markdown
475 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
476 business_model: '' # Supports Markdown
478 # If you want to explain on what type of hardware your PeerTube instance runs
479 # Example: '2 vCore, 2GB RAM...'
480 hardware_information: '' # Supports Markdown
482 # What are the main languages of your instance? To interact with your users for example
483 # Uncomment or add the languages you want
484 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
490 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
491 # Uncomment or add the category ids you want
492 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
503 # - 10 # Entertainment
504 # - 11 # News & Politics
508 # - 15 # Science & Technology
513 default_client_route: '/videos/trending'
515 # Whether or not the instance is dedicated to NSFW content
516 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
517 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
519 # By default, `do_not_list` or `blur` or `display` NSFW videos
520 # Could be overridden per user with a setting
521 default_nsfw_policy: 'do_not_list'
524 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
525 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
526 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
530 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
532 '# 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:'
535 # Cards configuration to format video in Twitter
537 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
538 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
539 # If false, we use an image link card that will redirect on your PeerTube instance
540 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
545 # Allow or not other instances to follow yours
547 # Whether or not an administrator must manually validate a new follower
548 manual_approval: false
552 # If you want to automatically follow back new instance followers
553 # If this option is enabled, use the mute feature instead of deleting followings
554 # /!\ Don't enable this if you don't have a reactive moderation team /!\
558 # If you want to automatically follow instances of the public index
559 # If this option is enabled, use the mute feature instead of deleting followings
560 # /!\ Don't enable this if you don't have a reactive moderation team /!\
563 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
571 message: '' # Support markdown
572 level: 'info' # 'info' | 'warning' | 'error'
576 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
577 # If enabled, the associated group will be able to "escape" from the instance follows
578 # That means they will be able to follow channels, watch videos, list videos of non followed instances
583 # Use a third party index instead of your local index, only for search results
584 # Useful to discover content outside of your instance
585 # If you enable search_index, you must enable remote_uri search for users
586 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
587 # instead of loading the video locally
590 # URL of the search index, that should use the same search API and routes
591 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
592 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
593 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
595 # You can disable local search, so users only use the search index
596 disable_local_search: false
597 # If you did not disable local search, you can decide to use the search index by default
598 is_default_search: false
600 # PeerTube client/interface configuration
604 # By default PeerTube client displays author username
605 prefer_author_display_name: false
609 # If you enable only one external auth plugin
610 # You can automatically redirect your users on this external platform when they click on the login button
611 redirect_on_single_external_auth: false