PeerTube/config/production.yaml.example

254 lines
9.6 KiB
Plaintext
Raw Normal View History

listen:
hostname: 'localhost'
port: 9000
2018-08-23 17:58:39 +02:00
# Correspond to your reverse proxy server_name/listen configuration
2016-05-20 15:27:16 +02:00
webserver:
https: true
hostname: 'example.com'
port: 443
2018-03-29 10:58:24 +02:00
# Proxies to trust to get real client IP
# If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
# If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
trust_proxy:
- 'loopback'
# Your database name will be "peertube"+database.suffix
database:
hostname: 'localhost'
port: 5432
2016-12-11 21:50:51 +01:00
suffix: '_prod'
2017-01-12 15:42:40 +01:00
username: 'peertube'
password: 'peertube'
2018-07-28 21:02:26 +02:00
pool:
max: 5
# Redis server for short time storage
2018-05-14 17:51:15 +02:00
# You can also specify a 'socket' path to a unix socket but first need to
# comment out hostname and port
redis:
hostname: 'localhost'
port: 6379
auth: null
db: 0
# SMTP server to send emails
2018-01-30 13:27:07 +01:00
smtp:
hostname: null
2018-05-29 10:28:08 +02:00
port: 465 # If you use StartTLS: 587
2018-01-30 13:27:07 +01:00
username: null
password: null
2018-05-29 10:28:08 +02:00
tls: true # If you use StartTLS: false
2018-03-22 16:12:52 +01:00
disable_starttls: false
2018-01-30 13:27:07 +01:00
ca_file: null # Used for self signed certificates
from_address: 'admin@example.com'
# From the project root directory
storage:
2018-12-04 16:02:49 +01:00
tmp: '/var/www/peertube/storage/tmp/' # Used to download data (imports etc), store uploaded files before processing...
avatars: '/var/www/peertube/storage/avatars/'
videos: '/var/www/peertube/storage/videos/'
2019-03-13 16:03:03 +01:00
streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
2018-12-04 16:02:49 +01:00
redundancy: '/var/www/peertube/storage/videos/'
logs: '/var/www/peertube/storage/logs/'
previews: '/var/www/peertube/storage/previews/'
thumbnails: '/var/www/peertube/storage/thumbnails/'
torrents: '/var/www/peertube/storage/torrents/'
2018-07-12 19:02:00 +02:00
captions: '/var/www/peertube/storage/captions/'
cache: '/var/www/peertube/storage/cache/'
2017-02-16 19:19:56 +01:00
2018-01-19 13:58:13 +01:00
log:
2018-02-14 15:33:25 +01:00
level: 'info' # debug/info/warning/error
2018-01-19 13:58:13 +01:00
2018-08-22 16:15:35 +02:00
search:
# Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
# If enabled, the associated group will be able to "escape" from the instance follows
# That means they will be able to follow channels, watch videos, list videos of non followed instances
remote_uri:
2018-08-22 16:15:35 +02:00
users: true
anonymous: false
2018-08-31 17:18:13 +02:00
trending:
videos:
interval_days: 7 # Compute trending videos for the last x days
2018-09-11 16:27:07 +02:00
# Cache remote videos on your server, to help other instances to broadcast the video
# You can define multiple caches using different sizes/strategies
# Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
redundancy:
videos:
check_interval: '1 hour' # How often you want to check new videos to cache
2018-12-04 16:02:49 +01:00
strategies: # Just uncomment strategies you want
# -
# size: '10GB'
# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
# min_lifetime: '48 hours'
# strategy: 'most-views' # Cache videos that have the most views
# -
# size: '10GB'
# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
# min_lifetime: '48 hours'
# strategy: 'trending' # Cache trending videos
# -
# size: '10GB'
# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
# min_lifetime: '48 hours'
# strategy: 'recently-added' # Cache recently added videos
# min_views: 10 # Having at least x views
2018-09-11 16:27:07 +02:00
csp:
enabled: false
report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
report_uri:
2019-04-10 09:23:18 +02:00
tracker:
# If you disable the tracker, you disable the P2P aspect of PeerTube
enabled: true
# Only handle requests on your videos.
# If you set this to false it means you have a public tracker.
# Then, it is possible that clients overload your instance with external torrents
private: true
# Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
reject_too_many_announces: false
history:
videos:
# If you want to limit users videos history
# -1 means there is no limitations
# Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
max_age: -1
2019-04-11 17:33:36 +02:00
views:
videos:
# PeerTube creates a database entry every hour for each video to track views over a period of time
# This is used in particular by the Trending page
# PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
# -1 means no cleanup
# Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
remote:
max_age: -1
###############################################################################
#
2018-03-30 18:36:40 +02:00
# From this point, all the following keys can be overridden by the web interface
# (local-production.json file). If you need to change some values, prefer to
# use the web interface because the configuration will be automatically
# reloaded without any need to restart PeerTube.
#
# /!\ If you already have a local-production.json file, the modification of the
# following keys will have no effect /!\.
#
###############################################################################
cache:
previews:
2018-07-25 15:11:06 +02:00
size: 500 # Max number of previews you want to cache
captions:
size: 500 # Max number of video captions/subtitles you want to cache
2017-02-16 19:19:56 +01:00
admin:
2019-01-09 15:14:29 +01:00
# Used to generate the root user at first startup
# And to receive emails from the contact form
2017-02-16 19:19:56 +01:00
email: 'admin@example.com'
2017-03-10 11:32:39 +01:00
2019-01-09 15:14:29 +01:00
contact_form:
enabled: true
2017-03-10 11:32:39 +01:00
signup:
enabled: false
limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
requires_email_verification: false
2018-05-29 10:28:08 +02:00
filters:
cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
whitelist: []
blacklist: []
2017-09-04 20:07:54 +02:00
user:
# Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
# -1 == unlimited
video_quota: -1
video_quota_daily: -1
2017-09-04 20:07:54 +02:00
# If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
2018-06-07 16:44:22 +02:00
# In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
# Please, do not disable transcoding since many uploaded videos will not work
transcoding:
enabled: true
2018-12-11 14:52:50 +01:00
# Allow your users to upload .mkv, .mov, .avi, .flv videos
allow_additional_extensions: true
threads: 1
2018-06-07 16:44:22 +02:00
resolutions: # Only created if the original video has a higher resolution, uses more storage!
240p: false
360p: false
480p: false
720p: false
1080p: false
2019-01-29 08:37:25 +01:00
# /!\ EXPERIMENTAL /!\
# /!\ Requires ffmpeg >= 4
# Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
2019-01-29 08:37:25 +01:00
# * Resolution change is smoother
# * Faster playback in particular with long videos
# * More stable playback (less bugs/infinite loading)
# /!\ Multiply videos storage by 2 /!\
2019-01-29 08:37:25 +01:00
hls:
enabled: false
2018-08-03 11:10:31 +02:00
import:
# Add ability for your users to import remote videos (from YouTube, torrent...)
videos:
http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
enabled: false
2018-08-07 10:07:53 +02:00
torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
enabled: false
2018-08-03 11:10:31 +02:00
auto_blacklist:
# New videos automatically blacklisted so moderators can review before publishing
videos:
of_users:
2019-04-08 14:04:57 +02:00
enabled: false
# Instance settings
instance:
name: 'PeerTube'
2018-03-15 14:31:08 +01:00
short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
description: '' # Support markdown
terms: '' # Support markdown
2018-03-01 13:57:29 +01:00
default_client_route: '/videos/trending'
2019-02-20 15:36:43 +01:00
# Whether or not the instance is dedicated to NSFW content
# Enabling it will allow other administrators to know that you are mainly federating sensitive content
# Moreover, the NSFW checkbox on video upload will be automatically checked by default
is_nsfw: false
# By default, "do_not_list" or "blur" or "display" NSFW videos
# Could be overridden per user with a setting
default_nsfw_policy: 'do_not_list'
customizations:
javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
2018-05-22 11:02:10 +02:00
# Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
2018-05-15 00:29:40 +02:00
robots: |
User-agent: *
Disallow:
# Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
securitytxt:
2018-09-06 14:07:10 +02:00
"# 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:"
services:
# You can provide a reporting endpoint for Content Security Policy violations
csp-logger:
# Cards configuration to format video in Twitter
twitter:
2018-05-31 11:04:34 +02:00
username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
# If true, a video player will be embedded in the Twitter feed on PeerTube video share
# If false, we use an image link card that will redirect on your PeerTube instance
# Test on https://cards-dev.twitter.com/validator to see if you are whitelisted
2018-05-14 17:51:15 +02:00
whitelisted: false
2019-04-08 14:04:57 +02:00
followers:
instance:
# Allow or not other instances to follow yours
enabled: true
# Whether or not an administrator must manually validate a new follower
manual_approval: false