]>
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 | ||
7 | webserver: | |
8 | https: false | |
3737bbaf | 9 | hostname: 'localhost' |
8c308c2b C |
10 | port: 9000 |
11 | ||
c342726a YB |
12 | rates_limit: |
13 | login: | |
14 | # 15 attempts in 5 min | |
15 | window: 5 minutes | |
16 | max: 15 | |
17 | ask_send_email: | |
18 | # 3 attempts in 5 min | |
19 | window: 5 minutes | |
20 | max: 3 | |
21 | ||
490b595a C |
22 | # Proxies to trust to get real client IP |
23 | # If you run PeerTube just behind a local proxy (nginx), keep 'loopback' | |
24 | # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet) | |
25 | trust_proxy: | |
26 | - 'loopback' | |
27 | ||
98dffd10 | 28 | # Your database name will be "peertube"+database.suffix |
8c308c2b | 29 | database: |
3737bbaf | 30 | hostname: 'localhost' |
feb4bdfd C |
31 | port: 5432 |
32 | suffix: '_dev' | |
55fa55a9 C |
33 | username: 'peertube' |
34 | password: 'peertube' | |
1c3386e8 RK |
35 | pool: |
36 | max: 5 | |
8c308c2b | 37 | |
19f7b248 RK |
38 | # You can also specify a 'socket' path to a unix socket but first need to |
39 | # comment out hostname and port | |
94a5ff8a C |
40 | redis: |
41 | hostname: 'localhost' | |
42 | port: 6379 | |
43 | auth: null | |
30c82f0d | 44 | db: 0 |
94a5ff8a | 45 | |
ecb4e35f C |
46 | smtp: |
47 | hostname: null | |
48 | port: 465 | |
49 | username: null | |
50 | password: null | |
51 | tls: true | |
bebf2d89 | 52 | disable_starttls: false |
ecb4e35f C |
53 | ca_file: null # Used for self signed certificates |
54 | from_address: 'admin@example.com' | |
55 | ||
8c308c2b C |
56 | # From the project root directory |
57 | storage: | |
6040f87d | 58 | tmp: 'storage/tmp/' # Used to download data (imports etc), store uploaded files before processing... |
6b2ef589 | 59 | avatars: 'storage/avatars/' |
6b2ef589 | 60 | videos: 'storage/videos/' |
9c6ca37f | 61 | streaming_playlists: 'storage/streaming-playlists/' |
6040f87d | 62 | redundancy: 'storage/redundancy/' |
6b2ef589 C |
63 | logs: 'storage/logs/' |
64 | previews: 'storage/previews/' | |
65 | thumbnails: 'storage/thumbnails/' | |
66 | torrents: 'storage/torrents/' | |
40e87e9e | 67 | captions: 'storage/captions/' |
6b2ef589 | 68 | cache: 'storage/cache/' |
f981dae8 | 69 | |
23e27dd5 | 70 | log: |
a0922eb9 | 71 | level: 'info' # debug/info/warning/error |
23e27dd5 | 72 | |
1297eb5d | 73 | search: |
8d427346 C |
74 | # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance |
75 | # If enabled, the associated group will be able to "escape" from the instance follows | |
76 | # That means they will be able to follow channels, watch videos, list videos of non followed instances | |
77 | remote_uri: | |
1297eb5d C |
78 | users: true |
79 | anonymous: false | |
80 | ||
9a629c6e C |
81 | trending: |
82 | videos: | |
83 | interval_days: 7 # Compute trending videos for the last x days | |
84 | ||
c48e82b5 C |
85 | # Cache remote videos on your server, to help other instances to broadcast the video |
86 | # You can define multiple caches using different sizes/strategies | |
87 | # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following | |
88 | redundancy: | |
89 | videos: | |
f9f899b9 | 90 | check_interval: '1 hour' # How often you want to check new videos to cache |
6040f87d | 91 | strategies: # Just uncomment strategies you want |
d9bdd007 C |
92 | # - |
93 | # size: '10GB' | |
e5565833 C |
94 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
95 | # min_lifetime: '48 hours' | |
d9bdd007 C |
96 | # strategy: 'most-views' # Cache videos that have the most views |
97 | # - | |
98 | # size: '10GB' | |
e5565833 C |
99 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
100 | # min_lifetime: '48 hours' | |
d9bdd007 C |
101 | # strategy: 'trending' # Cache trending videos |
102 | # - | |
103 | # size: '10GB' | |
e5565833 C |
104 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
105 | # min_lifetime: '48 hours' | |
d9bdd007 | 106 | # strategy: 'recently-added' # Cache recently added videos |
e5565833 | 107 | # min_views: 10 # Having at least x views |
c48e82b5 | 108 | |
539d3f4f C |
109 | csp: |
110 | enabled: false | |
111 | report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk! | |
112 | report_uri: | |
113 | ||
31b6ddf8 C |
114 | tracker: |
115 | # If you disable the tracker, you disable the P2P aspect of PeerTube | |
116 | enabled: true | |
117 | # Only handle requests on your videos. | |
118 | # If you set this to false it means you have a public tracker. | |
119 | # Then, it is possible that clients overload your instance with external torrents | |
120 | private: true | |
121 | # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers) | |
122 | reject_too_many_announces: false | |
123 | ||
8f0bc73d C |
124 | history: |
125 | videos: | |
126 | # If you want to limit users videos history | |
127 | # -1 means there is no limitations | |
128 | # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database) | |
129 | max_age: -1 | |
130 | ||
cda03765 C |
131 | views: |
132 | videos: | |
133 | # PeerTube creates a database entry every hour for each video to track views over a period of time | |
134 | # This is used in particular by the Trending page | |
135 | # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered) | |
136 | # -1 means no cleanup | |
137 | # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database) | |
138 | remote: | |
139 | max_age: -1 | |
140 | ||
f981dae8 C |
141 | cache: |
142 | previews: | |
f842e810 | 143 | size: 500 # Max number of previews you want to cache |
40e87e9e | 144 | captions: |
f842e810 | 145 | size: 500 # Max number of video captions/subtitles you want to cache |
4793c343 C |
146 | |
147 | admin: | |
a4101923 C |
148 | # Used to generate the root user at first startup |
149 | # And to receive emails from the contact form | |
150 | email: 'admin@example.com' | |
151 | ||
152 | contact_form: | |
153 | enabled: true | |
e22528ac C |
154 | |
155 | signup: | |
156 | enabled: false | |
291e8d3e | 157 | limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited |
d9eaee39 | 158 | requires_email_verification: false |
6401417d | 159 | filters: |
ff2c1fe8 RK |
160 | cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist |
161 | whitelist: [] | |
162 | blacklist: [] | |
227d02fe | 163 | |
b0f9f39e C |
164 | user: |
165 | # Default value of maximum video BYTES the user can upload (does not take into account transcoded files). | |
166 | # -1 == unlimited | |
167 | video_quota: -1 | |
bee0abff | 168 | video_quota_daily: -1 |
b0f9f39e | 169 | |
227d02fe | 170 | # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag |
40298b02 | 171 | # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions. |
09f35e2a | 172 | # Please, do not disable transcoding since many uploaded videos will not work |
227d02fe | 173 | transcoding: |
1125c40a | 174 | enabled: true |
14e2014a C |
175 | # Allow your users to upload .mkv, .mov, .avi, .flv videos |
176 | allow_additional_extensions: true | |
98f535a5 | 177 | threads: 1 |
09f35e2a | 178 | resolutions: # Only created if the original video has a higher resolution, uses more storage! |
1125c40a C |
179 | 240p: false |
180 | 360p: false | |
181 | 480p: false | |
182 | 720p: false | |
183 | 1080p: false | |
09209296 | 184 | # /!\ EXPERIMENTAL /!\ |
7f8f8bdb C |
185 | # /!\ Requires ffmpeg >= 4 |
186 | # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent: | |
09209296 C |
187 | # * Resolution change is smoother |
188 | # * Faster playback in particular with long videos | |
189 | # * More stable playback (less bugs/infinite loading) | |
7f8f8bdb | 190 | # /!\ Multiply videos storage by 2 /!\ |
09209296 C |
191 | hls: |
192 | enabled: false | |
66b16caf | 193 | |
fbad87b0 C |
194 | import: |
195 | # Add ability for your users to import remote videos (from YouTube, torrent...) | |
196 | videos: | |
197 | http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html | |
5d08a6a7 | 198 | enabled: false |
a84b8fa5 C |
199 | torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file) |
200 | enabled: false | |
fbad87b0 | 201 | |
7ccddd7b JM |
202 | auto_blacklist: |
203 | # New videos automatically blacklisted so moderators can review before publishing | |
204 | videos: | |
205 | of_users: | |
206 | enabled: false | |
207 | ||
66b16caf C |
208 | instance: |
209 | name: 'PeerTube' | |
2e3a0215 | 210 | short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.' |
bf874e33 C |
211 | description: 'Welcome to this PeerTube instance!' # Support markdown |
212 | terms: 'No terms for now.' # Support markdown | |
901637bb | 213 | default_client_route: '/videos/trending' |
f8802489 C |
214 | # Whether or not the instance is dedicated to NSFW content |
215 | # Enabling it will allow other administrators to know that you are mainly federating sensitive content | |
216 | # Moreover, the NSFW checkbox on video upload will be automatically checked by default | |
217 | is_nsfw: false | |
0883b324 C |
218 | # By default, "do_not_list" or "blur" or "display" NSFW videos |
219 | # Could be overridden per user with a setting | |
220 | default_nsfw_policy: 'do_not_list' | |
00b5556c C |
221 | customizations: |
222 | javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime | |
223 | css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime | |
78881bc4 | 224 | # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:' |
ac235c37 RK |
225 | robots: | |
226 | User-agent: * | |
df182b37 | 227 | Disallow: |
5447516b AH |
228 | # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string. |
229 | securitytxt: | |
1f4f1510 | 230 | "# 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 |
231 | |
232 | services: | |
233 | # Cards configuration to format video in Twitter | |
234 | twitter: | |
351d5225 | 235 | username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published |
8be1afa1 C |
236 | # If true, a video player will be embedded in the Twitter feed on PeerTube video share |
237 | # If false, we use an image link card that will redirect on your PeerTube instance | |
238 | # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted | |
239 | whitelisted: false | |
5b9c965d C |
240 | |
241 | followers: | |
242 | instance: | |
243 | # Allow or not other instances to follow yours | |
244 | enabled: true | |
14893eb7 C |
245 | # Whether or not an administrator must manually validate a new follower |
246 | manual_approval: false |