new configuration parameter: web_root

see #87

Author: lovasoa

CHANGELOG.md

@@ -4,6 +4,12 @@
  - Better support for connection options in mssql.
  - New icons (see https://tabler-icons.io/changelog)
  - New version of the CSS library (see https://preview.tabler.io/changelog.html)
+ - configurable web root (see [configuration.md](./configuration.md))
+ - new welcome message 
+   - ```
+      SQLPage is now running on http://127.0.0.1:8080/
+      You can write your code in .sql files in /path/to/your/website/directory.
+      ```
 
 ## 0.10.3 (2023-09-14)
 

configuration.md

@@ -14,6 +14,7 @@ on a [JSON](https://en.wikipedia.org/wiki/JSON) file placed in `sqlpage/sqlpage.
 | `database_connection_retries`              | 6                            | Database connection attempts before giving up. Retries will happen every 5 seconds.           |
 | `database_connection_acquire_timeout_seconds` | 10                        | How long to wait when acquiring a database connection from the pool before giving up and returning an error.           |
 | `sqlite_extensions`                        |                              | An array of SQLite extensions to load, such as `mod_spatialite`          |
+| `web_root`                                | `.`                      | The root directory of the web server, where the `index.sql` file is located.          |
 
 You can find an example configuration file in [`sqlpage/sqlpage.json`](./sqlpage/sqlpage.json).
 

src/app_config.rs

@@ -3,6 +3,7 @@ use config::Config;
 use serde::de::Error;
 use serde::{Deserialize, Deserializer};
 use std::net::{SocketAddr, ToSocketAddrs};
+use std::path::PathBuf;
 
 #[cfg(not(feature = "lambda-web"))]
 const DEFAULT_DATABASE_FILE: &str = "sqlpage.db";
@@ -32,6 +33,9 @@ pub struct AppConfig {
     /// pool. The default is 10 seconds.
     #[serde(default = "default_database_connection_acquire_timeout_seconds")]
     pub database_connection_acquire_timeout_seconds: f64,
+
+    #[serde(default = "default_web_root")]
+    pub web_root: PathBuf,
 }
 
 pub fn load() -> anyhow::Result<AppConfig> {
@@ -102,6 +106,13 @@ fn default_database_connection_acquire_timeout_seconds() -> f64 {
     10.
 }
 
+fn default_web_root() -> PathBuf {
+    std::env::current_dir().unwrap_or_else(|e| {
+        log::error!("Unable to get current directory: {}", e);
+        PathBuf::from(&std::path::Component::CurDir)
+    })
+}
+
 #[cfg(test)]
 pub mod tests {
     use super::AppConfig;

src/lib.rs

@@ -14,7 +14,6 @@ pub mod webserver;
 use crate::app_config::AppConfig;
 use crate::filesystem::FileSystem;
 use crate::webserver::database::{FileCache, ParsedSqlFile};
-use std::env;
 use std::net::SocketAddr;
 use std::path::PathBuf;
 use templates::AllTemplates;
@@ -35,9 +34,8 @@ impl AppState {
         // Connect to the database
         let db = Database::init(config).await?;
         let all_templates = AllTemplates::init()?;
-        let web_root = get_web_root();
         let mut sql_file_cache = FileCache::new();
-        let file_system = FileSystem::init(&web_root, &db).await;
+        let file_system = FileSystem::init(&config.web_root, &db).await;
         sql_file_cache.add_static(
             PathBuf::from("index.sql"),
             ParsedSqlFile::new(&db, include_str!("../index.sql")).await,
@@ -51,13 +49,6 @@ impl AppState {
     }
 }
 
-pub fn get_web_root() -> PathBuf {
-    env::var("WEB_ROOT").map_or_else(
-        |_| PathBuf::from(&std::path::Component::CurDir),
-        PathBuf::from,
-    )
-}
-
 pub struct Config {
     pub listen_on: SocketAddr,
 }

src/main.rs

@@ -1,4 +1,7 @@
-use sqlpage::{app_config, webserver, AppState, Config};
+use sqlpage::{
+    app_config::{self, AppConfig},
+    webserver, AppState, Config,
+};
 
 #[actix_web::main]
 async fn main() {
@@ -10,15 +13,36 @@ async fn main() {
 }
 
 async fn start() -> anyhow::Result<()> {
-    let config = app_config::load()?;
-    log::debug!("Starting with the following configuration: {config:?}");
-    let state = AppState::init(&config).await?;
-    webserver::apply_migrations(&state.db).await?;
-    let listen_on = config.listen_on;
+    let app_config = app_config::load()?;
+    log::debug!("Starting with the following configuration: {app_config:?}");
+    let state = AppState::init(&app_config).await?;
+    webserver::apply_migrations(&state.db, &app_config.web_root).await?;
+    let listen_on = app_config.listen_on;
     log::info!("Starting server on {}", listen_on);
     let config = Config { listen_on };
-    webserver::http::run_server(config, state).await?;
-    Ok(())
+    let (r, _) = tokio::join!(
+        webserver::http::run_server(config, state),
+        log_welcome_message(&app_config)
+    );
+    r
+}
+
+async fn log_welcome_message(config: &AppConfig) {
+    // Don't show 0.0.0.0 as the host, show the actual IP address
+    let http_addr = config.listen_on.to_string().replace(
+        "0.0.0.0",
+        std::net::IpAddr::V4(std::net::Ipv4Addr::LOCALHOST)
+            .to_string()
+            .as_str(),
+    );
+
+    log::info!(
+        "Server started successfully.
+    SQLPage is now running on http://{}/
+    You can write your website's code in .sql files in {}.",
+        http_addr,
+        config.web_root.display()
+    );
 }
 
 fn init_logging() {

src/webserver/database/mod.rs

@@ -47,8 +47,8 @@ impl Database {
     }
 }
 
-pub async fn apply_migrations(db: &Database) -> anyhow::Result<()> {
-    let migrations_dir = Path::new(MIGRATIONS_DIR);
+pub async fn apply_migrations(db: &Database, web_root: &Path) -> anyhow::Result<()> {
+    let migrations_dir = web_root.join(MIGRATIONS_DIR);
     if !migrations_dir.exists() {
         log::info!(
             "Not applying database migrations because '{}' does not exist",