Add ability to search available plugins
[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   object:
68     prefix: "[PeerTube]"
69
70 # From the project root directory
71 storage:
72   tmp: 'storage/tmp/' # Used 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 # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
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
160   # This is an unmoderated plugin index, so only install plugins you trust
161   index:
162     enabled: true
163     url: 'https://packages.joinpeertube.org'
164
165 cache:
166   previews:
167     size: 500 # Max number of previews you want to cache
168   captions:
169     size: 500 # Max number of video captions/subtitles you want to cache
170
171 admin:
172   # Used to generate the root user at first startup
173   # And to receive emails from the contact form
174   email: 'admin@example.com'
175
176 contact_form:
177   enabled: true
178
179 signup:
180   enabled: false
181   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
182   requires_email_verification: false
183   filters:
184     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
185       whitelist: []
186       blacklist: []
187
188 user:
189   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
190   # -1 == unlimited
191   video_quota: -1
192   video_quota_daily: -1
193
194 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
195 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
196 # Please, do not disable transcoding since many uploaded videos will not work
197 transcoding:
198   enabled: true
199   # Allow your users to upload .mkv, .mov, .avi, .flv videos
200   allow_additional_extensions: true
201   # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
202   allow_audio_files: true
203   threads: 1
204   resolutions: # Only created if the original video has a higher resolution, uses more storage!
205     240p: false
206     360p: false
207     480p: false
208     720p: false
209     1080p: false
210     2160p: false
211   # /!\ EXPERIMENTAL /!\
212   # /!\ Requires ffmpeg >= 4
213   # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
214   #     * Resolution change is smoother
215   #     * Faster playback in particular with long videos
216   #     * More stable playback (less bugs/infinite loading)
217   # /!\ Multiplies videos storage by 2 /!\
218   hls:
219     enabled: false
220
221 import:
222   # Add ability for your users to import remote videos (from YouTube, torrent...)
223   videos:
224     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
225       enabled: false
226     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
227       enabled: false
228
229 auto_blacklist:
230   # New videos automatically blacklisted so moderators can review before publishing
231   videos:
232     of_users:
233       enabled: false
234
235 instance:
236   name: 'PeerTube'
237   short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
238   description: 'Welcome to this PeerTube instance!' # Support markdown
239   terms: 'No terms for now.' # Support markdown
240   default_client_route: '/videos/trending'
241   # Whether or not the instance is dedicated to NSFW content
242   # Enabling it will allow other administrators to know that you are mainly federating sensitive content
243   # Moreover, the NSFW checkbox on video upload will be automatically checked by default
244   is_nsfw: false
245   # By default, "do_not_list" or "blur" or "display" NSFW videos
246   # Could be overridden per user with a setting
247   default_nsfw_policy: 'do_not_list'
248   customizations:
249     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
250     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
251   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
252   robots: |
253     User-agent: *
254     Disallow:
255   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
256   securitytxt:
257     "# 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:"
258
259 services:
260   # Cards configuration to format video in Twitter
261   twitter:
262     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
263     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
264     # If false, we use an image link card that will redirect on your PeerTube instance
265     # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
266     whitelisted: false
267
268 followers:
269   instance:
270     # Allow or not other instances to follow yours
271     enabled: true
272     # Whether or not an administrator must manually validate a new follower
273     manual_approval: false
274
275 theme:
276   default: 'default'