Merge branch 'release/beta-10' into develop
[oweals/peertube.git] / config / default.yaml
1 # /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #
2
3 listen:
4   hostname: '127.0.0.1'
5   port: 9000
6
7 webserver:
8   https: false
9   hostname: 'localhost'
10   port: 9000
11
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)
15 trust_proxy:
16   - 'loopback'
17
18 # Your database name will be "peertube"+database.suffix
19 database:
20   hostname: 'localhost'
21   port: 5432
22   suffix: '_dev'
23   username: 'peertube'
24   password: 'peertube'
25   pool:
26     max: 5
27
28 # You can also specify a 'socket' path to a unix socket but first need to
29 # comment out hostname and port
30 redis:
31   hostname: 'localhost'
32   port: 6379
33   auth: null
34   db: 0
35
36 smtp:
37   hostname: null
38   port: 465
39   username: null
40   password: null
41   tls: true
42   disable_starttls: false
43   ca_file: null # Used for self signed certificates
44   from_address: 'admin@example.com'
45
46 # From the project root directory
47 storage:
48   avatars: 'storage/avatars/'
49   videos: 'storage/videos/'
50   logs: 'storage/logs/'
51   previews: 'storage/previews/'
52   thumbnails: 'storage/thumbnails/'
53   torrents: 'storage/torrents/'
54   captions: 'storage/captions/'
55   cache: 'storage/cache/'
56
57 log:
58   level: 'info' # debug/info/warning/error
59
60 cache:
61   previews:
62     size: 500 # Max number of previews you want to cache
63   captions:
64     size: 500 # Max number of video captions/subtitles you want to cache
65
66 admin:
67   email: 'admin@example.com' # Your personal email as administrator
68
69 signup:
70   enabled: false
71   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
72   filters:
73     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
74       whitelist: []
75       blacklist: []
76
77 user:
78   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
79   # -1 == unlimited
80   video_quota: -1
81
82 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
83 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
84 # Please, do not disable transcoding since many uploaded videos will not work
85 transcoding:
86   enabled: true
87   threads: 1
88   resolutions: # Only created if the original video has a higher resolution, uses more storage!
89     240p: false
90     360p: false
91     480p: false
92     720p: false
93     1080p: false
94
95 import:
96   # Add ability for your users to import remote videos (from YouTube, torrent...)
97   videos:
98     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
99       enabled: false
100
101 instance:
102   name: 'PeerTube'
103   short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
104   description: 'Welcome to this PeerTube instance!' # Support markdown
105   terms: 'No terms for now.' # Support markdown
106   default_client_route: '/videos/trending'
107   # By default, "do_not_list" or "blur" or "display" NSFW videos
108   # Could be overridden per user with a setting
109   default_nsfw_policy: 'do_not_list'
110   customizations:
111     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
112     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
113   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
114   robots: |
115     User-agent: *
116     Disallow: ''
117
118 services:
119   # Cards configuration to format video in Twitter
120   twitter:
121     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
122     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
123     # If false, we use an image link card that will redirect on your PeerTube instance
124     # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
125     whitelisted: false