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