]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - config/default.yaml
change fixtures to reflect output size of jimp
[github/Chocobozzz/PeerTube.git] / config / default.yaml
CommitLineData
6401417d
C
1# /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #
2
8c308c2b 3listen:
cff8b272 4 hostname: '127.0.0.1'
8c308c2b
C
5 port: 9000
6
7webserver:
8 https: false
3737bbaf 9 hostname: 'localhost'
8c308c2b
C
10 port: 9000
11
c342726a 12rates_limit:
c1340a6a
C
13 api:
14 # 50 attempts in 10 seconds
15 window: 10 seconds
0502e3d0 16 max: 100
c342726a
YB
17 login:
18 # 15 attempts in 5 min
19 window: 5 minutes
20 max: 15
c1340a6a
C
21 signup:
22 # 2 attempts in 5 min (only succeeded attempts are taken into account)
23 window: 5 minutes
24 max: 2
c342726a
YB
25 ask_send_email:
26 # 3 attempts in 5 min
27 window: 5 minutes
28 max: 3
29
490b595a
C
30# Proxies to trust to get real client IP
31# If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
32# If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
33trust_proxy:
34 - 'loopback'
35
98dffd10 36# Your database name will be "peertube"+database.suffix
8c308c2b 37database:
3737bbaf 38 hostname: 'localhost'
feb4bdfd
C
39 port: 5432
40 suffix: '_dev'
55fa55a9
C
41 username: 'peertube'
42 password: 'peertube'
1c3386e8
RK
43 pool:
44 max: 5
8c308c2b 45
19f7b248
RK
46# You can also specify a 'socket' path to a unix socket but first need to
47# comment out hostname and port
94a5ff8a
C
48redis:
49 hostname: 'localhost'
50 port: 6379
51 auth: null
30c82f0d 52 db: 0
94a5ff8a 53
ecb4e35f 54smtp:
ed3f089c
IB
55 # smtp or sendmail
56 transport: smtp
57 # Path to sendmail command. Required if you use sendmail transport
58 sendmail: null
ecb4e35f
C
59 hostname: null
60 port: 465
61 username: null
62 password: null
63 tls: true
bebf2d89 64 disable_starttls: false
ecb4e35f
C
65 ca_file: null # Used for self signed certificates
66 from_address: 'admin@example.com'
67
b5bfadf0
YB
68email:
69 body:
70 signature: "PeerTube"
916937d7 71 subject:
b5bfadf0
YB
72 prefix: "[PeerTube]"
73
8c308c2b
C
74# From the project root directory
75storage:
aafbc63a 76 tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before processing...
6b2ef589 77 avatars: 'storage/avatars/'
6b2ef589 78 videos: 'storage/videos/'
9c6ca37f 79 streaming_playlists: 'storage/streaming-playlists/'
6040f87d 80 redundancy: 'storage/redundancy/'
6b2ef589
C
81 logs: 'storage/logs/'
82 previews: 'storage/previews/'
83 thumbnails: 'storage/thumbnails/'
84 torrents: 'storage/torrents/'
40e87e9e 85 captions: 'storage/captions/'
6b2ef589 86 cache: 'storage/cache/'
345da516 87 plugins: 'storage/plugins/'
f981dae8 88
23e27dd5 89log:
a0922eb9 90 level: 'info' # debug/info/warning/error
fcf4569f 91 rotation:
aafbc63a 92 enabled : true
2f6b5e2d
C
93 maxFileSize: 12MB
94 maxFiles: 20
95 anonymizeIP: false
23e27dd5 96
1297eb5d 97search:
8d427346
C
98 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
99 # If enabled, the associated group will be able to "escape" from the instance follows
100 # That means they will be able to follow channels, watch videos, list videos of non followed instances
101 remote_uri:
1297eb5d
C
102 users: true
103 anonymous: false
104
9a629c6e
C
105trending:
106 videos:
107 interval_days: 7 # Compute trending videos for the last x days
108
c48e82b5
C
109# Cache remote videos on your server, to help other instances to broadcast the video
110# You can define multiple caches using different sizes/strategies
111# Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
112redundancy:
113 videos:
f9f899b9 114 check_interval: '1 hour' # How often you want to check new videos to cache
6040f87d 115 strategies: # Just uncomment strategies you want
d9bdd007
C
116# -
117# size: '10GB'
e5565833
C
118# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
119# min_lifetime: '48 hours'
d9bdd007
C
120# strategy: 'most-views' # Cache videos that have the most views
121# -
122# size: '10GB'
e5565833
C
123# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
124# min_lifetime: '48 hours'
d9bdd007
C
125# strategy: 'trending' # Cache trending videos
126# -
127# size: '10GB'
e5565833
C
128# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
129# min_lifetime: '48 hours'
d9bdd007 130# strategy: 'recently-added' # Cache recently added videos
e5565833 131# min_views: 10 # Having at least x views
c48e82b5 132
8c9e7875
C
133# Other instances that duplicate your content
134remote_redundancy:
135 videos:
136 # 'nobody': Do not accept remote redundancies
137 # 'anybody': Accept remote redundancies from anybody
138 # 'followings': Accept redundancies from instance followings
139 accept_from: 'anybody'
140
539d3f4f
C
141csp:
142 enabled: false
143 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
144 report_uri:
145
31b6ddf8
C
146tracker:
147 # If you disable the tracker, you disable the P2P aspect of PeerTube
148 enabled: true
149 # Only handle requests on your videos.
150 # If you set this to false it means you have a public tracker.
151 # Then, it is possible that clients overload your instance with external torrents
152 private: true
153 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
154 reject_too_many_announces: false
155
8f0bc73d
C
156history:
157 videos:
158 # If you want to limit users videos history
159 # -1 means there is no limitations
160 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
161 max_age: -1
162
cda03765
C
163views:
164 videos:
165 # PeerTube creates a database entry every hour for each video to track views over a period of time
166 # This is used in particular by the Trending page
167 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
168 # -1 means no cleanup
169 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
170 remote:
171 max_age: -1
172
6702a1b2 173plugins:
d133f385
C
174 # The website PeerTube will ask for available PeerTube plugins and themes
175 # This is an unmoderated plugin index, so only install plugins/themes you trust
6702a1b2
C
176 index:
177 enabled: true
df9a1a13 178 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
6702a1b2
C
179 url: 'https://packages.joinpeertube.org'
180
3092e9bb
LB
181federation:
182 videos:
183 federate_unlisted: true
184
f981dae8
C
185cache:
186 previews:
f842e810 187 size: 500 # Max number of previews you want to cache
40e87e9e 188 captions:
f842e810 189 size: 500 # Max number of video captions/subtitles you want to cache
4793c343
C
190
191admin:
a4101923
C
192 # Used to generate the root user at first startup
193 # And to receive emails from the contact form
194 email: 'admin@example.com'
195
196contact_form:
197 enabled: true
e22528ac
C
198
199signup:
200 enabled: false
291e8d3e 201 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
d9eaee39 202 requires_email_verification: false
6401417d 203 filters:
ff2c1fe8
RK
204 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
205 whitelist: []
206 blacklist: []
227d02fe 207
b0f9f39e
C
208user:
209 # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
210 # -1 == unlimited
211 video_quota: -1
bee0abff 212 video_quota_daily: -1
b0f9f39e 213
227d02fe 214# If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
40298b02 215# In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
09f35e2a 216# Please, do not disable transcoding since many uploaded videos will not work
227d02fe 217transcoding:
1125c40a 218 enabled: true
14e2014a
C
219 # Allow your users to upload .mkv, .mov, .avi, .flv videos
220 allow_additional_extensions: true
536598cf
C
221 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
222 allow_audio_files: true
98f535a5 223 threads: 1
09f35e2a 224 resolutions: # Only created if the original video has a higher resolution, uses more storage!
6ad88df8 225 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
1125c40a
C
226 240p: false
227 360p: false
228 480p: false
229 720p: false
230 1080p: false
ad3405d0 231 2160p: false
d7a25329
C
232
233 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
234 # If you also enabled the hls format, it will multiply videos storage by 2
04cda1d7 235 # If disabled, breaks federation with PeerTube instances < 2.1
d7a25329
C
236 webtorrent:
237 enabled: true
238
5d9e4eaa 239 # /!\ Requires ffmpeg >= 4.1
7f8f8bdb 240 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
09209296
C
241 # * Resolution change is smoother
242 # * Faster playback in particular with long videos
243 # * More stable playback (less bugs/infinite loading)
d7a25329 244 # If you also enabled the webtorrent format, it will multiply videos storage by 2
09209296
C
245 hls:
246 enabled: false
66b16caf 247
fbad87b0
C
248import:
249 # Add ability for your users to import remote videos (from YouTube, torrent...)
250 videos:
251 http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
5d08a6a7 252 enabled: false
be7ca0c6
C
253 # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
254 proxy:
255 enabled: false
256 url: ""
a84b8fa5
C
257 torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
258 enabled: false
fbad87b0 259
7ccddd7b
JM
260auto_blacklist:
261 # New videos automatically blacklisted so moderators can review before publishing
262 videos:
263 of_users:
264 enabled: false
265
66b16caf
C
266instance:
267 name: 'PeerTube'
482fa503 268 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
bf874e33
C
269 description: 'Welcome to this PeerTube instance!' # Support markdown
270 terms: 'No terms for now.' # Support markdown
ccc00cb2
C
271 code_of_conduct: '' # Supports markdown
272
273 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
274 moderation_information: '' # Supports markdown
275
8ae03c37
C
276 # Why did you create this instance?
277 creation_reason: ''
278
ccc00cb2
C
279 # Who is behind the instance? A single person? A non profit?
280 administrator: ''
281
282 # How long do you plan to maintain this instance?
283 maintenance_lifetime: ''
284
96a4a7c3 285 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
ccc00cb2
C
286 business_model: ''
287
be04c6fd
C
288 # If you want to explain on what type of hardware your PeerTube instance runs
289 # Example: "2 vCore, 2GB RAM..."
290 hardware_information: '' # Supports Markdown
291
ccc00cb2
C
292 # What are the main languages of your instance? To interact with your users for example
293 # Uncomment or add the languages you want
294 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
295 languages:
296# - en
297# - es
298# - fr
299
300 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
301 # Uncomment or add the category ids you want
302 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
303 categories:
304# - 1 # Music
305# - 2 # Films
306# - 3 # Vehicles
307# - 4 # Art
308# - 5 # Sports
309# - 6 # Travels
310# - 7 # Gaming
311# - 8 # People
312# - 9 # Comedy
313# - 10 # Entertainment
314# - 11 # News & Politics
315# - 12 # How To
316# - 13 # Education
317# - 14 # Activism
318# - 15 # Science & Technology
319# - 16 # Animals
320# - 17 # Kids
321# - 18 # Food
322
901637bb 323 default_client_route: '/videos/trending'
ccc00cb2 324
f8802489
C
325 # Whether or not the instance is dedicated to NSFW content
326 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
327 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
328 is_nsfw: false
0883b324
C
329 # By default, "do_not_list" or "blur" or "display" NSFW videos
330 # Could be overridden per user with a setting
331 default_nsfw_policy: 'do_not_list'
ccc00cb2 332
00b5556c
C
333 customizations:
334 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
335 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
78881bc4 336 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
ac235c37
RK
337 robots: |
338 User-agent: *
df182b37 339 Disallow:
5447516b
AH
340 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
341 securitytxt:
1f4f1510 342 "# 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:"
8be1afa1
C
343
344services:
345 # Cards configuration to format video in Twitter
346 twitter:
351d5225 347 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
8be1afa1
C
348 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
349 # If false, we use an image link card that will redirect on your PeerTube instance
350 # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
351 whitelisted: false
5b9c965d
C
352
353followers:
354 instance:
355 # Allow or not other instances to follow yours
356 enabled: true
14893eb7
C
357 # Whether or not an administrator must manually validate a new follower
358 manual_approval: false
7cd4d2ba 359
8424c402
C
360followings:
361 instance:
362 # If you want to automatically follow back new instance followers
363 # Only follows accepted followers (in case you enabled manual followers approbation)
364 # If this option is enabled, use the mute feature instead of deleting followings
365 # /!\ Don't enable this if you don't have a reactive moderation team /!\
366 auto_follow_back:
367 enabled: false
368
369 # If you want to automatically follow instances of the public index
370 # If this option is enabled, use the mute feature instead of deleting followings
371 # /!\ Don't enable this if you don't have a reactive moderation team /!\
372 auto_follow_index:
373 enabled: false
95cd31f1
C
374 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
375 index_url: ''
8424c402 376
7cd4d2ba
C
377theme:
378 default: 'default'
72c33e71
C
379
380broadcast_message:
381 enabled: false
382 message: '' # Support markdown
383 level: 'info' # 'info' | 'warning' | 'error'
384 dismissable: false