default.yaml 17.7 KB
Newer Older
1
2
# /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #

Chocobozzz's avatar
Spawn    
Chocobozzz committed
3
listen:
4
  hostname: '127.0.0.1'
Chocobozzz's avatar
Spawn    
Chocobozzz committed
5
6
  port: 9000

Chocobozzz's avatar
Chocobozzz committed
7
# Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
Chocobozzz's avatar
Spawn    
Chocobozzz committed
8
9
webserver:
  https: false
10
  hostname: 'localhost'
Chocobozzz's avatar
Spawn    
Chocobozzz committed
11
12
  port: 9000

13
rates_limit:
14
15
16
  api:
    # 50 attempts in 10 seconds
    window: 10 seconds
17
    max: 50
18
19
20
21
  login:
    # 15 attempts in 5 min
    window: 5 minutes
    max: 15
22
23
24
25
  signup:
    # 2 attempts in 5 min (only succeeded attempts are taken into account)
    window: 5 minutes
    max: 2
26
27
28
29
30
  ask_send_email:
    # 3 attempts in 5 min
    window: 5 minutes
    max: 3

Chocobozzz's avatar
Chocobozzz committed
31
32
33
34
35
36
# Proxies to trust to get real client IP
# If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
# If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
trust_proxy:
  - 'loopback'

37
# Your database name will be database.name OR "peertube"+database.suffix
Chocobozzz's avatar
Spawn    
Chocobozzz committed
38
database:
39
  hostname: 'localhost'
Chocobozzz's avatar
Chocobozzz committed
40
  port: 5432
Chocobozzz's avatar
Chocobozzz committed
41
  ssl: false
Chocobozzz's avatar
Chocobozzz committed
42
  suffix: '_dev'
Chocobozzz's avatar
Chocobozzz committed
43
44
  username: 'peertube'
  password: 'peertube'
Rigel Kent's avatar
Rigel Kent committed
45
46
  pool:
    max: 5
Chocobozzz's avatar
Spawn    
Chocobozzz committed
47

48
# Redis server for short time storage
Rigel Kent's avatar
Rigel Kent committed
49
50
# You can also specify a 'socket' path to a unix socket but first need to
# comment out hostname and port
Chocobozzz's avatar
Chocobozzz committed
51
52
53
54
redis:
  hostname: 'localhost'
  port: 6379
  auth: null
Rigel Kent's avatar
Rigel Kent committed
55
  db: 0
Chocobozzz's avatar
Chocobozzz committed
56

57
# SMTP server to send emails
Chocobozzz's avatar
Chocobozzz committed
58
smtp:
Ismaël Bouya's avatar
Ismaël Bouya committed
59
60
61
62
  # smtp or sendmail
  transport: smtp
  # Path to sendmail command. Required if you use sendmail transport
  sendmail: null
Chocobozzz's avatar
Chocobozzz committed
63
  hostname: null
64
  port: 465 # If you use StartTLS: 587
Chocobozzz's avatar
Chocobozzz committed
65
66
  username: null
  password: null
67
  tls: true # If you use StartTLS: false
Chocobozzz's avatar
Chocobozzz committed
68
  disable_starttls: false
Chocobozzz's avatar
Chocobozzz committed
69
70
71
  ca_file: null # Used for self signed certificates
  from_address: 'admin@example.com'

72
73
74
email:
  body:
    signature: "PeerTube"
Chocobozzz's avatar
Chocobozzz committed
75
  subject:
76
77
    prefix: "[PeerTube]"

Chocobozzz's avatar
Spawn    
Chocobozzz committed
78
79
# From the project root directory
storage:
80
  tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
Chocobozzz's avatar
Chocobozzz committed
81
82
  avatars: 'storage/avatars/'
  videos: 'storage/videos/'
83
  streaming_playlists: 'storage/streaming-playlists/'
84
  redundancy: 'storage/redundancy/'
Chocobozzz's avatar
Chocobozzz committed
85
86
87
88
  logs: 'storage/logs/'
  previews: 'storage/previews/'
  thumbnails: 'storage/thumbnails/'
  torrents: 'storage/torrents/'
Chocobozzz's avatar
Chocobozzz committed
89
  captions: 'storage/captions/'
Chocobozzz's avatar
Chocobozzz committed
90
  cache: 'storage/cache/'
91
  plugins: 'storage/plugins/'
92
93
94
95
96
  # Overridable client files : logo.svg, favicon.png and icons/*.png (PWA) in client/dist/assets/images
  # Could contain for example assets/images/favicon.png
  # If the file exists, peertube will serve it
  # If not, peertube will fallback to the default fil
  client_overrides: 'storage/client-overrides/'
97

98
log:
Chocobozzz's avatar
Chocobozzz committed
99
  level: 'info' # 'debug' | 'info' | 'warn' | 'error'
Nassim Bounouas's avatar
Nassim Bounouas committed
100
  rotation:
101
    enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
102
103
104
    maxFileSize: 12MB
    maxFiles: 20
  anonymizeIP: false
105
  log_ping_requests: true
Chocobozzz's avatar
Chocobozzz committed
106
  prettify_sql: false
107

Chocobozzz's avatar
Chocobozzz committed
108
109
110
trending:
  videos:
    interval_days: 7 # Compute trending videos for the last x days
111
112
    algorithms:
      enabled:
113
114
        - 'best' # adaptation of Reddit's 'Best' algorithm (Hot minus History)
        - 'hot' # adaptation of Reddit's 'Hot' algorithm
115
116
117
        - 'most-viewed' # default, used initially by PeerTube as the trending page
        - 'most-liked'
      default: 'most-viewed'
Chocobozzz's avatar
Chocobozzz committed
118

119
120
121
122
123
# Cache remote videos on your server, to help other instances to broadcast the video
# You can define multiple caches using different sizes/strategies
# Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
redundancy:
  videos:
124
    check_interval: '1 hour' # How often you want to check new videos to cache
125
    strategies: # Just uncomment strategies you want
126
127
#      -
#        size: '10GB'
128
129
#        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
#        min_lifetime: '48 hours'
130
131
132
#        strategy: 'most-views' # Cache videos that have the most views
#      -
#        size: '10GB'
133
134
#        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
#        min_lifetime: '48 hours'
135
136
137
#        strategy: 'trending' # Cache trending videos
#      -
#        size: '10GB'
138
139
#        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
#        min_lifetime: '48 hours'
140
#        strategy: 'recently-added' # Cache recently added videos
141
#        min_views: 10 # Having at least x views
142

143
144
145
146
147
148
149
150
# Other instances that duplicate your content
remote_redundancy:
  videos:
    # 'nobody': Do not accept remote redundancies
    # 'anybody': Accept remote redundancies from anybody
    # 'followings': Accept redundancies from instance followings
    accept_from: 'anybody'

151
152
153
154
155
csp:
  enabled: false
  report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
  report_uri:

Chocobozzz's avatar
Chocobozzz committed
156
157
158
159
160
security:
  # Set the X-Frame-Options header to help to mitigate clickjacking attacks
  frameguard:
    enabled: true

Chocobozzz's avatar
Chocobozzz committed
161
162
163
164
165
166
167
168
169
170
tracker:
  # If you disable the tracker, you disable the P2P aspect of PeerTube
  enabled: true
  # Only handle requests on your videos.
  # If you set this to false it means you have a public tracker.
  # Then, it is possible that clients overload your instance with external torrents
  private: true
  # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
  reject_too_many_announces: false

171
172
173
174
175
176
177
history:
  videos:
    # If you want to limit users videos history
    # -1 means there is no limitations
    # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
    max_age: -1

178
179
180
181
182
183
184
185
views:
  videos:
    # PeerTube creates a database entry every hour for each video to track views over a period of time
    # This is used in particular by the Trending page
    # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
    # -1 means no cleanup
    # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
    remote:
Chocobozzz's avatar
Chocobozzz committed
186
      max_age: '30 days'
187

188
plugins:
189
190
  # The website PeerTube will ask for available PeerTube plugins and themes
  # This is an unmoderated plugin index, so only install plugins/themes you trust
191
192
  index:
    enabled: true
193
    check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
194
195
    url: 'https://packages.joinpeertube.org'

196
197
federation:
  videos:
198
    federate_unlisted: false
199

200
201
202
203
204
205
    # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
    # It removes objects that do not exist anymore, and potentially fix their URLs
    # 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
    # We still suggest you to enable this setting even if your users will loose most of their video's likes/dislikes
    cleanup_remote_interactions: false

206
207
208
209
210
211
212
peertube:
  check_latest_version:
    # Check and notify admins of new PeerTube versions
    enabled: true
    # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
    url: 'https://joinpeertube.org/api/v1/versions.json'

213
214
cache:
  previews:
Chocobozzz's avatar
Chocobozzz committed
215
    size: 500 # Max number of previews you want to cache
Chocobozzz's avatar
Chocobozzz committed
216
  captions:
Chocobozzz's avatar
Chocobozzz committed
217
    size: 500 # Max number of video captions/subtitles you want to cache
218
219
  torrents:
    size: 500 # Max number of video torrents you want to cache
Chocobozzz's avatar
Chocobozzz committed
220
221

admin:
222
223
224
225
226
227
  # Used to generate the root user at first startup
  # And to receive emails from the contact form
  email: 'admin@example.com'

contact_form:
  enabled: true
Chocobozzz's avatar
Chocobozzz committed
228
229
230

signup:
  enabled: false
231
  limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
232
  minimum_age: 16 # Used to configure the signup form
233
  requires_email_verification: false
234
  filters:
235
236
237
    cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
      whitelist: []
      blacklist: []
238

Chocobozzz's avatar
Chocobozzz committed
239
240
241
242
user:
  # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
  # -1 == unlimited
  video_quota: -1
Felix's avatar
Felix committed
243
  video_quota_daily: -1
Chocobozzz's avatar
Chocobozzz committed
244

245
# If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
246
# In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
Chocobozzz's avatar
Chocobozzz committed
247
# Please, do not disable transcoding since many uploaded videos will not work
248
transcoding:
249
  enabled: true
250

251
  # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
252
  allow_additional_extensions: true
253

Chocobozzz's avatar
Chocobozzz committed
254
255
  # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
  allow_audio_files: true
256

257
  # Amount of threads used by ffmpeg for 1 transcoding job
258
  threads: 1
259
260
  # Amount of transcoding jobs to execute in parallel
  concurrency: 1
261
262
263
264
265
266

  # Choose the transcoding profile
  # New profiles can be added by plugins
  # Available in core PeerTube: 'default'
  profile: 'default'

Chocobozzz's avatar
Chocobozzz committed
267
  resolutions: # Only created if the original video has a higher resolution, uses more storage!
268
    0p: false # audio-only (creates mp4 without video stream, always created when enabled)
269
270
271
272
273
    240p: false
    360p: false
    480p: false
    720p: false
    1080p: false
274
    1440p: false
275
    2160p: false
Chocobozzz's avatar
Chocobozzz committed
276
277
278

  # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
  # If you also enabled the hls format, it will multiply videos storage by 2
279
  # If disabled, breaks federation with PeerTube instances < 2.1
Chocobozzz's avatar
Chocobozzz committed
280
  webtorrent:
Chocobozzz's avatar
Chocobozzz committed
281
    enabled: false
Chocobozzz's avatar
Chocobozzz committed
282

283
  # /!\ Requires ffmpeg >= 4.1
Chocobozzz's avatar
Chocobozzz committed
284
  # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
Chocobozzz's avatar
Chocobozzz committed
285
286
287
  #     * Resolution change is smoother
  #     * Faster playback in particular with long videos
  #     * More stable playback (less bugs/infinite loading)
Chocobozzz's avatar
Chocobozzz committed
288
  # If you also enabled the webtorrent format, it will multiply videos storage by 2
Chocobozzz's avatar
Chocobozzz committed
289
  hls:
Chocobozzz's avatar
Chocobozzz committed
290
    enabled: true
291

292
293
294
live:
  enabled: false

295
  # Limit lives duration
296
297
  # -1 == unlimited
  max_duration: -1 # For example: '5 hours'
298

Chocobozzz's avatar
Chocobozzz committed
299
300
301
302
303
304
305
306
  # Limit max number of live videos created on your instance
  # -1 == unlimited
  max_instance_lives: 20

  # Limit max number of live videos created by a user on your instance
  # -1 == unlimited
  max_user_lives: 3

307
308
309
310
  # Allow your users to save a replay of their live
  # PeerTube will transcode segments in a video file
  # If the user daily/total quota is reached, PeerTube will stop the live
  # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
311
  allow_replay: true
312

313
  # Your firewall should accept traffic from this port in TCP if you enable live
314
315
316
  rtmp:
    port: 1935

317
  # Allow to transcode the live streaming in multiple live resolutions
318
  transcoding:
319
    enabled: true
320
321
    threads: 2

322
323
324
325
326
    # Choose the transcoding profile
    # New profiles can be added by plugins
    # Available in core PeerTube: 'default'
    profile: 'default'

327
328
329
330
331
332
    resolutions:
      240p: false
      360p: false
      480p: false
      720p: false
      1080p: false
333
      1440p: false
334
335
      2160p: false

336
337
338
import:
  # Add ability for your users to import remote videos (from YouTube, torrent...)
  videos:
339
340
341
    # Amount of import jobs to execute in parallel
    concurrency: 1

342
    http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
343
      enabled: false
Chocobozzz's avatar
Chocobozzz committed
344

345
      # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
Chocobozzz's avatar
Chocobozzz committed
346
347
      force_ipv4: false

348
349
350
351
      # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
      proxy:
        enabled: false
        url: ""
352
353
    torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
      enabled: false
354

355
356
357
358
359
360
auto_blacklist:
  # New videos automatically blacklisted so moderators can review before publishing
  videos:
    of_users:
      enabled: false

361
# Instance settings
362
363
instance:
  name: 'PeerTube'
364
  short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
365
366
  description: 'Welcome to this PeerTube instance!' # Support markdown
  terms: 'No terms for now.' # Support markdown
Chocobozzz's avatar
Chocobozzz committed
367
368
369
370
371
  code_of_conduct: '' # Supports markdown

  # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
  moderation_information: '' # Supports markdown

Chocobozzz's avatar
Chocobozzz committed
372
  # Why did you create this instance?
373
  creation_reason: '' # Supports Markdown
Chocobozzz's avatar
Chocobozzz committed
374

Chocobozzz's avatar
Chocobozzz committed
375
  # Who is behind the instance? A single person? A non profit?
376
  administrator: '' # Supports Markdown
Chocobozzz's avatar
Chocobozzz committed
377
378

  # How long do you plan to maintain this instance?
379
  maintenance_lifetime: '' # Supports Markdown
Chocobozzz's avatar
Chocobozzz committed
380

381
  # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
382
  business_model: '' # Supports Markdown
Chocobozzz's avatar
Chocobozzz committed
383

384
385
386
387
  # If you want to explain on what type of hardware your PeerTube instance runs
  # Example: "2 vCore, 2GB RAM..."
  hardware_information: '' # Supports Markdown

Chocobozzz's avatar
Chocobozzz committed
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
  # What are the main languages of your instance? To interact with your users for example
  # Uncomment or add the languages you want
  # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
  languages:
#    - en
#    - es
#    - fr

  # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
  # Uncomment or add the category ids you want
  # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
  categories:
#    - 1  # Music
#    - 2  # Films
#    - 3  # Vehicles
#    - 4  # Art
#    - 5  # Sports
#    - 6  # Travels
#    - 7  # Gaming
#    - 8  # People
#    - 9  # Comedy
#    - 10 # Entertainment
#    - 11 # News & Politics
#    - 12 # How To
#    - 13 # Education
#    - 14 # Activism
#    - 15 # Science & Technology
#    - 16 # Animals
#    - 17 # Kids
#    - 18 # Food

419
  default_client_route: '/videos/trending'
Chocobozzz's avatar
Chocobozzz committed
420

421
422
423
424
  # Whether or not the instance is dedicated to NSFW content
  # Enabling it will allow other administrators to know that you are mainly federating sensitive content
  # Moreover, the NSFW checkbox on video upload will be automatically checked by default
  is_nsfw: false
425
426
427
  # By default, "do_not_list" or "blur" or "display" NSFW videos
  # Could be overridden per user with a setting
  default_nsfw_policy: 'do_not_list'
Chocobozzz's avatar
Chocobozzz committed
428

429
430
431
  customizations:
    javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
    css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
Chocobozzz's avatar
Chocobozzz committed
432
  # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
Rigel Kent's avatar
Rigel Kent committed
433
434
  robots: |
    User-agent: *
435
    Disallow:
436
437
  # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
  securitytxt:
438
    "# 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:"
439
440
441
442

services:
  # Cards configuration to format video in Twitter
  twitter:
Chocobozzz's avatar
Chocobozzz committed
443
    username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
444
445
446
447
    # If true, a video player will be embedded in the Twitter feed on PeerTube video share
    # If false, we use an image link card that will redirect on your PeerTube instance
    # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
    whitelisted: false
Chocobozzz's avatar
Chocobozzz committed
448
449
450
451
452

followers:
  instance:
    # Allow or not other instances to follow yours
    enabled: true
453
454
    # Whether or not an administrator must manually validate a new follower
    manual_approval: false
Chocobozzz's avatar
Chocobozzz committed
455

456
457
458
459
460
461
462
463
464
465
466
467
468
followings:
  instance:
    # If you want to automatically follow back new instance followers
    # If this option is enabled, use the mute feature instead of deleting followings
    # /!\ Don't enable this if you don't have a reactive moderation team /!\
    auto_follow_back:
      enabled: false

    # If you want to automatically follow instances of the public index
    # If this option is enabled, use the mute feature instead of deleting followings
    # /!\ Don't enable this if you don't have a reactive moderation team /!\
    auto_follow_index:
      enabled: false
469
470
      # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
      index_url: ''
471

Chocobozzz's avatar
Chocobozzz committed
472
473
theme:
  default: 'default'
Chocobozzz's avatar
Chocobozzz committed
474
475
476
477

broadcast_message:
  enabled: false
  message: '' # Support markdown
Chocobozzz's avatar
Chocobozzz committed
478
  level: 'info' # 'info' | 'warning' | 'error'
Chocobozzz's avatar
Chocobozzz committed
479
  dismissable: false
Chocobozzz's avatar
Chocobozzz committed
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504

search:
  # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
  # If enabled, the associated group will be able to "escape" from the instance follows
  # That means they will be able to follow channels, watch videos, list videos of non followed instances
  remote_uri:
    users: true
    anonymous: false

  # Use a third party index instead of your local index, only for search results
  # Useful to discover content outside of your instance
  # If you enable search_index, you must enable remote_uri search for users
  # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
  # instead of loading the video locally
  search_index:
    enabled: false
    # URL of the search index, that should use the same search API and routes
    # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
    # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
    # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
    url: ''
    # You can disable local search, so users only use the search index
    disable_local_search: false
    # If you did not disable local search, you can decide to use the search index by default
    is_default_search: false