]> Untitled Git - lemmy.git/blob - config/defaults.hjson
Create a custom pre-commit hook, generates config/defaults.hjson (#1857)
[lemmy.git] / config / defaults.hjson
1 {
2   // settings related to the postgresql database
3   "database": {
4     // Username to connect to postgres
5     "user": "lemmy",
6     // Password to connect to postgres
7     "password": "password",
8     // Host where postgres is running
9     "host": "localhost",
10     // Port where postgres can be accessed
11     "port": 5432,
12     // Name of the postgres database for lemmy
13     "database": "lemmy",
14     // Maximum number of active sql connections
15     "pool_size": 5
16   },
17   // rate limits for various user actions, by user ip
18   "rate_limit": {
19     // Maximum number of messages created in interval
20     "message": 180,
21     // Interval length for message limit, in seconds
22     "message_per_second": 60,
23     // Maximum number of posts created in interval
24     "post": 6,
25     // Interval length for post limit, in seconds
26     "post_per_second": 600,
27     // Maximum number of registrations in interval
28     "register": 3,
29     // Interval length for registration limit, in seconds
30     "register_per_second": 3600,
31     // Maximum number of image uploads in interval
32     "image": 6,
33     // Interval length for image uploads, in seconds
34     "image_per_second": 3600
35   },
36   // Settings related to activitypub federation
37   "federation": {
38     // Whether to enable activitypub federation.
39     "enabled": false,
40     // Allows and blocks are described here:
41     // https://join-lemmy.org/docs/en/federation/administration.html///instance-allowlist-and-blocklist
42     // 
43     // list of instances with which federation is allowed
44     "allowed_instances": [
45       "instance1.tld",
46       "instance2.tld",
47       /* ... */
48     ],
49     // Instances which we never federate anything with (but previously federated objects are unaffected)
50     "blocked_instances": [
51       "string",
52       /* ... */
53     ],
54     // If true, only federate with instances on the allowlist and block everything else. If false,
55     // use allowlist only for remote communities, and posts/comments in local communities
56     // (meaning remote communities will show content from arbitrary instances).
57     "strict_allowlist": true
58   },
59   "captcha": {
60     // Whether captcha is required for signup
61     "enabled": false,
62     // Can be easy, medium, or hard
63     "difficulty": "medium"
64   },
65   // Email sending configuration. All options except login/password are mandatory
66   "email": {
67     // Hostname and port of the smtp server
68     "smtp_server": "localhost:25",
69     // Login name for smtp server
70     "smtp_login": "string",
71     // Password to login to the smtp server
72     "smtp_password": "string",
73     // Address to send emails from, eg "noreply@your-instance.com"
74     "smtp_from_address": "noreply@example.com",
75     // Whether or not smtp connections should use tls
76     "use_tls": true
77   },
78   // Parameters for automatic configuration of new instance (only used at first start)
79   "setup": {
80     // Username for the admin user
81     "admin_username": "admin",
82     // Password for the admin user
83     "admin_password": "my_passwd",
84     // Name of the site (can be changed later)
85     "site_name": "My Lemmy Instance",
86     // Email for the admin user (optional, can be omitted and set later through the website)
87     "admin_email": "string",
88     "sidebar": "string",
89     "description": "string",
90     "icon": "string",
91     "banner": "string",
92     "enable_downvotes": true,
93     "open_registration": true,
94     "enable_nsfw": true,
95     "community_creation_admin_only": true
96   },
97   // the domain name of your instance (mandatory)
98   "hostname": "unset",
99   // Address where lemmy should listen for incoming requests
100   "bind": "0.0.0.0",
101   // Port where lemmy should listen for incoming requests
102   "port": 8536,
103   // Whether the site is available over TLS. Needs to be true for federation to work.
104   "tls_enabled": true,
105   // Address where pictrs is available (for image hosting)
106   "pictrs_url": "http://localhost:8080",
107   // Regex for slurs which are prohibited. Example: `(\bThis\b)|(\bis\b)|(\bsample\b)`
108   "additional_slurs": "string",
109   // Maximum length of local community and user names
110   "actor_name_max_length": 20
111 }