]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - config/default.yaml
add noImplicitThis flag (#1324)
[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
490b595a
C
12# Proxies to trust to get real client IP
13# If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
14# If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
15trust_proxy:
16 - 'loopback'
17
98dffd10 18# Your database name will be "peertube"+database.suffix
8c308c2b 19database:
3737bbaf 20 hostname: 'localhost'
feb4bdfd
C
21 port: 5432
22 suffix: '_dev'
55fa55a9
C
23 username: 'peertube'
24 password: 'peertube'
1c3386e8
RK
25 pool:
26 max: 5
8c308c2b 27
19f7b248
RK
28# You can also specify a 'socket' path to a unix socket but first need to
29# comment out hostname and port
94a5ff8a
C
30redis:
31 hostname: 'localhost'
32 port: 6379
33 auth: null
30c82f0d 34 db: 0
94a5ff8a 35
ecb4e35f
C
36smtp:
37 hostname: null
38 port: 465
39 username: null
40 password: null
41 tls: true
bebf2d89 42 disable_starttls: false
ecb4e35f
C
43 ca_file: null # Used for self signed certificates
44 from_address: 'admin@example.com'
45
8c308c2b
C
46# From the project root directory
47storage:
6b2ef589 48 avatars: 'storage/avatars/'
6b2ef589
C
49 videos: 'storage/videos/'
50 logs: 'storage/logs/'
51 previews: 'storage/previews/'
52 thumbnails: 'storage/thumbnails/'
53 torrents: 'storage/torrents/'
40e87e9e 54 captions: 'storage/captions/'
6b2ef589 55 cache: 'storage/cache/'
f981dae8 56
23e27dd5 57log:
a0922eb9 58 level: 'info' # debug/info/warning/error
23e27dd5 59
1297eb5d
C
60search:
61 remote_uri: # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
62 users: true
63 anonymous: false
64
9a629c6e
C
65trending:
66 videos:
67 interval_days: 7 # Compute trending videos for the last x days
68
c48e82b5
C
69# Cache remote videos on your server, to help other instances to broadcast the video
70# You can define multiple caches using different sizes/strategies
71# Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
72redundancy:
73 videos:
f9f899b9 74 check_interval: '1 hour' # How often you want to check new videos to cache
d9bdd007
C
75 strategies:
76# -
77# size: '10GB'
e5565833
C
78# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
79# min_lifetime: '48 hours'
d9bdd007
C
80# strategy: 'most-views' # Cache videos that have the most views
81# -
82# size: '10GB'
e5565833
C
83# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
84# min_lifetime: '48 hours'
d9bdd007
C
85# strategy: 'trending' # Cache trending videos
86# -
87# size: '10GB'
e5565833
C
88# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
89# min_lifetime: '48 hours'
d9bdd007 90# strategy: 'recently-added' # Cache recently added videos
e5565833 91# min_views: 10 # Having at least x views
c48e82b5 92
f981dae8
C
93cache:
94 previews:
f842e810 95 size: 500 # Max number of previews you want to cache
40e87e9e 96 captions:
f842e810 97 size: 500 # Max number of video captions/subtitles you want to cache
4793c343
C
98
99admin:
ecb4e35f 100 email: 'admin@example.com' # Your personal email as administrator
e22528ac
C
101
102signup:
103 enabled: false
291e8d3e 104 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
d9eaee39 105 requires_email_verification: false
6401417d 106 filters:
ff2c1fe8
RK
107 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
108 whitelist: []
109 blacklist: []
227d02fe 110
b0f9f39e
C
111user:
112 # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
113 # -1 == unlimited
114 video_quota: -1
bee0abff 115 video_quota_daily: -1
b0f9f39e 116
227d02fe 117# If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
40298b02 118# In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
09f35e2a 119# Please, do not disable transcoding since many uploaded videos will not work
227d02fe 120transcoding:
1125c40a 121 enabled: true
98f535a5 122 threads: 1
09f35e2a 123 resolutions: # Only created if the original video has a higher resolution, uses more storage!
1125c40a
C
124 240p: false
125 360p: false
126 480p: false
127 720p: false
128 1080p: false
66b16caf 129
fbad87b0
C
130import:
131 # Add ability for your users to import remote videos (from YouTube, torrent...)
132 videos:
133 http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
5d08a6a7 134 enabled: false
a84b8fa5
C
135 torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
136 enabled: false
fbad87b0 137
66b16caf
C
138instance:
139 name: 'PeerTube'
2e3a0215 140 short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
bf874e33
C
141 description: 'Welcome to this PeerTube instance!' # Support markdown
142 terms: 'No terms for now.' # Support markdown
901637bb 143 default_client_route: '/videos/trending'
0883b324
C
144 # By default, "do_not_list" or "blur" or "display" NSFW videos
145 # Could be overridden per user with a setting
146 default_nsfw_policy: 'do_not_list'
00b5556c
C
147 customizations:
148 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
149 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
78881bc4 150 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
ac235c37
RK
151 robots: |
152 User-agent: *
df182b37 153 Disallow:
5447516b
AH
154 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
155 securitytxt:
1f4f1510 156 "# 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
157
158services:
159 # Cards configuration to format video in Twitter
160 twitter:
351d5225 161 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
8be1afa1
C
162 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
163 # If false, we use an image link card that will redirect on your PeerTube instance
164 # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
165 whitelisted: false