hostname: '127.0.0.1'
port: 9000
+# Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
webserver:
https: false
hostname: 'localhost'
trust_proxy:
- 'loopback'
-# Your database name will be "peertube"+database.suffix
+# Your database name will be database.name OR 'peertube'+database.suffix
database:
hostname: 'localhost'
port: 5432
+ ssl: false
suffix: '_dev'
username: 'peertube'
password: 'peertube'
pool:
max: 5
+# Redis server for short time storage
# You can also specify a 'socket' path to a unix socket but first need to
# comment out hostname and port
redis:
auth: null
db: 0
+# SMTP server to send emails
smtp:
+ # smtp or sendmail
+ transport: smtp
+ # Path to sendmail command. Required if you use sendmail transport
+ sendmail: null
hostname: null
- port: 465
+ port: 465 # If you use StartTLS: 587
username: null
password: null
- tls: true
+ tls: true # If you use StartTLS: false
disable_starttls: false
ca_file: null # Used for self signed certificates
from_address: 'admin@example.com'
email:
body:
- signature: "PeerTube"
+ signature: 'PeerTube'
subject:
- prefix: "[PeerTube]"
+ prefix: '[PeerTube]'
+
+# PeerTube client/interface configuration
+client:
+ videos:
+ miniature:
+ # By default PeerTube client displays author username
+ prefer_author_display_name: false
# From the project root directory
storage:
- tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before processing...
+ tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
+ bin: 'storage/bin/'
avatars: 'storage/avatars/'
videos: 'storage/videos/'
streaming_playlists: 'storage/streaming-playlists/'
captions: 'storage/captions/'
cache: 'storage/cache/'
plugins: 'storage/plugins/'
+ # Overridable client files in client/dist/assets/images:
+ # - logo.svg
+ # - favicon.png
+ # - default-playlist.jpg
+ # - default-avatar-account.png
+ # - default-avatar-video-channel.png
+ # - and icons/*.png (PWA)
+ # Could contain for example assets/images/favicon.png
+ # If the file exists, peertube will serve it
+ # If not, peertube will fallback to the default file
+ client_overrides: 'storage/client-overrides/'
+
+object_storage:
+ enabled: false
+
+ # Without protocol, will default to HTTPS
+ endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
+
+ region: 'us-east-1'
+
+ credentials:
+ # You can also use AWS_ACCESS_KEY_ID env variable
+ access_key_id: ''
+ # You can also use AWS_SECRET_ACCESS_KEY env variable
+ secret_access_key: ''
+
+ # Maximum amount to upload in one request to object storage
+ max_upload_part: 2GB
+
+ streaming_playlists:
+ bucket_name: 'streaming-playlists'
+
+ # Allows setting all buckets to the same value but with a different prefix
+ prefix: '' # Example: 'streaming-playlists:'
+
+ # Base url for object URL generation, scheme and host will be replaced by this URL
+ # Useful when you want to use a CDN/external proxy
+ base_url: '' # Example: 'https://mirror.example.com'
+
+ # Same settings but for webtorrent videos
+ videos:
+ bucket_name: 'videos'
+ prefix: ''
+ base_url: ''
log:
- level: 'info' # debug/info/warning/error
+ level: 'info' # 'debug' | 'info' | 'warn' | 'error'
rotation:
- enabled : true
-
-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:
- users: true
- anonymous: false
+ enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
+ max_file_size: 12MB
+ max_files: 20
+ anonymize_ip: false
+ log_ping_requests: true
+ prettify_sql: false
trending:
videos:
interval_days: 7 # Compute trending videos for the last x days
+ algorithms:
+ enabled:
+ - 'best' # adaptation of Reddit's 'Best' algorithm (Hot minus History)
+ - 'hot' # adaptation of Reddit's 'Hot' algorithm
+ - 'most-viewed' # default, used initially by PeerTube as the trending page
+ - 'most-liked'
+ default: 'most-viewed'
# Cache remote videos on your server, to help other instances to broadcast the video
# You can define multiple caches using different sizes/strategies
# strategy: 'recently-added' # Cache recently added videos
# min_views: 10 # Having at least x views
+# Other instances that duplicate your content
+remote_redundancy:
+ videos:
+ # 'nobody': Do not accept remote redundancies
+ # 'anybody': Accept remote redundancies from anybody
+ # 'followings': Accept redundancies from instance followings
+ accept_from: 'anybody'
+
csp:
enabled: false
report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
report_uri:
+security:
+ # Set the X-Frame-Options header to help to mitigate clickjacking attacks
+ frameguard:
+ enabled: true
+
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.
+ # 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)
# -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
+ max_age: '30 days'
plugins:
# The website PeerTube will ask for available PeerTube plugins and themes
check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
url: 'https://packages.joinpeertube.org'
+federation:
+ videos:
+ federate_unlisted: false
+
+ # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
+ # It removes objects that do not exist anymore, and potentially fix their URLs
+ # This setting is opt-in because due to an old bug in PeerTube, remote rates sent by instance before PeerTube 3.0 will be deleted
+ # We still suggest you to enable this setting even if your users will loose most of their video's likes/dislikes
+ cleanup_remote_interactions: false
+
+peertube:
+ check_latest_version:
+ # Check and notify admins of new PeerTube versions
+ enabled: true
+ # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
+ url: 'https://joinpeertube.org/api/v1/versions.json'
+
+webadmin:
+ configuration:
+ edition:
+ # Set this to false if you don't want to allow config edition in the web interface by instance admins
+ allowed: true
+
cache:
previews:
size: 500 # Max number of previews you want to cache
captions:
size: 500 # Max number of video captions/subtitles you want to cache
+ torrents:
+ size: 500 # Max number of video torrents you want to cache
admin:
# Used to generate the root user at first startup
signup:
enabled: false
limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
+ minimum_age: 16 # Used to configure the signup form
requires_email_verification: false
filters:
cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
blacklist: []
user:
- # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
+ # Default value of maximum video bytes the user can upload (does not take into account transcoded files)
+ # Byte format is supported ("1GB" etc)
# -1 == unlimited
video_quota: -1
video_quota_daily: -1
-# If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
-# In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
+# If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
+# 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
- # Allow your users to upload .mkv, .mov, .avi, .flv videos
+
+ # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
allow_additional_extensions: true
+
# If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
allow_audio_files: true
+
+ # Amount of threads used by ffmpeg for 1 transcoding job
threads: 1
+ # Amount of transcoding jobs to execute in parallel
+ concurrency: 1
+
+ # Choose the transcoding profile
+ # New profiles can be added by plugins
+ # Available in core PeerTube: 'default'
+ profile: 'default'
+
resolutions: # Only created if the original video has a higher resolution, uses more storage!
+ 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
240p: false
360p: false
480p: false
720p: false
1080p: false
+ 1440p: false
2160p: false
- # /!\ EXPERIMENTAL /!\
- # /!\ Requires ffmpeg >= 4
+
+ # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
+ # If you also enabled the hls format, it will multiply videos storage by 2
+ # If disabled, breaks federation with PeerTube instances < 2.1
+ webtorrent:
+ enabled: false
+
+ # /!\ Requires ffmpeg >= 4.1
# Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
# * Resolution change is smoother
# * Faster playback in particular with long videos
# * More stable playback (less bugs/infinite loading)
- # /!\ Multiplies videos storage by 2 /!\
+ # If you also enabled the webtorrent format, it will multiply videos storage by 2
hls:
- enabled: false
+ enabled: true
+
+live:
+ enabled: false
+
+ # Limit lives duration
+ # -1 == unlimited
+ max_duration: -1 # For example: '5 hours'
+
+ # Limit max number of live videos created on your instance
+ # -1 == unlimited
+ max_instance_lives: 20
+
+ # Limit max number of live videos created by a user on your instance
+ # -1 == unlimited
+ max_user_lives: 3
+
+ # Allow your users to save a replay of their live
+ # PeerTube will transcode segments in a video file
+ # If the user daily/total quota is reached, PeerTube will stop the live
+ # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
+ allow_replay: true
+
+ # Your firewall should accept traffic from this port in TCP if you enable live
+ rtmp:
+ port: 1935
+
+ # Allow to transcode the live streaming in multiple live resolutions
+ transcoding:
+ enabled: true
+ threads: 2
+
+ # Choose the transcoding profile
+ # New profiles can be added by plugins
+ # Available in core PeerTube: 'default'
+ profile: 'default'
+
+ resolutions:
+ 240p: false
+ 360p: false
+ 480p: false
+ 720p: false
+ 1080p: false
+ 1440p: false
+ 2160p: false
import:
# Add ability for your users to import remote videos (from YouTube, torrent...)
videos:
+ # Amount of import jobs to execute in parallel
+ concurrency: 1
+
http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
enabled: false
+
+ youtube_dl_release:
+ # Direct download URL to youtube-dl binary
+ # Github releases API is also supported
+ # Examples:
+ # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
+ # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
+ url: 'https://yt-dl.org/downloads/latest/youtube-dl'
+
+ # youtube-dl binary name
+ # yt-dlp is also supported
+ name: 'youtube-dl'
+
+ # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
+ force_ipv4: false
+
torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
enabled: false
of_users:
enabled: false
+# Instance settings
instance:
name: 'PeerTube'
- short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
+ short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
description: 'Welcome to this PeerTube instance!' # Support markdown
terms: 'No terms for now.' # Support markdown
+ code_of_conduct: '' # Supports markdown
+
+ # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
+ moderation_information: '' # Supports markdown
+
+ # Why did you create this instance?
+ creation_reason: '' # Supports Markdown
+
+ # Who is behind the instance? A single person? A non profit?
+ administrator: '' # Supports Markdown
+
+ # How long do you plan to maintain this instance?
+ maintenance_lifetime: '' # Supports Markdown
+
+ # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
+ business_model: '' # Supports Markdown
+
+ # If you want to explain on what type of hardware your PeerTube instance runs
+ # Example: '2 vCore, 2GB RAM...'
+ hardware_information: '' # Supports Markdown
+
+ # What are the main languages of your instance? To interact with your users for example
+ # Uncomment or add the languages you want
+ # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
+ languages:
+# - en
+# - es
+# - fr
+
+ # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
+ # Uncomment or add the category ids you want
+ # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
+ categories:
+# - 1 # Music
+# - 2 # Films
+# - 3 # Vehicles
+# - 4 # Art
+# - 5 # Sports
+# - 6 # Travels
+# - 7 # Gaming
+# - 8 # People
+# - 9 # Comedy
+# - 10 # Entertainment
+# - 11 # News & Politics
+# - 12 # How To
+# - 13 # Education
+# - 14 # Activism
+# - 15 # Science & Technology
+# - 16 # Animals
+# - 17 # Kids
+# - 18 # Food
+
default_client_route: '/videos/trending'
+
# 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
+ # 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
- # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
+ # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
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.
+ # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
securitytxt:
- "# 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:"
+ '# 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:
# Cards configuration to format video in Twitter
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
- # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
+ # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
whitelisted: false
followers:
# Whether or not an administrator must manually validate a new follower
manual_approval: false
+followings:
+ instance:
+ # If you want to automatically follow back new instance followers
+ # If this option is enabled, use the mute feature instead of deleting followings
+ # /!\ Don't enable this if you don't have a reactive moderation team /!\
+ auto_follow_back:
+ enabled: false
+
+ # If you want to automatically follow instances of the public index
+ # If this option is enabled, use the mute feature instead of deleting followings
+ # /!\ Don't enable this if you don't have a reactive moderation team /!\
+ auto_follow_index:
+ enabled: false
+ # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
+ index_url: ''
+
theme:
default: 'default'
+
+broadcast_message:
+ enabled: false
+ message: '' # Support markdown
+ level: 'info' # 'info' | 'warning' | 'error'
+ dismissable: false
+
+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:
+ users: true
+ anonymous: false
+
+ # Use a third party index instead of your local index, only for search results
+ # Useful to discover content outside of your instance
+ # If you enable search_index, you must enable remote_uri search for users
+ # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
+ # instead of loading the video locally
+ search_index:
+ enabled: false
+ # URL of the search index, that should use the same search API and routes
+ # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
+ # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
+ # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
+ url: ''
+ # You can disable local search, so users only use the search index
+ disable_local_search: false
+ # If you did not disable local search, you can decide to use the search index by default
+ is_default_search: false
projects / github / Chocobozzz / PeerTube.git / blobdiff