config: add environment variable to limit the number of users

KennethTrecy · May 26, 2024 · 1acc329 · 1acc329
1 parent 9ec368d
commit 1acc329
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.env.lax.example b/.env.lax.example
@@ -27,6 +27,9 @@ app.indexPage = "/"
 # app.forceGlobalSecureRequests = false
 # app.CSPEnabled = false
 
+# If `app.user_count_limit` is 0, there is no limit in the number users allowed in the database.
+app.userCountLimit = 0
+
 #--------------------------------------------------------------------
 # DATABASE
 #--------------------------------------------------------------------

diff --git a/app/Config/App.php b/app/Config/App.php
@@ -175,4 +175,16 @@ class App extends BaseConfig
      * @see http://www.w3.org/TR/CSP/
      */
     public bool $CSPEnabled = false;
+
+    /**
+     * --------------------------------------------------------------------------
+     * User Count Limit
+     * --------------------------------------------------------------------------
+     *
+     * Limits the number of users the server allows to register. A value of 0 allows an unlimited
+     * number of users, as long as the database allows.
+     *
+     * @see https://github.com/KennethTrecy/peratorakka_server/issues/16
+     */
+    public int $userCountLimit = 0;
 }