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