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