]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame_incremental - config/production.yaml.example
Introduce accounts command
[github/Chocobozzz/PeerTube.git] / config / production.yaml.example
... / ...
CommitLineData
1listen:
2 hostname: 'localhost'
3 port: 9000
4
5# Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
6webserver:
7 https: true
8 hostname: 'example.com'
9 port: 443
10
11rates_limit:
12 api:
13 # 50 attempts in 10 seconds
14 window: 10 seconds
15 max: 50
16 login:
17 # 15 attempts in 5 min
18 window: 5 minutes
19 max: 15
20 signup:
21 # 2 attempts in 5 min (only succeeded attempts are taken into account)
22 window: 5 minutes
23 max: 2
24 ask_send_email:
25 # 3 attempts in 5 min
26 window: 5 minutes
27 max: 3
28
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)
32trust_proxy:
33 - 'loopback'
34
35# Your database name will be database.name OR "peertube"+database.suffix
36database:
37 hostname: 'localhost'
38 port: 5432
39 ssl: false
40 suffix: '_prod'
41 username: 'peertube'
42 password: 'peertube'
43 pool:
44 max: 5
45
46# Redis server for short time storage
47# You can also specify a 'socket' path to a unix socket but first need to
48# comment out hostname and port
49redis:
50 hostname: 'localhost'
51 port: 6379
52 auth: null
53 db: 0
54
55# SMTP server to send emails
56smtp:
57 # smtp or sendmail
58 transport: smtp
59 # Path to sendmail command. Required if you use sendmail transport
60 sendmail: null
61 hostname: null
62 port: 465 # If you use StartTLS: 587
63 username: null
64 password: null
65 tls: true # If you use StartTLS: false
66 disable_starttls: false
67 ca_file: null # Used for self signed certificates
68 from_address: 'admin@example.com'
69
70email:
71 body:
72 signature: "PeerTube"
73 subject:
74 prefix: "[PeerTube]"
75
76# From the project root directory
77storage:
78 tmp: '/var/www/peertube/storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
79 avatars: '/var/www/peertube/storage/avatars/'
80 videos: '/var/www/peertube/storage/videos/'
81 streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
82 redundancy: '/var/www/peertube/storage/redundancy/'
83 logs: '/var/www/peertube/storage/logs/'
84 previews: '/var/www/peertube/storage/previews/'
85 thumbnails: '/var/www/peertube/storage/thumbnails/'
86 torrents: '/var/www/peertube/storage/torrents/'
87 captions: '/var/www/peertube/storage/captions/'
88 cache: '/var/www/peertube/storage/cache/'
89 plugins: '/var/www/peertube/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: '/var/www/peertube/storage/client-overrides/'
95
96log:
97 level: 'info' # 'debug' | 'info' | 'warn' | 'error'
98 rotation:
99 enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
100 maxFileSize: 12MB
101 maxFiles: 20
102 anonymizeIP: false
103 log_ping_requests: true
104 prettify_sql: false
105
106trending:
107 videos:
108 interval_days: 7 # Compute trending videos for the last x days
109 algorithms:
110 enabled:
111 - 'best' # adaptation of Reddit's 'Best' algorithm (Hot minus History)
112 - 'hot' # adaptation of Reddit's 'Hot' algorithm
113 - 'most-viewed' # default, used initially by PeerTube as the trending page
114 - 'most-liked'
115 default: 'most-viewed'
116
117# Cache remote videos on your server, to help other instances to broadcast the video
118# You can define multiple caches using different sizes/strategies
119# Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
120redundancy:
121 videos:
122 check_interval: '1 hour' # How often you want to check new videos to cache
123 strategies: # Just uncomment strategies you want
124# -
125# size: '10GB'
126# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
127# min_lifetime: '48 hours'
128# strategy: 'most-views' # Cache videos that have the most views
129# -
130# size: '10GB'
131# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
132# min_lifetime: '48 hours'
133# strategy: 'trending' # Cache trending videos
134# -
135# size: '10GB'
136# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
137# min_lifetime: '48 hours'
138# strategy: 'recently-added' # Cache recently added videos
139# min_views: 10 # Having at least x views
140
141# Other instances that duplicate your content
142remote_redundancy:
143 videos:
144 # 'nobody': Do not accept remote redundancies
145 # 'anybody': Accept remote redundancies from anybody
146 # 'followings': Accept redundancies from instance followings
147 accept_from: 'anybody'
148
149csp:
150 enabled: false
151 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
152 report_uri:
153
154security:
155 # Set the X-Frame-Options header to help to mitigate clickjacking attacks
156 frameguard:
157 enabled: true
158
159tracker:
160 # If you disable the tracker, you disable the P2P aspect of PeerTube
161 enabled: true
162 # Only handle requests on your videos.
163 # If you set this to false it means you have a public tracker.
164 # Then, it is possible that clients overload your instance with external torrents
165 private: true
166 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
167 reject_too_many_announces: false
168
169history:
170 videos:
171 # If you want to limit users videos history
172 # -1 means there is no limitations
173 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
174 max_age: -1
175
176views:
177 videos:
178 # PeerTube creates a database entry every hour for each video to track views over a period of time
179 # This is used in particular by the Trending page
180 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
181 # -1 means no cleanup
182 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
183 remote:
184 max_age: '30 days'
185
186plugins:
187 # The website PeerTube will ask for available PeerTube plugins and themes
188 # This is an unmoderated plugin index, so only install plugins/themes you trust
189 index:
190 enabled: true
191 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
192 url: 'https://packages.joinpeertube.org'
193
194federation:
195 videos:
196 federate_unlisted: false
197
198 # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
199 # It removes objects that do not exist anymore, and potentially fix their URLs
200 # This setting is opt-in because due to an old bug in PeerTube, remote rates sent by instance before PeerTube 3.0 will be deleted
201 # We still suggest you to enable this setting even if your users will loose most of their video's likes/dislikes
202 cleanup_remote_interactions: false
203
204peertube:
205 check_latest_version:
206 # Check and notify admins of new PeerTube versions
207 enabled: true
208 # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
209 url: 'https://joinpeertube.org/api/v1/versions.json'
210
211###############################################################################
212#
213# From this point, all the following keys can be overridden by the web interface
214# (local-production.json file). If you need to change some values, prefer to
215# use the web interface because the configuration will be automatically
216# reloaded without any need to restart PeerTube.
217#
218# /!\ If you already have a local-production.json file, the modification of the
219# following keys will have no effect /!\.
220#
221###############################################################################
222
223cache:
224 previews:
225 size: 500 # Max number of previews you want to cache
226 captions:
227 size: 500 # Max number of video captions/subtitles you want to cache
228 torrents:
229 size: 500 # Max number of video torrents you want to cache
230
231admin:
232 # Used to generate the root user at first startup
233 # And to receive emails from the contact form
234 email: 'admin@example.com'
235
236contact_form:
237 enabled: true
238
239signup:
240 enabled: false
241 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
242 minimum_age: 16
243 requires_email_verification: false
244 filters:
245 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
246 whitelist: []
247 blacklist: []
248
249user:
250 # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
251 # -1 == unlimited
252 video_quota: -1
253 video_quota_daily: -1
254
255# If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
256# In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
257# Please, do not disable transcoding since many uploaded videos will not work
258transcoding:
259 enabled: true
260
261 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
262 allow_additional_extensions: true
263
264 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
265 allow_audio_files: true
266
267 # Amount of threads used by ffmpeg for 1 transcoding job
268 threads: 1
269 # Amount of transcoding jobs to execute in parallel
270 concurrency: 1
271
272 # Choose the transcoding profile
273 # New profiles can be added by plugins
274 # Available in core PeerTube: 'default'
275 profile: 'default'
276
277 resolutions: # Only created if the original video has a higher resolution, uses more storage!
278 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
279 240p: false
280 360p: false
281 480p: false
282 720p: false
283 1080p: false
284 1440p: false
285 2160p: false
286
287 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
288 # If you also enabled the hls format, it will multiply videos storage by 2
289 # If disabled, breaks federation with PeerTube instances < 2.1
290 webtorrent:
291 enabled: false
292
293 # /!\ Requires ffmpeg >= 4.1
294 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
295 # * Resolution change is smoother
296 # * Faster playback in particular with long videos
297 # * More stable playback (less bugs/infinite loading)
298 # If you also enabled the webtorrent format, it will multiply videos storage by 2
299 hls:
300 enabled: true
301
302live:
303 enabled: false
304
305 # Limit lives duration
306 # -1 == unlimited
307 max_duration: -1 # For example: '5 hours'
308
309 # Limit max number of live videos created on your instance
310 # -1 == unlimited
311 max_instance_lives: 20
312
313 # Limit max number of live videos created by a user on your instance
314 # -1 == unlimited
315 max_user_lives: 3
316
317 # Allow your users to save a replay of their live
318 # PeerTube will transcode segments in a video file
319 # If the user daily/total quota is reached, PeerTube will stop the live
320 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
321 allow_replay: true
322
323 # Your firewall should accept traffic from this port in TCP if you enable live
324 rtmp:
325 port: 1935
326
327 # Allow to transcode the live streaming in multiple live resolutions
328 transcoding:
329 enabled: true
330 threads: 2
331
332 # Choose the transcoding profile
333 # New profiles can be added by plugins
334 # Available in core PeerTube: 'default'
335 profile: 'default'
336
337 resolutions:
338 240p: false
339 360p: false
340 480p: false
341 720p: false
342 1080p: false
343 1440p: false
344 2160p: false
345
346import:
347 # Add ability for your users to import remote videos (from YouTube, torrent...)
348 videos:
349 # Amount of import jobs to execute in parallel
350 concurrency: 1
351
352 http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
353 enabled: false
354
355 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
356 force_ipv4: false
357
358 # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
359 proxy:
360 enabled: false
361 url: ""
362 torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
363 enabled: false
364
365auto_blacklist:
366 # New videos automatically blacklisted so moderators can review before publishing
367 videos:
368 of_users:
369 enabled: false
370
371# Instance settings
372instance:
373 name: 'PeerTube'
374 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
375 description: 'Welcome to this PeerTube instance!' # Support markdown
376 terms: 'No terms for now.' # Support markdown
377 code_of_conduct: '' # Supports markdown
378
379 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
380 moderation_information: '' # Supports markdown
381
382 # Why did you create this instance?
383 creation_reason: '' # Supports Markdown
384
385 # Who is behind the instance? A single person? A non profit?
386 administrator: '' # Supports Markdown
387
388 # How long do you plan to maintain this instance?
389 maintenance_lifetime: '' # Supports Markdown
390
391 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
392 business_model: '' # Supports Markdown
393
394 # If you want to explain on what type of hardware your PeerTube instance runs
395 # Example: "2 vCore, 2GB RAM..."
396 hardware_information: '' # Supports Markdown
397
398 # What are the main languages of your instance? To interact with your users for example
399 # Uncomment or add the languages you want
400 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
401 languages:
402# - en
403# - es
404# - fr
405
406 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
407 # Uncomment or add the category ids you want
408 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
409 categories:
410# - 1 # Music
411# - 2 # Films
412# - 3 # Vehicles
413# - 4 # Art
414# - 5 # Sports
415# - 6 # Travels
416# - 7 # Gaming
417# - 8 # People
418# - 9 # Comedy
419# - 10 # Entertainment
420# - 11 # News & Politics
421# - 12 # How To
422# - 13 # Education
423# - 14 # Activism
424# - 15 # Science & Technology
425# - 16 # Animals
426# - 17 # Kids
427# - 18 # Food
428
429 default_client_route: '/videos/trending'
430
431 # Whether or not the instance is dedicated to NSFW content
432 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
433 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
434 is_nsfw: false
435 # By default, "do_not_list" or "blur" or "display" NSFW videos
436 # Could be overridden per user with a setting
437 default_nsfw_policy: 'do_not_list'
438
439 customizations:
440 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
441 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
442 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
443 robots: |
444 User-agent: *
445 Disallow:
446 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
447 securitytxt:
448 "# 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:"
449
450services:
451 # Cards configuration to format video in Twitter
452 twitter:
453 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
454 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
455 # If false, we use an image link card that will redirect on your PeerTube instance
456 # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
457 whitelisted: false
458
459followers:
460 instance:
461 # Allow or not other instances to follow yours
462 enabled: true
463 # Whether or not an administrator must manually validate a new follower
464 manual_approval: false
465
466followings:
467 instance:
468 # If you want to automatically follow back new instance followers
469 # If this option is enabled, use the mute feature instead of deleting followings
470 # /!\ Don't enable this if you don't have a reactive moderation team /!\
471 auto_follow_back:
472 enabled: false
473
474 # If you want to automatically follow instances of the public index
475 # If this option is enabled, use the mute feature instead of deleting followings
476 # /!\ Don't enable this if you don't have a reactive moderation team /!\
477 auto_follow_index:
478 enabled: false
479 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
480 index_url: ''
481
482theme:
483 default: 'default'
484
485broadcast_message:
486 enabled: false
487 message: '' # Support markdown
488 level: 'info' # 'info' | 'warning' | 'error'
489 dismissable: false
490
491search:
492 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
493 # If enabled, the associated group will be able to "escape" from the instance follows
494 # That means they will be able to follow channels, watch videos, list videos of non followed instances
495 remote_uri:
496 users: true
497 anonymous: false
498
499 # Use a third party index instead of your local index, only for search results
500 # Useful to discover content outside of your instance
501 # If you enable search_index, you must enable remote_uri search for users
502 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
503 # instead of loading the video locally
504 search_index:
505 enabled: false
506 # URL of the search index, that should use the same search API and routes
507 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
508 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
509 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
510 url: ''
511 # You can disable local search, so users only use the search index
512 disable_local_search: false
513 # If you did not disable local search, you can decide to use the search index by default
514 is_default_search: false