]>
Commit | Line | Data |
---|---|---|
6401417d C |
1 | # /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ # |
2 | ||
8c308c2b | 3 | listen: |
cff8b272 | 4 | hostname: '127.0.0.1' |
8c308c2b C |
5 | port: 9000 |
6 | ||
d8658f0f | 7 | # Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL) |
8c308c2b C |
8 | webserver: |
9 | https: false | |
3737bbaf | 10 | hostname: 'localhost' |
8c308c2b C |
11 | port: 9000 |
12 | ||
c342726a | 13 | rates_limit: |
c1340a6a C |
14 | api: |
15 | # 50 attempts in 10 seconds | |
16 | window: 10 seconds | |
3258fa55 | 17 | max: 50 |
c342726a YB |
18 | login: |
19 | # 15 attempts in 5 min | |
20 | window: 5 minutes | |
21 | max: 15 | |
c1340a6a C |
22 | signup: |
23 | # 2 attempts in 5 min (only succeeded attempts are taken into account) | |
24 | window: 5 minutes | |
25 | max: 2 | |
c342726a YB |
26 | ask_send_email: |
27 | # 3 attempts in 5 min | |
28 | window: 5 minutes | |
29 | max: 3 | |
30 | ||
490b595a C |
31 | # Proxies to trust to get real client IP |
32 | # If you run PeerTube just behind a local proxy (nginx), keep 'loopback' | |
33 | # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet) | |
34 | trust_proxy: | |
35 | - 'loopback' | |
36 | ||
97b6428a | 37 | # Your database name will be database.name OR 'peertube'+database.suffix |
8c308c2b | 38 | database: |
3737bbaf | 39 | hostname: 'localhost' |
feb4bdfd | 40 | port: 5432 |
b0ce7c39 | 41 | ssl: false |
feb4bdfd | 42 | suffix: '_dev' |
55fa55a9 C |
43 | username: 'peertube' |
44 | password: 'peertube' | |
1c3386e8 RK |
45 | pool: |
46 | max: 5 | |
8c308c2b | 47 | |
3258fa55 | 48 | # Redis server for short time storage |
19f7b248 RK |
49 | # You can also specify a 'socket' path to a unix socket but first need to |
50 | # comment out hostname and port | |
94a5ff8a C |
51 | redis: |
52 | hostname: 'localhost' | |
53 | port: 6379 | |
54 | auth: null | |
30c82f0d | 55 | db: 0 |
94a5ff8a | 56 | |
3258fa55 | 57 | # SMTP server to send emails |
ecb4e35f | 58 | smtp: |
ed3f089c IB |
59 | # smtp or sendmail |
60 | transport: smtp | |
61 | # Path to sendmail command. Required if you use sendmail transport | |
62 | sendmail: null | |
ecb4e35f | 63 | hostname: null |
3258fa55 | 64 | port: 465 # If you use StartTLS: 587 |
ecb4e35f C |
65 | username: null |
66 | password: null | |
3258fa55 | 67 | tls: true # If you use StartTLS: false |
bebf2d89 | 68 | disable_starttls: false |
ecb4e35f C |
69 | ca_file: null # Used for self signed certificates |
70 | from_address: 'admin@example.com' | |
71 | ||
b5bfadf0 YB |
72 | email: |
73 | body: | |
97b6428a | 74 | signature: 'PeerTube' |
916937d7 | 75 | subject: |
97b6428a | 76 | prefix: '[PeerTube]' |
b5bfadf0 | 77 | |
3cf68b86 C |
78 | # Update default PeerTube values |
79 | # Set by API when the field is not provided and put as default value in client | |
80 | defaults: | |
81 | # Change default values when publishing a video (upload/import/go Live) | |
82 | publish: | |
83 | download_enabled: true | |
7399a79f | 84 | |
3cf68b86 C |
85 | comments_enabled: true |
86 | ||
87 | # public = 1, unlisted = 2, private = 3, internal = 4 | |
88 | privacy: 1 | |
89 | ||
90 | # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7 | |
91 | # You can also choose a custom licence value added by a plugin | |
92 | # No licence by default | |
93 | licence: null | |
0bc53e20 | 94 | |
a9bfa85d | 95 | p2p: |
b65de1be | 96 | # Enable P2P by default in PeerTube client |
a9bfa85d | 97 | # Can be enabled/disabled by anonymous users and logged in users |
b65de1be C |
98 | webapp: |
99 | enabled: true | |
100 | ||
101 | # Enable P2P by default in PeerTube embed | |
102 | # Can be enabled/disabled by URL option | |
103 | embed: | |
104 | enabled: true | |
a9bfa85d | 105 | |
8c308c2b C |
106 | # From the project root directory |
107 | storage: | |
37ede348 | 108 | tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing... |
62549e6c | 109 | bin: 'storage/bin/' |
6b2ef589 | 110 | avatars: 'storage/avatars/' |
6b2ef589 | 111 | videos: 'storage/videos/' |
9c6ca37f | 112 | streaming_playlists: 'storage/streaming-playlists/' |
6040f87d | 113 | redundancy: 'storage/redundancy/' |
6b2ef589 C |
114 | logs: 'storage/logs/' |
115 | previews: 'storage/previews/' | |
116 | thumbnails: 'storage/thumbnails/' | |
117 | torrents: 'storage/torrents/' | |
40e87e9e | 118 | captions: 'storage/captions/' |
6b2ef589 | 119 | cache: 'storage/cache/' |
345da516 | 120 | plugins: 'storage/plugins/' |
94fecbc1 | 121 | # Overridable client files in client/dist/assets/images: |
c80e458a | 122 | # - logo.svg |
123 | # - favicon.png | |
124 | # - default-playlist.jpg | |
125 | # - default-avatar-account.png | |
126 | # - default-avatar-video-channel.png | |
127 | # - and icons/*.png (PWA) | |
caf2aaf4 K |
128 | # Could contain for example assets/images/favicon.png |
129 | # If the file exists, peertube will serve it | |
94fecbc1 | 130 | # If not, peertube will fallback to the default file |
caf2aaf4 | 131 | client_overrides: 'storage/client-overrides/' |
f981dae8 | 132 | |
0305db28 JB |
133 | object_storage: |
134 | enabled: false | |
135 | ||
136 | # Without protocol, will default to HTTPS | |
137 | endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example | |
138 | ||
139 | region: 'us-east-1' | |
140 | ||
141 | credentials: | |
142 | # You can also use AWS_ACCESS_KEY_ID env variable | |
143 | access_key_id: '' | |
144 | # You can also use AWS_SECRET_ACCESS_KEY env variable | |
145 | secret_access_key: '' | |
146 | ||
147 | # Maximum amount to upload in one request to object storage | |
148 | max_upload_part: 2GB | |
149 | ||
150 | streaming_playlists: | |
151 | bucket_name: 'streaming-playlists' | |
152 | ||
153 | # Allows setting all buckets to the same value but with a different prefix | |
154 | prefix: '' # Example: 'streaming-playlists:' | |
155 | ||
156 | # Base url for object URL generation, scheme and host will be replaced by this URL | |
157 | # Useful when you want to use a CDN/external proxy | |
158 | base_url: '' # Example: 'https://mirror.example.com' | |
159 | ||
160 | # Same settings but for webtorrent videos | |
161 | videos: | |
162 | bucket_name: 'videos' | |
163 | prefix: '' | |
164 | base_url: '' | |
165 | ||
23e27dd5 | 166 | log: |
31a91119 | 167 | level: 'info' # 'debug' | 'info' | 'warn' | 'error' |
fcf4569f | 168 | rotation: |
3258fa55 | 169 | enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate |
97b6428a C |
170 | max_file_size: 12MB |
171 | max_files: 20 | |
172 | anonymize_ip: false | |
12c1e38d | 173 | log_ping_requests: true |
1e743faa | 174 | prettify_sql: false |
23e27dd5 | 175 | |
9a629c6e C |
176 | trending: |
177 | videos: | |
178 | interval_days: 7 # Compute trending videos for the last x days | |
ba5d4a84 RK |
179 | algorithms: |
180 | enabled: | |
3d4e112d RK |
181 | - 'best' # adaptation of Reddit's 'Best' algorithm (Hot minus History) |
182 | - 'hot' # adaptation of Reddit's 'Hot' algorithm | |
ba5d4a84 RK |
183 | - 'most-viewed' # default, used initially by PeerTube as the trending page |
184 | - 'most-liked' | |
185 | default: 'most-viewed' | |
9a629c6e | 186 | |
c48e82b5 C |
187 | # Cache remote videos on your server, to help other instances to broadcast the video |
188 | # You can define multiple caches using different sizes/strategies | |
189 | # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following | |
190 | redundancy: | |
191 | videos: | |
f9f899b9 | 192 | check_interval: '1 hour' # How often you want to check new videos to cache |
6040f87d | 193 | strategies: # Just uncomment strategies you want |
d9bdd007 C |
194 | # - |
195 | # size: '10GB' | |
e5565833 C |
196 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
197 | # min_lifetime: '48 hours' | |
d9bdd007 C |
198 | # strategy: 'most-views' # Cache videos that have the most views |
199 | # - | |
200 | # size: '10GB' | |
e5565833 C |
201 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
202 | # min_lifetime: '48 hours' | |
d9bdd007 C |
203 | # strategy: 'trending' # Cache trending videos |
204 | # - | |
205 | # size: '10GB' | |
e5565833 C |
206 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
207 | # min_lifetime: '48 hours' | |
d9bdd007 | 208 | # strategy: 'recently-added' # Cache recently added videos |
e5565833 | 209 | # min_views: 10 # Having at least x views |
c48e82b5 | 210 | |
8c9e7875 C |
211 | # Other instances that duplicate your content |
212 | remote_redundancy: | |
213 | videos: | |
214 | # 'nobody': Do not accept remote redundancies | |
215 | # 'anybody': Accept remote redundancies from anybody | |
216 | # 'followings': Accept redundancies from instance followings | |
217 | accept_from: 'anybody' | |
218 | ||
539d3f4f C |
219 | csp: |
220 | enabled: false | |
221 | report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk! | |
222 | report_uri: | |
223 | ||
8155db66 C |
224 | security: |
225 | # Set the X-Frame-Options header to help to mitigate clickjacking attacks | |
226 | frameguard: | |
227 | enabled: true | |
228 | ||
31b6ddf8 | 229 | tracker: |
a9bfa85d | 230 | # If you disable the tracker, you disable the P2P on your PeerTube instance |
31b6ddf8 | 231 | enabled: true |
de7f1114 C |
232 | # Only handle requests on your videos |
233 | # If you set this to false it means you have a public tracker | |
31b6ddf8 C |
234 | # Then, it is possible that clients overload your instance with external torrents |
235 | private: true | |
236 | # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers) | |
237 | reject_too_many_announces: false | |
238 | ||
8f0bc73d C |
239 | history: |
240 | videos: | |
241 | # If you want to limit users videos history | |
242 | # -1 means there is no limitations | |
243 | # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database) | |
244 | max_age: -1 | |
245 | ||
cda03765 C |
246 | views: |
247 | videos: | |
248 | # PeerTube creates a database entry every hour for each video to track views over a period of time | |
249 | # This is used in particular by the Trending page | |
250 | # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered) | |
251 | # -1 means no cleanup | |
252 | # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database) | |
253 | remote: | |
acfa2e30 | 254 | max_age: '30 days' |
cda03765 | 255 | |
51353d9a C |
256 | # PeerTube buffers local video views before updating and federating the video |
257 | local_buffer_update_interval: '30 minutes' | |
258 | ||
259 | ip_view_expiration: '1 hour' | |
260 | ||
6702a1b2 | 261 | plugins: |
d133f385 C |
262 | # The website PeerTube will ask for available PeerTube plugins and themes |
263 | # This is an unmoderated plugin index, so only install plugins/themes you trust | |
6702a1b2 C |
264 | index: |
265 | enabled: true | |
df9a1a13 | 266 | check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions |
6702a1b2 C |
267 | url: 'https://packages.joinpeertube.org' |
268 | ||
3092e9bb LB |
269 | federation: |
270 | videos: | |
87568f93 | 271 | federate_unlisted: false |
3092e9bb | 272 | |
74d249bc C |
273 | # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments) |
274 | # It removes objects that do not exist anymore, and potentially fix their URLs | |
c5e53d0e | 275 | cleanup_remote_interactions: true |
74d249bc | 276 | |
32a18cbf C |
277 | peertube: |
278 | check_latest_version: | |
279 | # Check and notify admins of new PeerTube versions | |
280 | enabled: true | |
281 | # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json | |
282 | url: 'https://joinpeertube.org/api/v1/versions.json' | |
283 | ||
8d8a037e JB |
284 | webadmin: |
285 | configuration: | |
cf0c8ee5 | 286 | edition: |
e89392d7 | 287 | # Set this to false if you don't want to allow config edition in the web interface by instance admins |
8d8a037e JB |
288 | allowed: true |
289 | ||
f981dae8 C |
290 | cache: |
291 | previews: | |
f842e810 | 292 | size: 500 # Max number of previews you want to cache |
40e87e9e | 293 | captions: |
f842e810 | 294 | size: 500 # Max number of video captions/subtitles you want to cache |
90a8bd30 C |
295 | torrents: |
296 | size: 500 # Max number of video torrents you want to cache | |
4793c343 C |
297 | |
298 | admin: | |
a4101923 C |
299 | # Used to generate the root user at first startup |
300 | # And to receive emails from the contact form | |
301 | email: 'admin@example.com' | |
302 | ||
303 | contact_form: | |
304 | enabled: true | |
e22528ac C |
305 | |
306 | signup: | |
307 | enabled: false | |
291e8d3e | 308 | limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited |
1f256e7d | 309 | minimum_age: 16 # Used to configure the signup form |
d9eaee39 | 310 | requires_email_verification: false |
6401417d | 311 | filters: |
ff2c1fe8 RK |
312 | cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist |
313 | whitelist: [] | |
314 | blacklist: [] | |
227d02fe | 315 | |
b0f9f39e | 316 | user: |
de7f1114 C |
317 | # Default value of maximum video bytes the user can upload (does not take into account transcoded files) |
318 | # Byte format is supported ("1GB" etc) | |
b0f9f39e C |
319 | # -1 == unlimited |
320 | video_quota: -1 | |
bee0abff | 321 | video_quota_daily: -1 |
b0f9f39e | 322 | |
754b6f5f FC |
323 | video_channels: |
324 | max_per_user: 20 # Allows each user to create up to 20 video channels. | |
325 | ||
97b6428a | 326 | # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag |
de7f1114 | 327 | # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions |
09f35e2a | 328 | # Please, do not disable transcoding since many uploaded videos will not work |
227d02fe | 329 | transcoding: |
1125c40a | 330 | enabled: true |
1896bca0 | 331 | |
fccbbc1a | 332 | # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos |
14e2014a | 333 | allow_additional_extensions: true |
1896bca0 | 334 | |
536598cf C |
335 | # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file |
336 | allow_audio_files: true | |
1896bca0 | 337 | |
9129b769 | 338 | # Amount of threads used by ffmpeg for 1 transcoding job |
98f535a5 | 339 | threads: 1 |
9129b769 C |
340 | # Amount of transcoding jobs to execute in parallel |
341 | concurrency: 1 | |
1896bca0 C |
342 | |
343 | # Choose the transcoding profile | |
344 | # New profiles can be added by plugins | |
345 | # Available in core PeerTube: 'default' | |
346 | profile: 'default' | |
347 | ||
09f35e2a | 348 | resolutions: # Only created if the original video has a higher resolution, uses more storage! |
6ad88df8 | 349 | 0p: false # audio-only (creates mp4 without video stream, always created when enabled) |
8dd754c7 | 350 | 144p: false |
1125c40a C |
351 | 240p: false |
352 | 360p: false | |
353 | 480p: false | |
354 | 720p: false | |
355 | 1080p: false | |
b7085c71 | 356 | 1440p: false |
ad3405d0 | 357 | 2160p: false |
d7a25329 C |
358 | |
359 | # Generate videos in a WebTorrent format (what we do since the first PeerTube release) | |
360 | # If you also enabled the hls format, it will multiply videos storage by 2 | |
04cda1d7 | 361 | # If disabled, breaks federation with PeerTube instances < 2.1 |
d7a25329 | 362 | webtorrent: |
6a882428 | 363 | enabled: false |
d7a25329 | 364 | |
5d9e4eaa | 365 | # /!\ Requires ffmpeg >= 4.1 |
7f8f8bdb | 366 | # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent: |
09209296 C |
367 | # * Resolution change is smoother |
368 | # * Faster playback in particular with long videos | |
369 | # * More stable playback (less bugs/infinite loading) | |
d7a25329 | 370 | # If you also enabled the webtorrent format, it will multiply videos storage by 2 |
09209296 | 371 | hls: |
6a882428 | 372 | enabled: true |
66b16caf | 373 | |
c6c0fa6c C |
374 | live: |
375 | enabled: false | |
376 | ||
a5cf76af | 377 | # Limit lives duration |
c9bc850e C |
378 | # -1 == unlimited |
379 | max_duration: -1 # For example: '5 hours' | |
a5cf76af | 380 | |
a056ca48 C |
381 | # Limit max number of live videos created on your instance |
382 | # -1 == unlimited | |
383 | max_instance_lives: 20 | |
384 | ||
385 | # Limit max number of live videos created by a user on your instance | |
386 | # -1 == unlimited | |
387 | max_user_lives: 3 | |
388 | ||
a5cf76af C |
389 | # Allow your users to save a replay of their live |
390 | # PeerTube will transcode segments in a video file | |
391 | # If the user daily/total quota is reached, PeerTube will stop the live | |
392 | # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay | |
3258fa55 | 393 | allow_replay: true |
a5cf76af | 394 | |
4f20856e | 395 | # Your firewall should accept traffic from this port in TCP if you enable live |
c6c0fa6c | 396 | rtmp: |
df1db951 | 397 | enabled: true |
c6c0fa6c C |
398 | port: 1935 |
399 | ||
df1db951 C |
400 | rtmps: |
401 | enabled: false | |
402 | port: 1936 | |
403 | # Absolute path | |
404 | key_file: '' | |
405 | # Absolute path | |
406 | cert_file: '' | |
407 | ||
a5cf76af | 408 | # Allow to transcode the live streaming in multiple live resolutions |
c6c0fa6c | 409 | transcoding: |
cf3e0d69 | 410 | enabled: true |
c6c0fa6c C |
411 | threads: 2 |
412 | ||
1896bca0 C |
413 | # Choose the transcoding profile |
414 | # New profiles can be added by plugins | |
415 | # Available in core PeerTube: 'default' | |
416 | profile: 'default' | |
417 | ||
c6c0fa6c | 418 | resolutions: |
8dd754c7 | 419 | 144p: false |
c6c0fa6c C |
420 | 240p: false |
421 | 360p: false | |
422 | 480p: false | |
423 | 720p: false | |
424 | 1080p: false | |
b7085c71 | 425 | 1440p: false |
c6c0fa6c C |
426 | 2160p: false |
427 | ||
fbad87b0 C |
428 | import: |
429 | # Add ability for your users to import remote videos (from YouTube, torrent...) | |
430 | videos: | |
9129b769 C |
431 | # Amount of import jobs to execute in parallel |
432 | concurrency: 1 | |
433 | ||
474542d7 C |
434 | # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html |
435 | http: | |
436 | # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server | |
437 | # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information | |
5d08a6a7 | 438 | enabled: false |
e0409585 | 439 | |
62549e6c C |
440 | youtube_dl_release: |
441 | # Direct download URL to youtube-dl binary | |
442 | # Github releases API is also supported | |
443 | # Examples: | |
444 | # * https://api.github.com/repos/ytdl-org/youtube-dl/releases | |
445 | # * https://api.github.com/repos/yt-dlp/yt-dlp/releases | |
446 | url: 'https://yt-dl.org/downloads/latest/youtube-dl' | |
447 | ||
448 | # youtube-dl binary name | |
449 | # yt-dlp is also supported | |
450 | name: 'youtube-dl' | |
451 | ||
22c77786 F |
452 | # Path to the python binary to execute for youtube-dl or yt-dlp |
453 | python_path: '/usr/bin/python3' | |
454 | ||
677012b4 | 455 | # IPv6 is very strongly rate-limited on most sites supported by youtube-dl |
e0409585 C |
456 | force_ipv4: false |
457 | ||
474542d7 C |
458 | # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file) |
459 | torrent: | |
460 | # We recommend to only enable magnet URI/torrent import if you trust your users | |
461 | # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information | |
a84b8fa5 | 462 | enabled: false |
fbad87b0 | 463 | |
7ccddd7b JM |
464 | auto_blacklist: |
465 | # New videos automatically blacklisted so moderators can review before publishing | |
466 | videos: | |
467 | of_users: | |
468 | enabled: false | |
469 | ||
3258fa55 | 470 | # Instance settings |
66b16caf C |
471 | instance: |
472 | name: 'PeerTube' | |
482fa503 | 473 | short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.' |
bf874e33 C |
474 | description: 'Welcome to this PeerTube instance!' # Support markdown |
475 | terms: 'No terms for now.' # Support markdown | |
ccc00cb2 C |
476 | code_of_conduct: '' # Supports markdown |
477 | ||
478 | # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc | |
479 | moderation_information: '' # Supports markdown | |
480 | ||
8ae03c37 | 481 | # Why did you create this instance? |
d605328a | 482 | creation_reason: '' # Supports Markdown |
8ae03c37 | 483 | |
ccc00cb2 | 484 | # Who is behind the instance? A single person? A non profit? |
d605328a | 485 | administrator: '' # Supports Markdown |
ccc00cb2 C |
486 | |
487 | # How long do you plan to maintain this instance? | |
d605328a | 488 | maintenance_lifetime: '' # Supports Markdown |
ccc00cb2 | 489 | |
96a4a7c3 | 490 | # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising? |
d605328a | 491 | business_model: '' # Supports Markdown |
ccc00cb2 | 492 | |
be04c6fd | 493 | # If you want to explain on what type of hardware your PeerTube instance runs |
97b6428a | 494 | # Example: '2 vCore, 2GB RAM...' |
be04c6fd C |
495 | hardware_information: '' # Supports Markdown |
496 | ||
ccc00cb2 C |
497 | # What are the main languages of your instance? To interact with your users for example |
498 | # Uncomment or add the languages you want | |
499 | # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages | |
500 | languages: | |
501 | # - en | |
502 | # - es | |
503 | # - fr | |
504 | ||
505 | # You can specify the main categories of your instance (dedicated to music, gaming or politics etc) | |
506 | # Uncomment or add the category ids you want | |
507 | # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories | |
508 | categories: | |
509 | # - 1 # Music | |
510 | # - 2 # Films | |
511 | # - 3 # Vehicles | |
512 | # - 4 # Art | |
513 | # - 5 # Sports | |
514 | # - 6 # Travels | |
515 | # - 7 # Gaming | |
516 | # - 8 # People | |
517 | # - 9 # Comedy | |
518 | # - 10 # Entertainment | |
519 | # - 11 # News & Politics | |
520 | # - 12 # How To | |
521 | # - 13 # Education | |
522 | # - 14 # Activism | |
523 | # - 15 # Science & Technology | |
524 | # - 16 # Animals | |
525 | # - 17 # Kids | |
526 | # - 18 # Food | |
527 | ||
901637bb | 528 | default_client_route: '/videos/trending' |
ccc00cb2 | 529 | |
f8802489 C |
530 | # Whether or not the instance is dedicated to NSFW content |
531 | # Enabling it will allow other administrators to know that you are mainly federating sensitive content | |
532 | # Moreover, the NSFW checkbox on video upload will be automatically checked by default | |
533 | is_nsfw: false | |
97b6428a | 534 | # By default, `do_not_list` or `blur` or `display` NSFW videos |
0883b324 C |
535 | # Could be overridden per user with a setting |
536 | default_nsfw_policy: 'do_not_list' | |
ccc00cb2 | 537 | |
00b5556c C |
538 | customizations: |
539 | javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime | |
540 | css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime | |
97b6428a | 541 | # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:` |
ac235c37 RK |
542 | robots: | |
543 | User-agent: * | |
df182b37 | 544 | Disallow: |
de7f1114 | 545 | # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string |
5447516b | 546 | securitytxt: |
97b6428a | 547 | '# 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 |
548 | |
549 | services: | |
550 | # Cards configuration to format video in Twitter | |
551 | twitter: | |
351d5225 | 552 | username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published |
8be1afa1 C |
553 | # If true, a video player will be embedded in the Twitter feed on PeerTube video share |
554 | # If false, we use an image link card that will redirect on your PeerTube instance | |
97b6428a | 555 | # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted |
8be1afa1 | 556 | whitelisted: false |
5b9c965d C |
557 | |
558 | followers: | |
559 | instance: | |
560 | # Allow or not other instances to follow yours | |
561 | enabled: true | |
14893eb7 C |
562 | # Whether or not an administrator must manually validate a new follower |
563 | manual_approval: false | |
7cd4d2ba | 564 | |
8424c402 C |
565 | followings: |
566 | instance: | |
567 | # If you want to automatically follow back new instance followers | |
8424c402 C |
568 | # If this option is enabled, use the mute feature instead of deleting followings |
569 | # /!\ Don't enable this if you don't have a reactive moderation team /!\ | |
570 | auto_follow_back: | |
571 | enabled: false | |
572 | ||
573 | # If you want to automatically follow instances of the public index | |
574 | # If this option is enabled, use the mute feature instead of deleting followings | |
575 | # /!\ Don't enable this if you don't have a reactive moderation team /!\ | |
576 | auto_follow_index: | |
577 | enabled: false | |
95cd31f1 C |
578 | # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow |
579 | index_url: '' | |
8424c402 | 580 | |
7cd4d2ba C |
581 | theme: |
582 | default: 'default' | |
72c33e71 C |
583 | |
584 | broadcast_message: | |
585 | enabled: false | |
586 | message: '' # Support markdown | |
31a91119 | 587 | level: 'info' # 'info' | 'warning' | 'error' |
72c33e71 | 588 | dismissable: false |
5fb2e288 C |
589 | |
590 | search: | |
591 | # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance | |
592 | # If enabled, the associated group will be able to "escape" from the instance follows | |
593 | # That means they will be able to follow channels, watch videos, list videos of non followed instances | |
594 | remote_uri: | |
595 | users: true | |
596 | anonymous: false | |
597 | ||
598 | # Use a third party index instead of your local index, only for search results | |
599 | # Useful to discover content outside of your instance | |
600 | # If you enable search_index, you must enable remote_uri search for users | |
601 | # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance | |
602 | # instead of loading the video locally | |
603 | search_index: | |
604 | enabled: false | |
605 | # URL of the search index, that should use the same search API and routes | |
606 | # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html | |
607 | # You should deploy your own with https://framagit.org/framasoft/peertube/search-index, | |
608 | # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index | |
609 | url: '' | |
610 | # You can disable local search, so users only use the search index | |
611 | disable_local_search: false | |
612 | # If you did not disable local search, you can decide to use the search index by default | |
613 | is_default_search: false | |
3cf68b86 C |
614 | |
615 | # PeerTube client/interface configuration | |
616 | client: | |
617 | videos: | |
618 | miniature: | |
619 | # By default PeerTube client displays author username | |
620 | prefer_author_display_name: false | |
621 | ||
622 | menu: | |
623 | login: | |
624 | # If you enable only one external auth plugin | |
625 | # You can automatically redirect your users on this external platform when they click on the login button | |
626 | redirect_on_single_external_auth: false |