]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blob - config/default.yaml
Translated using Weblate (Chinese (Simplified))
[github/Chocobozzz/PeerTube.git] / config / default.yaml
1 # /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #
2
3 listen:
4 hostname: '127.0.0.1'
5 port: 9000
6
7 webserver:
8 https: false
9 hostname: 'localhost'
10 port: 9000
11
12 rates_limit:
13 api:
14 # 50 attempts in 10 seconds
15 window: 10 seconds
16 max: 100
17 login:
18 # 15 attempts in 5 min
19 window: 5 minutes
20 max: 15
21 signup:
22 # 2 attempts in 5 min (only succeeded attempts are taken into account)
23 window: 5 minutes
24 max: 2
25 ask_send_email:
26 # 3 attempts in 5 min
27 window: 5 minutes
28 max: 3
29
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)
33 trust_proxy:
34 - 'loopback'
35
36 # Your database name will be database.name OR "peertube"+database.suffix
37 database:
38 hostname: 'localhost'
39 port: 5432
40 suffix: '_dev'
41 username: 'peertube'
42 password: 'peertube'
43 pool:
44 max: 5
45
46 # You can also specify a 'socket' path to a unix socket but first need to
47 # comment out hostname and port
48 redis:
49 hostname: 'localhost'
50 port: 6379
51 auth: null
52 db: 0
53
54 smtp:
55 # smtp or sendmail
56 transport: smtp
57 # Path to sendmail command. Required if you use sendmail transport
58 sendmail: null
59 hostname: null
60 port: 465
61 username: null
62 password: null
63 tls: true
64 disable_starttls: false
65 ca_file: null # Used for self signed certificates
66 from_address: 'admin@example.com'
67
68 email:
69 body:
70 signature: "PeerTube"
71 subject:
72 prefix: "[PeerTube]"
73
74 # From the project root directory
75 storage:
76 tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before processing...
77 avatars: 'storage/avatars/'
78 videos: 'storage/videos/'
79 streaming_playlists: 'storage/streaming-playlists/'
80 redundancy: 'storage/redundancy/'
81 logs: 'storage/logs/'
82 previews: 'storage/previews/'
83 thumbnails: 'storage/thumbnails/'
84 torrents: 'storage/torrents/'
85 captions: 'storage/captions/'
86 cache: 'storage/cache/'
87 plugins: 'storage/plugins/'
88 # Overridable client files : logo.svg, favicon.png and icons/*.png (PWA) in client/dist/assets/images
89 # Could contain for example assets/images/favicon.png
90 # If the file exists, peertube will serve it
91 # If not, peertube will fallback to the default fil
92 client_overrides: 'storage/client-overrides/'
93
94 log:
95 level: 'info' # debug/info/warning/error
96 rotation:
97 enabled : true
98 maxFileSize: 12MB
99 maxFiles: 20
100 anonymizeIP: false
101
102 trending:
103 videos:
104 interval_days: 7 # Compute trending videos for the last x days
105
106 # Cache remote videos on your server, to help other instances to broadcast the video
107 # You can define multiple caches using different sizes/strategies
108 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
109 redundancy:
110 videos:
111 check_interval: '1 hour' # How often you want to check new videos to cache
112 strategies: # Just uncomment strategies you want
113 # -
114 # size: '10GB'
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'
117 # strategy: 'most-views' # Cache videos that have the most views
118 # -
119 # size: '10GB'
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'
122 # strategy: 'trending' # Cache trending videos
123 # -
124 # size: '10GB'
125 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
126 # min_lifetime: '48 hours'
127 # strategy: 'recently-added' # Cache recently added videos
128 # min_views: 10 # Having at least x views
129
130 # Other instances that duplicate your content
131 remote_redundancy:
132 videos:
133 # 'nobody': Do not accept remote redundancies
134 # 'anybody': Accept remote redundancies from anybody
135 # 'followings': Accept redundancies from instance followings
136 accept_from: 'anybody'
137
138 csp:
139 enabled: false
140 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
141 report_uri:
142
143 tracker:
144 # If you disable the tracker, you disable the P2P aspect of PeerTube
145 enabled: true
146 # Only handle requests on your videos.
147 # If you set this to false it means you have a public tracker.
148 # Then, it is possible that clients overload your instance with external torrents
149 private: true
150 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
151 reject_too_many_announces: false
152
153 history:
154 videos:
155 # If you want to limit users videos history
156 # -1 means there is no limitations
157 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
158 max_age: -1
159
160 views:
161 videos:
162 # PeerTube creates a database entry every hour for each video to track views over a period of time
163 # This is used in particular by the Trending page
164 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
165 # -1 means no cleanup
166 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
167 remote:
168 max_age: -1
169
170 plugins:
171 # The website PeerTube will ask for available PeerTube plugins and themes
172 # This is an unmoderated plugin index, so only install plugins/themes you trust
173 index:
174 enabled: true
175 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
176 url: 'https://packages.joinpeertube.org'
177
178 federation:
179 videos:
180 federate_unlisted: true
181
182 cache:
183 previews:
184 size: 500 # Max number of previews you want to cache
185 captions:
186 size: 500 # Max number of video captions/subtitles you want to cache
187
188 admin:
189 # Used to generate the root user at first startup
190 # And to receive emails from the contact form
191 email: 'admin@example.com'
192
193 contact_form:
194 enabled: true
195
196 signup:
197 enabled: false
198 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
199 requires_email_verification: false
200 filters:
201 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
202 whitelist: []
203 blacklist: []
204
205 user:
206 # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
207 # -1 == unlimited
208 video_quota: -1
209 video_quota_daily: -1
210
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
214 transcoding:
215 enabled: true
216 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut 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
220 threads: 1
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)
223 240p: false
224 360p: false
225 480p: false
226 720p: false
227 1080p: false
228 2160p: false
229
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
233 webtorrent:
234 enabled: true
235
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
242 hls:
243 enabled: false
244
245 import:
246 # Add ability for your users to import remote videos (from YouTube, torrent...)
247 videos:
248 http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
249 enabled: false
250 # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
251 proxy:
252 enabled: false
253 url: ""
254 torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
255 enabled: false
256
257 auto_blacklist:
258 # New videos automatically blacklisted so moderators can review before publishing
259 videos:
260 of_users:
261 enabled: false
262
263 instance:
264 name: 'PeerTube'
265 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
266 description: 'Welcome to this PeerTube instance!' # Support markdown
267 terms: 'No terms for now.' # Support markdown
268 code_of_conduct: '' # Supports markdown
269
270 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
271 moderation_information: '' # Supports markdown
272
273 # Why did you create this instance?
274 creation_reason: ''
275
276 # Who is behind the instance? A single person? A non profit?
277 administrator: ''
278
279 # How long do you plan to maintain this instance?
280 maintenance_lifetime: ''
281
282 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
283 business_model: ''
284
285 # If you want to explain on what type of hardware your PeerTube instance runs
286 # Example: "2 vCore, 2GB RAM..."
287 hardware_information: '' # Supports Markdown
288
289 # What are the main languages of your instance? To interact with your users for example
290 # Uncomment or add the languages you want
291 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
292 languages:
293 # - en
294 # - es
295 # - fr
296
297 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
298 # Uncomment or add the category ids you want
299 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
300 categories:
301 # - 1 # Music
302 # - 2 # Films
303 # - 3 # Vehicles
304 # - 4 # Art
305 # - 5 # Sports
306 # - 6 # Travels
307 # - 7 # Gaming
308 # - 8 # People
309 # - 9 # Comedy
310 # - 10 # Entertainment
311 # - 11 # News & Politics
312 # - 12 # How To
313 # - 13 # Education
314 # - 14 # Activism
315 # - 15 # Science & Technology
316 # - 16 # Animals
317 # - 17 # Kids
318 # - 18 # Food
319
320 default_client_route: '/videos/trending'
321
322 # Whether or not the instance is dedicated to NSFW content
323 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
324 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
325 is_nsfw: false
326 # By default, "do_not_list" or "blur" or "display" NSFW videos
327 # Could be overridden per user with a setting
328 default_nsfw_policy: 'do_not_list'
329
330 customizations:
331 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
332 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
333 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
334 robots: |
335 User-agent: *
336 Disallow:
337 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
338 securitytxt:
339 "# 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:"
340
341 services:
342 # Cards configuration to format video in Twitter
343 twitter:
344 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
345 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
346 # If false, we use an image link card that will redirect on your PeerTube instance
347 # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
348 whitelisted: false
349
350 followers:
351 instance:
352 # Allow or not other instances to follow yours
353 enabled: true
354 # Whether or not an administrator must manually validate a new follower
355 manual_approval: false
356
357 followings:
358 instance:
359 # If you want to automatically follow back new instance followers
360 # Only follows accepted followers (in case you enabled manual followers approbation)
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 /!\
363 auto_follow_back:
364 enabled: false
365
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 /!\
369 auto_follow_index:
370 enabled: false
371 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
372 index_url: ''
373
374 theme:
375 default: 'default'
376
377 broadcast_message:
378 enabled: false
379 message: '' # Support markdown
380 level: 'info' # 'info' | 'warning' | 'error'
381 dismissable: false
382
383 search:
384 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
385 # If enabled, the associated group will be able to "escape" from the instance follows
386 # That means they will be able to follow channels, watch videos, list videos of non followed instances
387 remote_uri:
388 users: true
389 anonymous: false
390
391 # Use a third party index instead of your local index, only for search results
392 # Useful to discover content outside of your instance
393 # If you enable search_index, you must enable remote_uri search for users
394 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
395 # instead of loading the video locally
396 search_index:
397 enabled: false
398 # URL of the search index, that should use the same search API and routes
399 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
400 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
401 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
402 url: ''
403 # You can disable local search, so users only use the search index
404 disable_local_search: false
405 # If you did not disable local search, you can decide to use the search index by default
406 is_default_search: false