refactor: update default server configuration values and improve documentation

Author: sakethpathike

README.md

@@ -47,10 +47,26 @@ will be prompted to provide the required values, which will be saved locally.
 ```
 
 - `databaseUrl`: The database URL (without username or password).
-- `databaseUser`: The username for your database.
-- `databasePassword`: The password for your database.
-- `hostAddress`: The host address of the server. If not provided, defaults to `0.0.0.0`.
-- `serverPort`: The port number on which the server runs. If not provided, defaults to `8080`.
+  - `databaseUrl` should always start with the name of the database you're using:
+    - PGSQL (or) PostgreSQL :
+      ```
+      postgresql://someAddress:port/linkora
+      ``` 
+    - MySQL :
+      ```
+      mysql://someAddress:port/linkora
+      ``` 
+    - SQLite :
+      ```
+      sqlite:path-to-db
+      ``` 
+      `path-to-db` should look something like `sqlite:/home/saketh/Documents/sqlite/databaseFileName`
+- `databaseUser`: The username of the database you want to connect to.
+  - If you are using SQLite, leave this blank or press Enter when the setup prompts for it.
+- `databasePassword`: The password of the database you want to connect to.
+  - If you are using SQLite, leave this blank or press Enter when the setup prompts for it.
+- `hostAddress`: The host address of the server. If not provided, it defaults to the `IPv4` of the network currently connected to. When connecting from Linkora apps, you should pass this address instead of `localhost`.
+- `serverPort`: The port number on which the server runs. If not provided, defaults to `45454`.
 - `serverAuthToken`: A secure token used to authenticate requests from the Linkora app. Treat this like a password and
   keep it confidential.
 
@@ -65,13 +81,15 @@ set:
 
 - `LINKORA_SERVER_USE_ENV_VAL`: Set this to `true` to enable the use of environment variables. This must always be `true` when using environment variables.
 - `LINKORA_DATABASE_URL`: The database URL (without username or password).
-- `LINKORA_DATABASE_USER`: The username for your database.
-- `LINKORA_DATABASE_PASSWORD`: The password for your database.
+- `LINKORA_DATABASE_USER`: The username of the database you want to connect to.
+  - If you are using SQLite, leave this blank.
+- `LINKORA_DATABASE_PASSWORD`: The password of the database you want to connect to.
+  - If you are using SQLite, leave this blank.
 - `LINKORA_SERVER_AUTH_TOKEN`: A secure token used to authenticate requests from the Linkora app. Treat this like a
   password and
   keep it confidential.
-- `LINKORA_HOST_ADDRESS`: The host address of the server. If not provided, defaults to `0.0.0.0`.
-- `LINKORA_SERVER_PORT`: The port number on which the server runs. If not provided, defaults to `8080`.
+- `LINKORA_HOST_ADDRESS`: The host address of the server. If not provided, it defaults to the `IPv4` of the network currently connected to. When connecting from Linkora apps, you should pass this address instead of `localhost`.
+- `LINKORA_SERVER_PORT`: The port number on which the server runs. If not provided, defaults to `45454`.
 
 ### 3. Hosting Options
 
@@ -145,6 +163,12 @@ authentication details.
   - For local hosting with Docker, use the provided `docker run` command with environment variables.
   - For remote hosting, use the environment variable service provided by your cloud hosting provider.
 
+#### Workflow of Linkora, which should make it easier to understand how everything works:
+
+<a href="https://github.com/user-attachments/assets/bb2d9b7e-92c4-41ed-82d3-ad821cc65638" onclick="window.open(this.href, '_blank'); return false;">
+  <img alt="linkora-outline.png" src="https://github.com/user-attachments/assets/bb2d9b7e-92c4-41ed-82d3-ad821cc65638" style="max-width: 100%; height: auto;">
+</a>
+
 ### Join the Community
 
 [![Join us on Discord](https://discord.com/api/guilds/1214971383352664104/widget.png?style=banner2)](https://discord.gg/ZDBXNtv8MD)

src/main/kotlin/com/sakethh/linkora/Application.kt

@@ -16,6 +16,7 @@ import io.ktor.server.websocket.*
 import kotlinx.serialization.encodeToString
 import kotlinx.serialization.json.Json
 import java.awt.Desktop
+import java.net.InetAddress
 import java.net.URI
 import java.nio.file.Files
 import java.nio.file.Paths
@@ -91,11 +92,11 @@ object ServerConfiguration {
                     // manually throw the exception as `getenv` may return null, and no conversion is happening here to auto-throw
                     System.getenv(SysEnvKey.LINKORA_HOST_ADDRESS.name) ?: throw NullPointerException()
                 } catch (_: Exception) {
-                    "0.0.0.0"
+                    InetAddress.getLocalHost().hostAddress
                 }, serverPort = try {
                     System.getenv(SysEnvKey.LINKORA_SERVER_PORT.name).toInt()
                 } catch (_: Exception) {
-                    8080
+                    45454
                 },
                 serverAuthToken = System.getenv(SysEnvKey.LINKORA_SERVER_AUTH_TOKEN.name)
             )

src/main/resources/raw/SERVER_IS_CONFIGURED.md

@@ -1,4 +1,4 @@
-It seems you've correctly configured the sync-server.
+It seems you've configured the sync-server correctly; to check if it's running, browse to this endpoint or refresh—if the page loads again, the server is up; ensure the connected database is also running.
 
 This server is meant to communicate only with the **[Linkora](https://github.com/LinkoraApp/Linkora)** apps, available on **Android** and **Desktop**. There's no web-based frontend yet, so you can’t control anything through a web interface. That said, if you’re willing to build your own custom solution from scratch that connects to this server and does what it needs to, then it’s totally possible.