]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - config/default.yaml
Add auto follow back support for instances
[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
23e27dd5 89
1297eb5d 90search:
8d427346
C
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:
1297eb5d
C
95 users: true
96 anonymous: false
97
9a629c6e
C
98trending:
99 videos:
100 interval_days: 7 # Compute trending videos for the last x days
101
c48e82b5
C
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
105redundancy:
106 videos:
f9f899b9 107 check_interval: '1 hour' # How often you want to check new videos to cache
6040f87d 108 strategies: # Just uncomment strategies you want
d9bdd007
C
109# -
110# size: '10GB'
e5565833
C
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'
d9bdd007
C
113# strategy: 'most-views' # Cache videos that have the most views
114# -
115# size: '10GB'
e5565833
C
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'
d9bdd007
C
118# strategy: 'trending' # Cache trending videos
119# -
120# size: '10GB'
e5565833
C
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'
d9bdd007 123# strategy: 'recently-added' # Cache recently added videos
e5565833 124# min_views: 10 # Having at least x views
c48e82b5 125
539d3f4f
C
126csp:
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
31b6ddf8
C
131tracker:
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
8f0bc73d
C
141history:
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
cda03765
C
148views:
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
6702a1b2 158plugins:
d133f385
C
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
6702a1b2
C
161 index:
162 enabled: true
df9a1a13 163 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
6702a1b2
C
164 url: 'https://packages.joinpeertube.org'
165
f981dae8
C
166cache:
167 previews:
f842e810 168 size: 500 # Max number of previews you want to cache
40e87e9e 169 captions:
f842e810 170 size: 500 # Max number of video captions/subtitles you want to cache
4793c343
C
171
172admin:
a4101923
C
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
177contact_form:
178 enabled: true
e22528ac
C
179
180signup:
181 enabled: false
291e8d3e 182 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
d9eaee39 183 requires_email_verification: false
6401417d 184 filters:
ff2c1fe8
RK
185 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
186 whitelist: []
187 blacklist: []
227d02fe 188
b0f9f39e
C
189user:
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
bee0abff 193 video_quota_daily: -1
b0f9f39e 194
227d02fe 195# If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
40298b02 196# In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
09f35e2a 197# Please, do not disable transcoding since many uploaded videos will not work
227d02fe 198transcoding:
1125c40a 199 enabled: true
14e2014a
C
200 # Allow your users to upload .mkv, .mov, .avi, .flv videos
201 allow_additional_extensions: true
536598cf
C
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
98f535a5 204 threads: 1
09f35e2a 205 resolutions: # Only created if the original video has a higher resolution, uses more storage!
1125c40a
C
206 240p: false
207 360p: false
208 480p: false
209 720p: false
210 1080p: false
ad3405d0 211 2160p: false
09209296 212 # /!\ EXPERIMENTAL /!\
7f8f8bdb
C
213 # /!\ Requires ffmpeg >= 4
214 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
09209296
C
215 # * Resolution change is smoother
216 # * Faster playback in particular with long videos
217 # * More stable playback (less bugs/infinite loading)
2ed67a7d 218 # /!\ Multiplies videos storage by 2 /!\
09209296
C
219 hls:
220 enabled: false
66b16caf 221
fbad87b0
C
222import:
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
5d08a6a7 226 enabled: false
a84b8fa5
C
227 torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
228 enabled: false
fbad87b0 229
7ccddd7b
JM
230auto_blacklist:
231 # New videos automatically blacklisted so moderators can review before publishing
232 videos:
233 of_users:
234 enabled: false
235
66b16caf
C
236instance:
237 name: 'PeerTube'
2e3a0215 238 short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
bf874e33
C
239 description: 'Welcome to this PeerTube instance!' # Support markdown
240 terms: 'No terms for now.' # Support markdown
901637bb 241 default_client_route: '/videos/trending'
f8802489
C
242 # Whether or not the instance is dedicated to NSFW content
243 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
244 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
245 is_nsfw: false
0883b324
C
246 # By default, "do_not_list" or "blur" or "display" NSFW videos
247 # Could be overridden per user with a setting
248 default_nsfw_policy: 'do_not_list'
00b5556c
C
249 customizations:
250 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
251 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
78881bc4 252 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
ac235c37
RK
253 robots: |
254 User-agent: *
df182b37 255 Disallow:
5447516b
AH
256 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
257 securitytxt:
1f4f1510 258 "# 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
259
260services:
261 # Cards configuration to format video in Twitter
262 twitter:
351d5225 263 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
8be1afa1
C
264 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
265 # If false, we use an image link card that will redirect on your PeerTube instance
266 # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
267 whitelisted: false
5b9c965d
C
268
269followers:
270 instance:
271 # Allow or not other instances to follow yours
272 enabled: true
14893eb7
C
273 # Whether or not an administrator must manually validate a new follower
274 manual_approval: false
7cd4d2ba 275
8424c402
C
276followings:
277 instance:
278 # If you want to automatically follow back new instance followers
279 # Only follows accepted followers (in case you enabled manual followers approbation)
280 # If this option is enabled, use the mute feature instead of deleting followings
281 # /!\ Don't enable this if you don't have a reactive moderation team /!\
282 auto_follow_back:
283 enabled: false
284
285 # If you want to automatically follow instances of the public index
286 # If this option is enabled, use the mute feature instead of deleting followings
287 # /!\ Don't enable this if you don't have a reactive moderation team /!\
288 auto_follow_index:
289 enabled: false
290 index_url: 'https://instances.joinpeertube.org'
291
7cd4d2ba
C
292theme:
293 default: 'default'