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 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
142 # You can also use AWS_ACCESS_KEY_ID env variable
144 # You can also use AWS_SECRET_ACCESS_KEY env variable
145 secret_access_key: ''
147 # Maximum amount to upload in one request to object storage
151 bucket_name: 'streaming-playlists'
153 # Allows setting all buckets to the same value but with a different prefix
154 prefix: '' # Example: 'streaming-playlists:'
156 # Base url for object URL generation, scheme and host will be replaced by this URL
157 # Useful when you want to use a CDN/external proxy
158 base_url: '' # Example: 'https://mirror.example.com'
160 # Same settings but for webtorrent videos
162 bucket_name: 'videos'
167 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
169 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
173 log_ping_requests: true
178 interval_days: 7 # Compute trending videos for the last x days
181 - 'best' # adaptation of Reddit's 'Best' algorithm (Hot minus History)
182 - 'hot' # adaptation of Reddit's 'Hot' algorithm
183 - 'most-viewed' # default, used initially by PeerTube as the trending page
185 default: 'most-viewed'
187 # Cache remote videos on your server, to help other instances to broadcast the video
188 # You can define multiple caches using different sizes/strategies
189 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
192 check_interval: '1 hour' # How often you want to check new videos to cache
193 strategies: # Just uncomment strategies you want
196 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
197 # min_lifetime: '48 hours'
198 # strategy: 'most-views' # Cache videos that have the most views
201 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
202 # min_lifetime: '48 hours'
203 # strategy: 'trending' # Cache trending videos
206 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
207 # min_lifetime: '48 hours'
208 # strategy: 'recently-added' # Cache recently added videos
209 # min_views: 10 # Having at least x views
211 # Other instances that duplicate your content
214 # 'nobody': Do not accept remote redundancies
215 # 'anybody': Accept remote redundancies from anybody
216 # 'followings': Accept redundancies from instance followings
217 accept_from: 'anybody'
221 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
225 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
230 # If you disable the tracker, you disable the P2P on your PeerTube instance
232 # Only handle requests on your videos
233 # If you set this to false it means you have a public tracker
234 # Then, it is possible that clients overload your instance with external torrents
236 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
237 reject_too_many_announces: false
241 # If you want to limit users videos history
242 # -1 means there is no limitations
243 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
248 # PeerTube creates a database entry every hour for each video to track views over a period of time
249 # This is used in particular by the Trending page
250 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
251 # -1 means no cleanup
252 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
256 # PeerTube buffers local video views before updating and federating the video
257 local_buffer_update_interval: '30 minutes'
259 ip_view_expiration: '1 hour'
262 # The website PeerTube will ask for available PeerTube plugins and themes
263 # This is an unmoderated plugin index, so only install plugins/themes you trust
266 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
267 url: 'https://packages.joinpeertube.org'
271 federate_unlisted: false
273 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
274 # It removes objects that do not exist anymore, and potentially fix their URLs
275 cleanup_remote_interactions: true
278 check_latest_version:
279 # Check and notify admins of new PeerTube versions
281 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
282 url: 'https://joinpeertube.org/api/v1/versions.json'
287 # Set this to false if you don't want to allow config edition in the web interface by instance admins
292 size: 500 # Max number of previews you want to cache
294 size: 500 # Max number of video captions/subtitles you want to cache
296 size: 500 # Max number of video torrents you want to cache
299 # Used to generate the root user at first startup
300 # And to receive emails from the contact form
301 email: 'admin@example.com'
308 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
309 minimum_age: 16 # Used to configure the signup form
310 requires_email_verification: false
312 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
317 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
318 # Byte format is supported ("1GB" etc)
321 video_quota_daily: -1
324 max_per_user: 20 # Allows each user to create up to 20 video channels.
326 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
327 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
328 # Please, do not disable transcoding since many uploaded videos will not work
332 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
333 allow_additional_extensions: true
335 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
336 allow_audio_files: true
338 # Amount of threads used by ffmpeg for 1 transcoding job
340 # Amount of transcoding jobs to execute in parallel
343 # Choose the transcoding profile
344 # New profiles can be added by plugins
345 # Available in core PeerTube: 'default'
348 resolutions: # Only created if the original video has a higher resolution, uses more storage!
349 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
359 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
360 # If you also enabled the hls format, it will multiply videos storage by 2
361 # If disabled, breaks federation with PeerTube instances < 2.1
365 # /!\ Requires ffmpeg >= 4.1
366 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
367 # * Resolution change is smoother
368 # * Faster playback in particular with long videos
369 # * More stable playback (less bugs/infinite loading)
370 # If you also enabled the webtorrent format, it will multiply videos storage by 2
377 # Limit lives duration
379 max_duration: -1 # For example: '5 hours'
381 # Limit max number of live videos created on your instance
383 max_instance_lives: 20
385 # Limit max number of live videos created by a user on your instance
389 # Allow your users to save a replay of their live
390 # PeerTube will transcode segments in a video file
391 # If the user daily/total quota is reached, PeerTube will stop the live
392 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
395 # Your firewall should accept traffic from this port in TCP if you enable live
408 # Allow to transcode the live streaming in multiple live resolutions
413 # Choose the transcoding profile
414 # New profiles can be added by plugins
415 # Available in core PeerTube: 'default'
429 # Add ability for your users to import remote videos (from YouTube, torrent...)
431 # Amount of import jobs to execute in parallel
434 http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
438 # Direct download URL to youtube-dl binary
439 # Github releases API is also supported
441 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
442 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
443 url: 'https://yt-dl.org/downloads/latest/youtube-dl'
445 # youtube-dl binary name
446 # yt-dlp is also supported
449 # Path to the python binary to execute for youtube-dl or yt-dlp
450 python_path: '/usr/bin/python3'
452 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
455 torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
459 # New videos automatically blacklisted so moderators can review before publishing
467 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
468 description: 'Welcome to this PeerTube instance!' # Support markdown
469 terms: 'No terms for now.' # Support markdown
470 code_of_conduct: '' # Supports markdown
472 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
473 moderation_information: '' # Supports markdown
475 # Why did you create this instance?
476 creation_reason: '' # Supports Markdown
478 # Who is behind the instance? A single person? A non profit?
479 administrator: '' # Supports Markdown
481 # How long do you plan to maintain this instance?
482 maintenance_lifetime: '' # Supports Markdown
484 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
485 business_model: '' # Supports Markdown
487 # If you want to explain on what type of hardware your PeerTube instance runs
488 # Example: '2 vCore, 2GB RAM...'
489 hardware_information: '' # Supports Markdown
491 # What are the main languages of your instance? To interact with your users for example
492 # Uncomment or add the languages you want
493 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
499 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
500 # Uncomment or add the category ids you want
501 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
512 # - 10 # Entertainment
513 # - 11 # News & Politics
517 # - 15 # Science & Technology
522 default_client_route: '/videos/trending'
524 # Whether or not the instance is dedicated to NSFW content
525 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
526 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
528 # By default, `do_not_list` or `blur` or `display` NSFW videos
529 # Could be overridden per user with a setting
530 default_nsfw_policy: 'do_not_list'
533 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
534 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
535 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
539 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
541 '# 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:'
544 # Cards configuration to format video in Twitter
546 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
547 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
548 # If false, we use an image link card that will redirect on your PeerTube instance
549 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
554 # Allow or not other instances to follow yours
556 # Whether or not an administrator must manually validate a new follower
557 manual_approval: false
561 # If you want to automatically follow back new instance followers
562 # If this option is enabled, use the mute feature instead of deleting followings
563 # /!\ Don't enable this if you don't have a reactive moderation team /!\
567 # If you want to automatically follow instances of the public index
568 # If this option is enabled, use the mute feature instead of deleting followings
569 # /!\ Don't enable this if you don't have a reactive moderation team /!\
572 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
580 message: '' # Support markdown
581 level: 'info' # 'info' | 'warning' | 'error'
585 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
586 # If enabled, the associated group will be able to "escape" from the instance follows
587 # That means they will be able to follow channels, watch videos, list videos of non followed instances
592 # Use a third party index instead of your local index, only for search results
593 # Useful to discover content outside of your instance
594 # If you enable search_index, you must enable remote_uri search for users
595 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
596 # instead of loading the video locally
599 # URL of the search index, that should use the same search API and routes
600 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
601 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
602 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
604 # You can disable local search, so users only use the search index
605 disable_local_search: false
606 # If you did not disable local search, you can decide to use the search index by default
607 is_default_search: false
609 # PeerTube client/interface configuration
613 # By default PeerTube client displays author username
614 prefer_author_display_name: false
618 # If you enable only one external auth plugin
619 # You can automatically redirect your users on this external platform when they click on the login button
620 redirect_on_single_external_auth: false