ansible/roles/prosody/templates/prosody.cfg.lua.j2

257 lines
10 KiB
Plaintext
Raw Normal View History

2019-09-09 19:09:44 +02:00
-- Prosody Configuration File
--
2016-02-11 16:15:38 +01:00
-- Information on configuring Prosody can be found on our
2019-09-09 19:09:44 +02:00
-- website at https://prosody.im/doc/configure
2016-02-11 16:15:38 +01:00
--
-- Tip: You can check that the syntax of this file is correct
2019-09-09 19:09:44 +02:00
-- when you have finished by running this command:
-- prosodyctl check config
2016-02-11 16:15:38 +01:00
-- If there are any errors, it will let you know what and where
-- they are, otherwise it will keep quiet.
---------- Server-wide settings ----------
-- Settings in this section apply to the whole server and are the default settings
-- for any virtual hosts
-- This is a (by default, empty) list of accounts that are admins
-- for the server. Note that you must create the accounts separately
2019-09-09 19:09:44 +02:00
-- (see https://prosody.im/doc/creating_accounts for info)
2016-02-11 16:15:38 +01:00
-- Example: admins = { "user1@example.com", "user2@example.net" }
admins = { "{{ prosody_admin }}" }
-- Enable use of libevent for better performance under high load
2019-09-09 19:09:44 +02:00
-- For more information see: https://prosody.im/doc/libevent
use_libevent = true;
2016-02-11 16:15:38 +01:00
2019-09-09 19:09:44 +02:00
-- Prosody will always look in its source directory for modules, but
-- this option allows you to specify additional locations where Prosody
-- will look for modules first. For community modules, see https://modules.prosody.im/
-- For a local administrator it's common to place local modifications
-- under /usr/local/ hierarchy:
plugin_paths = { "/usr/local/lib/prosody/modules" }
2016-02-11 16:15:38 +01:00
-- This is the list of modules Prosody will load on startup.
-- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.
2019-09-09 19:09:44 +02:00
-- Documentation for bundled modules can be found at: https://prosody.im/doc/modules
2016-02-11 16:15:38 +01:00
modules_enabled = {
-- Generally required
"roster"; -- Allow users to have a roster. Recommended ;)
"saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
"tls"; -- Add support for secure TLS on c2s/s2s connections
"dialback"; -- s2s dialback support
"disco"; -- Service discovery
-- Not essential, but recommended
2019-09-09 19:09:44 +02:00
"carbons"; -- Keep multiple clients in sync
"pep"; -- Enables users to publish their avatar, mood, activity, playing music and more
2016-02-11 16:15:38 +01:00
"private"; -- Private XML storage (for room bookmarks, etc.)
2019-09-09 19:09:44 +02:00
"blocklist"; -- Allow users to block communications with other users
"vcard4"; -- User profiles (stored in PEP)
"vcard_legacy"; -- Conversion between legacy vCard and PEP Avatar, vcard
2016-02-11 16:15:38 +01:00
-- Nice to have
"version"; -- Replies to server version requests
"uptime"; -- Report how long server has been running
"time"; -- Let others know the time here on this server
"ping"; -- Replies to XMPP pings with pongs
"register"; -- Allow users to register on this server using a client and change passwords
2019-09-09 19:09:44 +02:00
"mam"; -- Store messages in an archive and allow users to access it
--"csi_simple"; -- Simple Mobile optimizations
2016-02-11 16:15:38 +01:00
-- Admin interfaces
"admin_adhoc"; -- Allows administration via an XMPP client that supports ad-hoc commands
--"admin_telnet"; -- Opens telnet console interface on localhost port 5582
-- HTTP modules
"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
2019-09-09 19:09:44 +02:00
"websocket"; -- XMPP over WebSockets
2016-02-11 16:15:38 +01:00
--"http_files"; -- Serve static files from a directory over HTTP
-- Other specific functionality
"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
2019-09-09 19:09:44 +02:00
--"limits"; -- Enable bandwidth limiting for XMPP connections
2016-02-11 16:15:38 +01:00
--"groups"; -- Shared roster support
2019-09-09 19:09:44 +02:00
--"server_contact_info"; -- Publish contact information for this service
"announce"; -- Send announcement to all online users
2016-02-11 16:15:38 +01:00
--"welcome"; -- Welcome users who register accounts
--"watchregistrations"; -- Alert admins of registrations
--"motd"; -- Send a message to users when they log in
--"legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
2019-09-09 19:09:44 +02:00
--"proxy65"; -- Enables a file transfer proxy service which clients behind NAT can use
-- User experience
2016-02-11 16:15:38 +01:00
"smacks"; -- XEP-0198: Reliability and fast reconnects for XMPP
"csi"; -- XEP-0352: Client State Indication
"throttle_presence"; -- CSI: suppress presence updates
"filter_chatstates"; -- CSI: remove chat states (Someone is typing...)
"cloud_notify"; -- XEP-0357: Push Notifications
"http_upload"; -- XEP-0363: HTTP File Upload
2019-09-09 19:09:44 +02:00
}
2016-02-11 16:15:38 +01:00
-- These modules are auto-loaded, but should you want
-- to disable them then uncomment them here:
modules_disabled = {
-- "offline"; -- Store offline messages
-- "c2s"; -- Handle client connections
-- "s2s"; -- Handle server-to-server connections
2019-09-09 19:09:44 +02:00
}
2016-02-11 16:15:38 +01:00
-- Disable account creation by default, for security
2019-09-09 19:09:44 +02:00
-- For more information see https://prosody.im/doc/creating_accounts
allow_registration = false
2016-02-11 16:15:38 +01:00
-- Debian:
2019-09-09 19:09:44 +02:00
-- Do not send the server to background, either systemd or start-stop-daemon take care of that.
2016-02-11 16:15:38 +01:00
--
2019-09-09 19:09:44 +02:00
daemonize = false;
2016-02-11 16:15:38 +01:00
-- Debian:
2019-09-09 19:09:44 +02:00
-- Please, don't change this option since /run/prosody/
2016-02-11 16:15:38 +01:00
-- is one of the few directories Prosody is allowed to write to
--
2019-09-09 19:09:44 +02:00
pidfile = "/run/prosody/prosody.pid";
2016-02-11 16:15:38 +01:00
-- These are the SSL/TLS-related settings. If you don't want
-- to use SSL/TLS, you may comment or remove this
ssl = {
key = "/etc/prosody/certs/{{ prosody_domain }}.key";
certificate = "/etc/prosody/certs/{{ prosody_domain }}.crt";
}
-- Force clients to use encrypted connections? This option will
-- prevent clients from authenticating unless they are using encryption.
c2s_require_encryption = true
2019-09-09 19:09:44 +02:00
-- Force servers to use encrypted connections? This option will
-- prevent servers from authenticating unless they are using encryption.
s2s_require_encryption = true
2016-02-11 16:15:38 +01:00
-- Force certificate authentication for server-to-server connections?
s2s_secure_auth = false
2019-09-09 19:09:44 +02:00
-- Some servers have invalid or self-signed certificates. You can list
-- remote domains here that will not be required to authenticate using
-- certificates. They will be authenticated using DNS instead, even
-- when s2s_secure_auth is enabled.
2016-02-11 16:15:38 +01:00
2019-09-09 19:09:44 +02:00
--s2s_insecure_domains = { "insecure.example" }
2016-02-11 16:15:38 +01:00
2019-09-09 19:09:44 +02:00
-- Even if you disable s2s_secure_auth, you can still require valid
2016-02-11 16:15:38 +01:00
-- certificates for some domains by specifying a list here.
--s2s_secure_domains = { "jabber.org" }
-- Select the authentication backend to use. The 'internal' providers
-- use Prosody's configured data storage to store the authentication data.
2019-09-09 19:09:44 +02:00
-- TODO This setting needs testing, old value retained as comment
--authentication = "internal_plain"
authentication = "internal_hashed"
2016-02-11 16:15:38 +01:00
-- Select the storage backend to use. By default Prosody uses flat files
-- in its configured data directory, but it also supports more backends
-- through modules. An "sql" backend is included by default, but requires
2019-09-09 19:09:44 +02:00
-- additional dependencies. See https://prosody.im/doc/storage for more info.
2016-02-11 16:15:38 +01:00
--storage = "sql" -- Default is "internal" (Debian: "sql" requires one of the
-- lua-dbi-sqlite3, lua-dbi-mysql or lua-dbi-postgresql packages to work)
-- For the "sql" backend, you can uncomment *one* of the below to configure:
--sql = { driver = "SQLite3", database = "prosody.sqlite" } -- Default. 'database' is the filename.
--sql = { driver = "MySQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
--sql = { driver = "PostgreSQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
2019-09-09 19:09:44 +02:00
-- Archiving configuration
-- If mod_mam is enabled, Prosody will store a copy of every message. This
-- is used to synchronize conversations between multiple clients, even if
-- they are offline. This setting controls how long Prosody will keep
-- messages in the archive before removing them.
archive_expires_after = "2w" -- Remove archived messages after 2 weeks
-- You can also configure messages to be stored in-memory only. For more
-- archiving options, see https://prosody.im/doc/modules/mod_mam
2016-02-11 16:15:38 +01:00
-- Logging configuration
2019-09-09 19:09:44 +02:00
-- For advanced logging see https://prosody.im/doc/logging
2016-02-11 16:15:38 +01:00
--
-- Debian:
-- Logs info and higher to /var/log
-- Logs errors to syslog also
log = {
-- Log files (change 'info' to 'debug' for debug logs):
info = "/var/log/prosody/prosody.log";
error = "/var/log/prosody/prosody.err";
-- Syslog:
{ levels = { "error" }; to = "syslog"; };
}
2019-09-09 19:09:44 +02:00
-- Uncomment to enable statistics
-- For more info see https://prosody.im/doc/statistics
-- statistics = "internal"
-- Certificates
-- Every virtual host and component needs a certificate so that clients and
-- servers can securely verify its identity. Prosody will automatically load
-- certificates/keys from the directory specified here.
-- For more information, including how to use 'prosodyctl' to auto-import certificates
-- (from e.g. Let's Encrypt) see https://prosody.im/doc/certificates
-- Location of directory to find certificates in (relative to main config file):
certificates = "certs"
-- HTTPS currently only supports a single certificate, specify it here:
--https_certificate = "/etc/prosody/certs/localhost.crt"
2016-02-11 16:15:38 +01:00
----------- Virtual hosts -----------
-- You need to add a VirtualHost entry for each domain you wish Prosody to serve.
-- Settings under each VirtualHost entry apply *only* to that host.
2019-09-09 19:09:44 +02:00
-- It's customary to maintain VirtualHost entries in separate config files
-- under /etc/prosody/conf.d/ directory. Examples of such config files can
-- be found in /etc/prosody/conf.avail/ directory.
2016-02-11 16:15:38 +01:00
VirtualHost "{{ prosody_domain }}"
2016-04-08 09:07:06 +02:00
authentication = "cyrus"
cyrus_application_name = "xmpp"
cyrus_service_name = "xmpp"
2016-02-11 16:15:38 +01:00
-- Assign this host a certificate for TLS, otherwise it would use the one
-- set in the global section (if any).
-- Note that old-style SSL on port 5223 only supports one certificate, and will always
-- use the global one.
ssl = {
key = "/etc/prosody/certs/{{ prosody_domain }}.key";
certificate = "/etc/prosody/certs/{{ prosody_domain }}.crt";
}
------ Components ------
-- You can specify components to add hosts that provide special services,
-- like multi-user conferences, and transports.
2019-09-09 19:09:44 +02:00
-- For more information on components, see https://prosody.im/doc/components
2016-02-11 16:15:38 +01:00
---Set up a MUC (multi-user chat) room server on conference.example.com:
--Component "conference.example.com" "muc"
2019-09-09 19:09:44 +02:00
--- Store MUC messages in an archive and allow users to access it
--modules_enabled = { "muc_mam" }
2016-02-11 16:15:38 +01:00
-- Set up a SOCKS5 bytestream proxy for server-proxied file transfers:
Component "proxy.{{ prosody_domain }}" "proxy65"
proxy65_address = "{{ prosody_domain }}"
proxy65_acl = { "{{ prosody_domain }}" }
2016-02-11 16:15:38 +01:00
---Set up an external component (default component port is 5347)
--
-- External components allow adding various services, such as gateways/
-- transports to other networks like ICQ, MSN and Yahoo. For more info
2019-09-09 19:09:44 +02:00
-- see: https://prosody.im/doc/components#adding_an_external_component
2016-02-11 16:15:38 +01:00
--
--Component "gateway.example.com"
-- component_secret = "password"