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 # You can also specify a 'socket' path to a unix socket but first need to
49 # comment out hostname and port
59 # Path to sendmail command. Required if you use sendmail transport
66 disable_starttls: false
67 ca_file: null # Used for self signed certificates
68 from_address: 'admin@example.com'
76 # From the project root directory
78 tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before processing...
79 avatars: 'storage/avatars/'
80 videos: 'storage/videos/'
81 streaming_playlists: 'storage/streaming-playlists/'
82 redundancy: 'storage/redundancy/'
84 previews: 'storage/previews/'
85 thumbnails: 'storage/thumbnails/'
86 torrents: 'storage/torrents/'
87 captions: 'storage/captions/'
88 cache: 'storage/cache/'
89 plugins: 'storage/plugins/'
90 # Overridable client files : logo.svg, favicon.png and icons/*.png (PWA) in client/dist/assets/images
91 # Could contain for example assets/images/favicon.png
92 # If the file exists, peertube will serve it
93 # If not, peertube will fallback to the default fil
94 client_overrides: 'storage/client-overrides/'
97 level: 'info' # debug/info/warning/error
103 log_ping_requests: true
108 interval_days: 7 # Compute trending videos for the last x days
110 # Cache remote videos on your server, to help other instances to broadcast the video
111 # You can define multiple caches using different sizes/strategies
112 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
115 check_interval: '1 hour' # How often you want to check new videos to cache
116 strategies: # Just uncomment strategies you want
119 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
120 # min_lifetime: '48 hours'
121 # strategy: 'most-views' # Cache videos that have the most views
124 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
125 # min_lifetime: '48 hours'
126 # strategy: 'trending' # Cache trending videos
129 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
130 # min_lifetime: '48 hours'
131 # strategy: 'recently-added' # Cache recently added videos
132 # min_views: 10 # Having at least x views
134 # Other instances that duplicate your content
137 # 'nobody': Do not accept remote redundancies
138 # 'anybody': Accept remote redundancies from anybody
139 # 'followings': Accept redundancies from instance followings
140 accept_from: 'anybody'
144 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
148 # If you disable the tracker, you disable the P2P aspect of PeerTube
150 # Only handle requests on your videos.
151 # If you set this to false it means you have a public tracker.
152 # Then, it is possible that clients overload your instance with external torrents
154 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
155 reject_too_many_announces: false
159 # If you want to limit users videos history
160 # -1 means there is no limitations
161 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
166 # PeerTube creates a database entry every hour for each video to track views over a period of time
167 # This is used in particular by the Trending page
168 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
169 # -1 means no cleanup
170 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
175 # The website PeerTube will ask for available PeerTube plugins and themes
176 # This is an unmoderated plugin index, so only install plugins/themes you trust
179 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
180 url: 'https://packages.joinpeertube.org'
184 federate_unlisted: false
188 size: 500 # Max number of previews you want to cache
190 size: 500 # Max number of video captions/subtitles you want to cache
193 # Used to generate the root user at first startup
194 # And to receive emails from the contact form
195 email: 'admin@example.com'
202 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
203 requires_email_verification: false
205 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
210 # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
213 video_quota_daily: -1
215 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
216 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
217 # Please, do not disable transcoding since many uploaded videos will not work
220 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
221 allow_additional_extensions: true
222 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
223 allow_audio_files: true
225 resolutions: # Only created if the original video has a higher resolution, uses more storage!
226 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
235 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
236 # If you also enabled the hls format, it will multiply videos storage by 2
237 # If disabled, breaks federation with PeerTube instances < 2.1
241 # /!\ Requires ffmpeg >= 4.1
242 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
243 # * Resolution change is smoother
244 # * Faster playback in particular with long videos
245 # * More stable playback (less bugs/infinite loading)
246 # If you also enabled the webtorrent format, it will multiply videos storage by 2
253 # Limit lives duration
255 max_duration: -1 # For example: '5 hours'
257 # Limit max number of live videos created on your instance
259 max_instance_lives: 20
261 # Limit max number of live videos created by a user on your instance
265 # Allow your users to save a replay of their live
266 # PeerTube will transcode segments in a video file
267 # If the user daily/total quota is reached, PeerTube will stop the live
268 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
271 # Your firewall should accept traffic from this port in TCP if you enable live
275 # Allow to transcode the live streaming in multiple live resolutions
290 # Add ability for your users to import remote videos (from YouTube, torrent...)
292 http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
295 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
298 # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
302 torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
306 # New videos automatically blacklisted so moderators can review before publishing
313 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
314 description: 'Welcome to this PeerTube instance!' # Support markdown
315 terms: 'No terms for now.' # Support markdown
316 code_of_conduct: '' # Supports markdown
318 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
319 moderation_information: '' # Supports markdown
321 # Why did you create this instance?
322 creation_reason: '' # Supports Markdown
324 # Who is behind the instance? A single person? A non profit?
325 administrator: '' # Supports Markdown
327 # How long do you plan to maintain this instance?
328 maintenance_lifetime: '' # Supports Markdown
330 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
331 business_model: '' # Supports Markdown
333 # If you want to explain on what type of hardware your PeerTube instance runs
334 # Example: "2 vCore, 2GB RAM..."
335 hardware_information: '' # Supports Markdown
337 # What are the main languages of your instance? To interact with your users for example
338 # Uncomment or add the languages you want
339 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
345 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
346 # Uncomment or add the category ids you want
347 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
358 # - 10 # Entertainment
359 # - 11 # News & Politics
363 # - 15 # Science & Technology
368 default_client_route: '/videos/trending'
370 # Whether or not the instance is dedicated to NSFW content
371 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
372 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
374 # By default, "do_not_list" or "blur" or "display" NSFW videos
375 # Could be overridden per user with a setting
376 default_nsfw_policy: 'do_not_list'
379 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
380 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
381 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
385 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
387 "# 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:"
390 # Cards configuration to format video in Twitter
392 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
393 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
394 # If false, we use an image link card that will redirect on your PeerTube instance
395 # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
400 # Allow or not other instances to follow yours
402 # Whether or not an administrator must manually validate a new follower
403 manual_approval: false
407 # If you want to automatically follow back new instance followers
408 # Only follows accepted followers (in case you enabled manual followers approbation)
409 # If this option is enabled, use the mute feature instead of deleting followings
410 # /!\ Don't enable this if you don't have a reactive moderation team /!\
414 # If you want to automatically follow instances of the public index
415 # If this option is enabled, use the mute feature instead of deleting followings
416 # /!\ Don't enable this if you don't have a reactive moderation team /!\
419 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
427 message: '' # Support markdown
428 level: 'info' # 'info' | 'warning' | 'error'
432 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
433 # If enabled, the associated group will be able to "escape" from the instance follows
434 # That means they will be able to follow channels, watch videos, list videos of non followed instances
439 # Use a third party index instead of your local index, only for search results
440 # Useful to discover content outside of your instance
441 # If you enable search_index, you must enable remote_uri search for users
442 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
443 # instead of loading the video locally
446 # URL of the search index, that should use the same search API and routes
447 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
448 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
449 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
451 # You can disable local search, so users only use the search index
452 disable_local_search: false
453 # If you did not disable local search, you can decide to use the search index by default
454 is_default_search: false