5 # Correspond to your reverse proxy server_name/listen configuration
8 hostname: 'example.com'
13 # 50 attempts in 10 seconds
17 # 15 attempts in 5 min
21 # 2 attempts in 5 min (only succeeded attempts are taken into account)
29 # Proxies to trust to get real client IP
30 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
31 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
35 # Your database name will be "peertube"+database.suffix
44 # Redis server for short time storage
45 # You can also specify a 'socket' path to a unix socket but first need to
46 # comment out hostname and port
53 # SMTP server to send emails
56 port: 465 # If you use StartTLS: 587
59 tls: true # If you use StartTLS: false
60 disable_starttls: false
61 ca_file: null # Used for self signed certificates
62 from_address: 'admin@example.com'
70 # From the project root directory
72 tmp: '/var/www/peertube/storage/tmp/' # Use to download data (imports etc), store uploaded files before processing...
73 avatars: '/var/www/peertube/storage/avatars/'
74 videos: '/var/www/peertube/storage/videos/'
75 streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
76 redundancy: '/var/www/peertube/storage/redundancy/'
77 logs: '/var/www/peertube/storage/logs/'
78 previews: '/var/www/peertube/storage/previews/'
79 thumbnails: '/var/www/peertube/storage/thumbnails/'
80 torrents: '/var/www/peertube/storage/torrents/'
81 captions: '/var/www/peertube/storage/captions/'
82 cache: '/var/www/peertube/storage/cache/'
83 plugins: '/var/www/peertube/storage/plugins/'
86 level: 'info' # debug/info/warning/error
88 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
94 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
95 # If enabled, the associated group will be able to "escape" from the instance follows
96 # That means they will be able to follow channels, watch videos, list videos of non followed instances
103 interval_days: 7 # Compute trending videos for the last x days
105 # Cache remote videos on your server, to help other instances to broadcast the video
106 # You can define multiple caches using different sizes/strategies
107 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
110 check_interval: '1 hour' # How often you want to check new videos to cache
111 strategies: # Just uncomment strategies you want
114 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
115 # min_lifetime: '48 hours'
116 # strategy: 'most-views' # Cache videos that have the most views
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: 'trending' # Cache trending videos
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: 'recently-added' # Cache recently added videos
127 # min_views: 10 # Having at least x views
131 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
135 # If you disable the tracker, you disable the P2P aspect of PeerTube
137 # Only handle requests on your videos.
138 # If you set this to false it means you have a public tracker.
139 # Then, it is possible that clients overload your instance with external torrents
141 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
142 reject_too_many_announces: false
146 # If you want to limit users videos history
147 # -1 means there is no limitations
148 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
153 # PeerTube creates a database entry every hour for each video to track views over a period of time
154 # This is used in particular by the Trending page
155 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
156 # -1 means no cleanup
157 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
162 # The website PeerTube will ask for available PeerTube plugins and themes
163 # This is an unmoderated plugin index, so only install plugins/themes you trust
166 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
167 url: 'https://packages.joinpeertube.org'
170 ###############################################################################
172 # From this point, all the following keys can be overridden by the web interface
173 # (local-production.json file). If you need to change some values, prefer to
174 # use the web interface because the configuration will be automatically
175 # reloaded without any need to restart PeerTube.
177 # /!\ If you already have a local-production.json file, the modification of the
178 # following keys will have no effect /!\.
180 ###############################################################################
184 size: 500 # Max number of previews you want to cache
186 size: 500 # Max number of video captions/subtitles you want to cache
189 # Used to generate the root user at first startup
190 # And to receive emails from the contact form
191 email: 'admin@example.com'
198 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
199 requires_email_verification: false
201 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
206 # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
209 video_quota_daily: -1
211 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
212 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
213 # Please, do not disable transcoding since many uploaded videos will not work
216 # Allow your users to upload .mkv, .mov, .avi, .flv videos
217 allow_additional_extensions: true
218 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
219 allow_audio_files: true
221 resolutions: # Only created if the original video has a higher resolution, uses more storage!
222 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
230 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
231 # If you also enabled the hls format, it will multiply videos storage by 2
232 # If disabled, breaks federation with PeerTube instances < 2.1
236 # /!\ Requires ffmpeg >= 4.1
237 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
238 # * Resolution change is smoother
239 # * Faster playback in particular with long videos
240 # * More stable playback (less bugs/infinite loading)
241 # If you also enabled the webtorrent format, it will multiply videos storage by 2
246 # Add ability for your users to import remote videos (from YouTube, torrent...)
248 http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
250 # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
254 torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
258 # New videos automatically blacklisted so moderators can review before publishing
266 short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
267 description: 'Welcome to this PeerTube instance!' # Support markdown
268 terms: 'No terms for now.' # Support markdown
269 code_of_conduct: '' # Supports markdown
271 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
272 moderation_information: '' # Supports markdown
274 # Why did you create this instance?
277 # Who is behind the instance? A single person? A non profit?
280 # How long do you plan to maintain this instance?
281 maintenance_lifetime: ''
283 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
286 # If you want to explain on what type of hardware your PeerTube instance runs
287 # Example: "2 vCore, 2GB RAM..."
288 hardware_information: '' # Supports Markdown
290 # What are the main languages of your instance? To interact with your users for example
291 # Uncomment or add the languages you want
292 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
298 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
299 # Uncomment or add the category ids you want
300 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
311 # - 10 # Entertainment
312 # - 11 # News & Politics
316 # - 15 # Science & Technology
321 default_client_route: '/videos/trending'
323 # Whether or not the instance is dedicated to NSFW content
324 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
325 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
327 # By default, "do_not_list" or "blur" or "display" NSFW videos
328 # Could be overridden per user with a setting
329 default_nsfw_policy: 'do_not_list'
332 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
333 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
334 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
338 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
340 "# 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:"
343 # Cards configuration to format video in Twitter
345 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
346 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
347 # If false, we use an image link card that will redirect on your PeerTube instance
348 # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
353 # Allow or not other instances to follow yours
355 # Whether or not an administrator must manually validate a new follower
356 manual_approval: false
360 # If you want to automatically follow back new instance followers
361 # If this option is enabled, use the mute feature instead of deleting followings
362 # /!\ Don't enable this if you don't have a reactive moderation team /!\
366 # If you want to automatically follow instances of the public index
367 # If this option is enabled, use the mute feature instead of deleting followings
368 # /!\ Don't enable this if you don't have a reactive moderation team /!\
371 index_url: 'https://instances.joinpeertube.org'