]> Untitled Git - lemmy.git/blobdiff - config/defaults.hjson
Revert "Attempt to fix CI building wrong commits (#3830)"
[lemmy.git] / config / defaults.hjson
index f23b1fb13ef206e9ac8be00c932609f6bdda8e11..1e5597a1172ffebfdff4494cc0b952d8fa231542 100644 (file)
@@ -1,92 +1,87 @@
 {
-#  # optional: parameters for automatic configuration of new instance (only used at first start)
-#  setup: {
-#    # username for the admin user
-#    admin_username: ""
-#    # password for the admin user
-#    admin_password: ""
-#    # optional: email for the admin user (can be omitted and set later through the website)
-#    admin_email: ""
-#    # name of the site (can be changed later)
-#    site_name: ""
-#  }
   # settings related to the postgresql database
   database: {
-    # username to connect to postgres
-    user: "lemmy"
-    # password to connect to postgres
-    password: "password"
-    # host where postgres is running
-    host: "localhost"
-    # port where postgres can be accessed
-    port: 5432
-    # name of the postgres database for lemmy
-    database: "lemmy"
-    # maximum number of active sql connections
+    # Configure the database by specifying a URI
+    # 
+    # This is the preferred method to specify database connection details since
+    # it is the most flexible.
+    # Connection URI pointing to a postgres instance
+    # 
+    # This example uses peer authentication to obviate the need for creating,
+    # configuring, and managing passwords.
+    # 
+    # For an explanation of how to use connection URIs, see [here][0] in
+    # PostgreSQL's documentation.
+    # 
+    # [0]: https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6
+    uri: "postgresql:///lemmy?user=lemmy&host=/var/run/postgresql"
+
+    # or
+
+    # Configure the database by specifying parts of a URI
+    # 
+    # Note that specifying the `uri` field should be preferred since it provides
+    # greater control over how the connection is made. This merely exists for
+    # backwards-compatibility.
+    # Username to connect to postgres
+    user: "string"
+    # Password to connect to postgres
+    password: "string"
+    # Host where postgres is running
+    host: "string"
+    # Port where postgres can be accessed
+    port: 123
+    # Name of the postgres database for lemmy
+    database: "string"
+    # Maximum number of active sql connections
     pool_size: 5
   }
-  # the domain name of your instance (eg "dev.lemmy.ml")
-  hostname: null
-  # address where lemmy should listen for incoming requests
+  # Settings related to activitypub federation
+  # Pictrs image server configuration.
+  pictrs: {
+    # Address where pictrs is available (for image hosting)
+    url: "http://localhost:8080/"
+    # Set a custom pictrs API key. ( Required for deleting images )
+    api_key: "string"
+  }
+  # Email sending configuration. All options except login/password are mandatory
+  email: {
+    # Hostname and port of the smtp server
+    smtp_server: "localhost:25"
+    # Login name for smtp server
+    smtp_login: "string"
+    # Password to login to the smtp server
+    smtp_password: "string"
+    # Address to send emails from, eg "noreply@your-instance.com"
+    smtp_from_address: "noreply@example.com"
+    # Whether or not smtp connections should use tls. Can be none, tls, or starttls
+    tls_type: "none"
+  }
+  # Parameters for automatic configuration of new instance (only used at first start)
+  setup: {
+    # Username for the admin user
+    admin_username: "admin"
+    # Password for the admin user. It must be at least 10 characters.
+    admin_password: "tf6HHDS4RolWfFhk4Rq9"
+    # Name of the site (can be changed later)
+    site_name: "My Lemmy Instance"
+    # Email for the admin user (optional, can be omitted and set later through the website)
+    admin_email: "user@example.com"
+  }
+  # the domain name of your instance (mandatory)
+  hostname: "unset"
+  # Address where lemmy should listen for incoming requests
   bind: "0.0.0.0"
-  # port where lemmy should listen for incoming requests
+  # Port where lemmy should listen for incoming requests
   port: 8536
-  # whether tls is required for activitypub. only disable this for debugging, never for producion.
+  # Whether the site is available over TLS. Needs to be true for federation to work.
   tls_enabled: true
-  # json web token for authorization between server and client
-  jwt_secret: "changeme"
-  # path to built documentation
-  docs_dir: "/app/documentation"
-  # address where pictrs is available
-  pictrs_url: "http://pictrs:8080"
-  # address where iframely is available
-  iframely_url: "http://iframely"
-  # rate limits for various user actions, by user ip
-  rate_limit: {
-    # maximum number of messages created in interval
-    message: 180
-    # interval length for message limit
-    message_per_second: 60
-    # maximum number of posts created in interval
-    post: 6
-    # interval length for post limit
-    post_per_second: 600
-    # maximum number of registrations in interval
-    register: 3
-    # interval length for registration limit
-    register_per_second: 3600
-    # maximum number of image uploads in interval
-    image: 6
-    # interval length for image uploads
-    image_per_second: 3600
-  }
-  # settings related to activitypub federation
-  federation: {
-    # whether to enable activitypub federation. 
-    enabled: false
-    # Allows and blocks are described here:
-    # https://dev.lemmy.ml/docs/administration_federation.html#instance-allowlist-and-blocklist
-    #
-    # comma separated list of instances with which federation is allowed
-    allowed_instances: ""
-    # comma separated list of instances which are blocked from federating
-    blocked_instances: ""
-  }
-  captcha: {
-    enabled: true
-    difficulty: medium # Can be easy, medium, or hard
+  # The number of activitypub federation workers that can be in-flight concurrently
+  worker_count: 0
+  # The number of activitypub federation retry workers that can be in-flight concurrently
+  retry_count: 0
+  prometheus: {
+    bind: "127.0.0.1"
+    port: 10002
   }
-#  # email sending configuration
-#  email: {
-#    # hostname and port of the smtp server
-#    smtp_server: ""
-#    # login name for smtp server
-#    smtp_login: ""
-#    # password to login to the smtp server
-#    smtp_password: ""
-#    # address to send emails from, eg "noreply@your-instance.com"
-#    smtp_from_address: ""
-#    # whether or not smtp connections should use tls
-#    use_tls: true
-#  }
 }