Add help in conf file regarding SMTP
[oweals/peertube.git] / config / production.yaml.example
1 listen:
2   hostname: 'localhost'
3   port: 9000
4
5 # Correspond to your reverse proxy "listen" configuration
6 webserver:
7   https: true
8   hostname: 'example.com'
9   port: 443
10
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)
14 trust_proxy:
15   - 'loopback'
16
17 # Your database name will be "peertube"+database.suffix
18 database:
19   hostname: 'localhost'
20   port: 5432
21   suffix: '_prod'
22   username: 'peertube'
23   password: 'peertube'
24
25 # Redis server for short time storage
26 redis:
27   hostname: 'localhost'
28   port: 6379
29   auth: null
30   db: 0
31
32 # SMTP server to send emails
33 smtp:
34   hostname: null
35   port: 465 # If you use StartTLS: 587
36   username: null
37   password: null
38   tls: true # If you use StartTLS: false
39   disable_starttls: false
40   ca_file: null # Used for self signed certificates
41   from_address: 'admin@example.com'
42
43 # From the project root directory
44 storage:
45   avatars: '/var/www/peertube/storage/avatars/'
46   videos: '/var/www/peertube/storage/videos/'
47   logs: '/var/www/peertube/storage/logs/'
48   previews: '/var/www/peertube/storage/previews/'
49   thumbnails: '/var/www/peertube/storage/thumbnails/'
50   torrents: '/var/www/peertube/storage/torrents/'
51   cache: '/var/www/peertube/storage/cache/'
52
53 log:
54   level: 'info' # debug/info/warning/error
55
56
57 ###############################################################################
58 #
59 # From this point, all the following keys can be overridden by the web interface
60 # (local-production.json file). If you need to change some values, prefer to
61 # use the web interface because the configuration will be automatically
62 # reloaded without any need to restart PeerTube.
63 #
64 # /!\ If you already have a local-production.json file, the modification of the
65 # following keys will have no effect /!\.
66 #
67 ###############################################################################
68
69 cache:
70   previews:
71     size: 100 # Max number of previews you want to cache
72
73 admin:
74   email: 'admin@example.com'
75
76 signup:
77   enabled: false
78   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
79   filters:
80     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
81       whitelist: []
82       blacklist: []
83
84 user:
85   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
86   # -1 == unlimited
87   video_quota: -1
88
89 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
90 # Uses a lot of CPU!
91 transcoding:
92   enabled: true
93   threads: 1
94   resolutions: # Only created if the original video has a higher resolution
95     240p: false
96     360p: false
97     480p: false
98     720p: false
99     1080p: false
100
101 # Instance settings
102 instance:
103   name: 'PeerTube'
104   short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
105   description: '' # Support markdown
106   terms: '' # Support markdown
107   default_client_route: '/videos/trending'
108   # By default, "do_not_list" or "blur" or "display" NSFW videos
109   # Could be overridden per user with a setting
110   default_nsfw_policy: 'do_not_list'
111   customizations:
112     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
113     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
114   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
115   robots: |
116     User-agent: *
117     Disallow: ''
118
119 services:
120   # Cards configuration to format video in Twitter
121   twitter:
122     username: '@Chocobozzz' # The Twitter @username the card should be attributed to
123     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
124     # If false, we use an image link card that will redirect on your PeerTube instance
125     # Test on https://cards-dev.twitter.com/validator to see if you are whitelisted
126     whitelisted: false