5 # Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
8 hostname: 'example.com'
11 # Secrets you need to generate the first time you run PeerTube
13 # Generate one using `openssl rand -hex 32`
18 # 50 attempts in 10 seconds
22 # 15 attempts in 5 min
26 # 2 attempts in 5 min (only succeeded attempts are taken into account)
34 # 10 attempts in 10 min
41 refresh_token: '2 weeks'
43 # Proxies to trust to get real client IP
44 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
45 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
49 # Your database name will be database.name OR 'peertube'+database.suffix
60 # Redis server for short time storage
61 # You can also specify a 'socket' path to a unix socket but first need to
62 # set 'hostname' and 'port' to null
69 # SMTP server to send emails
73 # Path to sendmail command. Required if you use sendmail transport
76 port: 465 # If you use StartTLS: 587
79 tls: true # If you use StartTLS: false
80 disable_starttls: false
81 ca_file: null # Used for self signed certificates
82 from_address: 'admin@example.com'
90 # Update default PeerTube values
91 # Set by API when the field is not provided and put as default value in client
93 # Change default values when publishing a video (upload/import/go Live)
95 download_enabled: true
97 comments_enabled: true
99 # public = 1, unlisted = 2, private = 3, internal = 4
102 # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
103 # You can also choose a custom licence value added by a plugin
104 # No licence by default
108 # Enable P2P by default in PeerTube client
109 # Can be enabled/disabled by anonymous users and logged in users
113 # Enable P2P by default in PeerTube embed
114 # Can be enabled/disabled by URL option
118 # From the project root directory
120 tmp: '/var/www/peertube/storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
121 bin: '/var/www/peertube/storage/bin/'
122 avatars: '/var/www/peertube/storage/avatars/'
123 videos: '/var/www/peertube/storage/videos/'
124 streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
125 redundancy: '/var/www/peertube/storage/redundancy/'
126 logs: '/var/www/peertube/storage/logs/'
127 previews: '/var/www/peertube/storage/previews/'
128 thumbnails: '/var/www/peertube/storage/thumbnails/'
129 torrents: '/var/www/peertube/storage/torrents/'
130 captions: '/var/www/peertube/storage/captions/'
131 cache: '/var/www/peertube/storage/cache/'
132 plugins: '/var/www/peertube/storage/plugins/'
133 well_known: '/var/www/peertube/storage/well-known/'
134 # Overridable client files in client/dist/assets/images:
137 # - default-playlist.jpg
138 # - default-avatar-account.png
139 # - default-avatar-video-channel.png
140 # - and icons/*.png (PWA)
141 # Could contain for example assets/images/favicon.png
142 # If the file exists, peertube will serve it
143 # If not, peertube will fallback to the default file
144 client_overrides: '/var/www/peertube/storage/client-overrides/'
147 # Require and check user authentication when accessing private files (internal/private video files)
148 private_files_require_auth: true
153 # Without protocol, will default to HTTPS
154 endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
159 # Set this ACL on each uploaded object of public/unlisted videos
160 # Use null if your S3 provider does not support object ACL
161 public: 'public-read'
162 # Set this ACL on each uploaded object of private/internal videos
163 # PeerTube can proxify requests to private objects so your users can access them
164 # Use null if your S3 provider does not support object ACL
168 # If private files (private/internal video files) have a private ACL, users can't access directly the ressource
169 # PeerTube can proxify requests between your object storage service and your users
170 # If you disable PeerTube proxy, ensure you use your own proxy that is able to access the private files
171 # Or you can also set a public ACL for private files in object storage if you don't want to use a proxy
172 proxify_private_files: true
175 # You can also use AWS_ACCESS_KEY_ID env variable
177 # You can also use AWS_SECRET_ACCESS_KEY env variable
178 secret_access_key: ''
180 # Maximum amount to upload in one request to object storage
181 max_upload_part: 100MB
184 bucket_name: 'streaming-playlists'
186 # Allows setting all buckets to the same value but with a different prefix
187 prefix: '' # Example: 'streaming-playlists:'
189 # Base url for object URL generation, scheme and host will be replaced by this URL
190 # Useful when you want to use a CDN/external proxy
191 base_url: '' # Example: 'https://mirror.example.com'
193 # Same settings but for webtorrent videos
195 bucket_name: 'videos'
200 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
203 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
209 log_ping_requests: true
210 log_tracker_unknown_infohash: true
214 # Accept warn/error logs coming from the client
215 accept_client_log: true
217 # Support of Open Telemetry metrics and tracing
218 # For more information: https://docs.joinpeertube.org/maintain-observability
223 # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics
225 hostname: '127.0.0.1'
231 # Send traces to a Jaeger compatible endpoint
237 interval_days: 7 # Compute trending videos for the last x days
240 - 'hot' # adaptation of Reddit's 'Hot' algorithm
241 - 'most-viewed' # default, used initially by PeerTube as the trending page
243 default: 'most-viewed'
245 # Cache remote videos on your server, to help other instances to broadcast the video
246 # You can define multiple caches using different sizes/strategies
247 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
250 check_interval: '1 hour' # How often you want to check new videos to cache
251 strategies: # Just uncomment strategies you want
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: 'most-views' # Cache videos that have the most views
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: 'trending' # Cache trending videos
264 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
265 # min_lifetime: '48 hours'
266 # strategy: 'recently-added' # Cache recently added videos
267 # min_views: 10 # Having at least x views
269 # Other instances that duplicate your content
272 # 'nobody': Do not accept remote redundancies
273 # 'anybody': Accept remote redundancies from anybody
274 # 'followings': Accept redundancies from instance followings
275 accept_from: 'anybody'
279 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
283 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
288 # If you disable the tracker, you disable the P2P on your PeerTube instance
290 # Only handle requests on your videos
291 # If you set this to false it means you have a public tracker
292 # Then, it is possible that clients overload your instance with external torrents
294 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
295 reject_too_many_announces: false
299 # If you want to limit users videos history
300 # -1 means there is no limitations
301 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
306 # PeerTube creates a database entry every hour for each video to track views over a period of time
307 # This is used in particular by the Trending page
308 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
309 # -1 means no cleanup
310 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
314 # PeerTube buffers local video views before updating and federating the video
315 local_buffer_update_interval: '30 minutes'
317 ip_view_expiration: '1 hour'
319 # Used to get country location of views of local videos
324 database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
327 # The website PeerTube will ask for available PeerTube plugins and themes
328 # This is an unmoderated plugin index, so only install plugins/themes you trust
331 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
332 url: 'https://packages.joinpeertube.org'
336 federate_unlisted: false
338 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
339 # It removes objects that do not exist anymore, and potentially fix their URLs
340 cleanup_remote_interactions: true
343 check_latest_version:
344 # Check and notify admins of new PeerTube versions
346 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
347 url: 'https://joinpeertube.org/api/v1/versions.json'
352 # Set this to false if you don't want to allow config edition in the web interface by instance admins
355 # XML, Atom or JSON feeds
358 # Default number of videos displayed in feeds
362 # Default number of comments displayed in feeds
365 ###############################################################################
367 # From this point, almost all following keys can be overridden by the web interface
368 # (local-production.json file). If you need to change some values, prefer to
369 # use the web interface because the configuration will be automatically
370 # reloaded without any need to restart PeerTube
372 # /!\ If you already have a local-production.json file, modification of some of
373 # the following keys will have no effect /!\
375 ###############################################################################
379 size: 500 # Max number of previews you want to cache
381 size: 500 # Max number of video captions/subtitles you want to cache
383 size: 500 # Max number of video torrents you want to cache
386 # Used to generate the root user at first startup
387 # And to receive emails from the contact form
388 email: 'admin@example.com'
396 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
398 minimum_age: 16 # Used to configure the signup form
400 # Users fill a form to register so moderators can accept/reject the registration
401 requires_approval: true
402 requires_email_verification: false
405 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
410 # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
411 # Byte format is supported ("1GB" etc)
414 video_quota_daily: -1
417 max_per_user: 20 # Allows each user to create up to 20 video channels.
419 # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
420 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
421 # Please, do not disable transcoding since many uploaded videos will not work
425 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
426 allow_additional_extensions: true
428 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
429 allow_audio_files: true
431 # Amount of threads used by ffmpeg for 1 transcoding job
433 # Amount of transcoding jobs to execute in parallel
436 # Choose the transcoding profile
437 # New profiles can be added by plugins
438 # Available in core PeerTube: 'default'
441 resolutions: # Only created if the original video has a higher resolution, uses more storage!
442 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
452 # Transcode and keep original resolution, even if it's above your maximum enabled resolution
453 always_transcode_original_resolution: true
455 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
456 # If you also enabled the hls format, it will multiply videos storage by 2
457 # If disabled, breaks federation with PeerTube instances < 2.1
461 # /!\ Requires ffmpeg >= 4.1
462 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
463 # * Resolution change is smoother
464 # * Faster playback in particular with long videos
465 # * More stable playback (less bugs/infinite loading)
466 # If you also enabled the webtorrent format, it will multiply videos storage by 2
473 # Limit lives duration
475 max_duration: -1 # For example: '5 hours'
477 # Limit max number of live videos created on your instance
479 max_instance_lives: 20
481 # Limit max number of live videos created by a user on your instance
485 # Allow your users to save a replay of their live
486 # PeerTube will transcode segments in a video file
487 # If the user daily/total quota is reached, PeerTube will stop the live
488 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
491 # Allow your users to change latency settings (small latency/default/high latency)
492 # Small latency live streams cannot use P2P
493 # High latency live streams can increase P2P ratio
497 # Your firewall should accept traffic from this port in TCP if you enable live
501 # Listening hostname/port for RTMP server
502 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
503 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
507 # Public hostname of your RTMP server
508 # Use null to use the same value than `webserver.hostname`
509 public_hostname: null
514 # Listening hostname/port for RTMPS server
515 # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
516 # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
524 # Public hostname of your RTMPS server
525 # Use null to use the same value than `webserver.hostname`
526 public_hostname: null
528 # Allow to transcode the live streaming in multiple live resolutions
533 # Choose the transcoding profile
534 # New profiles can be added by plugins
535 # Available in core PeerTube: 'default'
548 # Also transcode original resolution, even if it's above your maximum enabled resolution
549 always_transcode_original_resolution: true
552 # Enable video edition by users (cut, add intro/outro, add watermark etc)
553 # If enabled, users can create transcoding tasks as they wish
557 # Add ability for your users to import remote videos (from YouTube, torrent...)
559 # Amount of import jobs to execute in parallel
562 # Set a custom video import timeout to not block import queue
565 # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
567 # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
568 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
572 # Direct download URL to youtube-dl binary
573 # Github releases API is also supported
575 # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
576 # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
577 # * https://yt-dl.org/downloads/latest/youtube-dl
578 url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
580 # Release binary name: 'yt-dlp' or 'youtube-dl'
583 # Path to the python binary to execute for youtube-dl or yt-dlp
584 python_path: '/usr/bin/python3'
586 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
589 # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
591 # We recommend to only enable magnet URI/torrent import if you trust your users
592 # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information
595 # Add ability for your users to synchronize their channels with external channels, playlists, etc.
596 video_channel_synchronization:
601 check_interval: 1 hour
603 # Number of latest published videos to check and to potentially import when syncing a channel
604 videos_limit_per_synchronization: 10
606 # Max number of videos to import when the user asks for full sync
607 full_sync_videos_limit: 1000
610 # New videos automatically blacklisted so moderators can review before publishing
618 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
619 description: 'Welcome to this PeerTube instance!' # Support markdown
620 terms: 'No terms for now.' # Support markdown
621 code_of_conduct: '' # Supports markdown
623 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
624 moderation_information: '' # Supports markdown
626 # Why did you create this instance?
627 creation_reason: '' # Supports Markdown
629 # Who is behind the instance? A single person? A non profit?
630 administrator: '' # Supports Markdown
632 # How long do you plan to maintain this instance?
633 maintenance_lifetime: '' # Supports Markdown
635 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
636 business_model: '' # Supports Markdown
638 # If you want to explain on what type of hardware your PeerTube instance runs
639 # Example: '2 vCore, 2GB RAM...'
640 hardware_information: '' # Supports Markdown
642 # What are the main languages of your instance? To interact with your users for example
643 # Uncomment or add the languages you want
644 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
650 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
651 # Uncomment or add the category ids you want
652 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
663 # - 10 # Entertainment
664 # - 11 # News & Politics
668 # - 15 # Science & Technology
673 default_client_route: '/videos/trending'
675 # Whether or not the instance is dedicated to NSFW content
676 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
677 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
679 # By default, `do_not_list` or `blur` or `display` NSFW videos
680 # Could be overridden per user with a setting
681 default_nsfw_policy: 'do_not_list'
684 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
685 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
686 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
690 # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes
691 # To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
693 '# 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:'
696 # Cards configuration to format video in Twitter
698 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
699 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
700 # If false, we use an image link card that will redirect on your PeerTube instance
701 # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
706 # Allow or not other instances to follow yours
708 # Whether or not an administrator must manually validate a new follower
709 manual_approval: false
713 # If you want to automatically follow back new instance followers
714 # If this option is enabled, use the mute feature instead of deleting followings
715 # /!\ Don't enable this if you don't have a reactive moderation team /!\
719 # If you want to automatically follow instances of the public index
720 # If this option is enabled, use the mute feature instead of deleting followings
721 # /!\ Don't enable this if you don't have a reactive moderation team /!\
724 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
732 message: '' # Support markdown
733 level: 'info' # 'info' | 'warning' | 'error'
737 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
738 # If enabled, the associated group will be able to "escape" from the instance follows
739 # That means they will be able to follow channels, watch videos, list videos of non followed instances
744 # Use a third party index instead of your local index, only for search results
745 # Useful to discover content outside of your instance
746 # If you enable search_index, you must enable remote_uri search for users
747 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
748 # instead of loading the video locally
751 # URL of the search index, that should use the same search API and routes
752 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
753 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
754 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
756 # You can disable local search, so users only use the search index
757 disable_local_search: false
758 # If you did not disable local search, you can decide to use the search index by default
759 is_default_search: false
761 # PeerTube client/interface configuration
765 # By default PeerTube client displays author username
766 prefer_author_display_name: false
767 display_author_avatar: false
769 # Max size of upload chunks, e.g. '90MB'
770 # If null, it will be calculated based on network speed
775 # If you enable only one external auth plugin
776 # You can automatically redirect your users on this external platform when they click on the login button
777 redirect_on_single_external_auth: false