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