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