Updated default config example

contrib/docker/README.md

@@ -45,7 +45,7 @@ Check the respective registry for available tags.
 
 > For complete settings and configuration details, refer to the [Geoprox CLI README](../../geoprox/README.md#configuration).
 
-To use a custom configuration file, simply mount your configuration file into the container at `/etc/geoprox`. Geoprox will automatically detect and parse configuration files in formats like `YAML`, `TOML`, `JSON`, or `INI` if they are named `geoprox.yaml`, `geoprox.toml`, `geoprox.json`, or `geoprox.ini`, respectively.
+To use a custom configuration file, simply mount your configuration file into the container at `/var/lib/geoprox`. Geoprox will automatically detect and parse configuration files in formats like `YAML`, `TOML`, `JSON`, or `INI` if they are named `geoprox.yaml`, `geoprox.toml`, `geoprox.json`, or `geoprox.ini`, respectively.
 
 For example, if you have a configuration file named `geoprox.yaml` in your current directory, you can run the container with the following command:
 

contrib/docker/.gitignore → contrib/docker/quickstart/.gitignore

@@ -1 +1,2 @@
 openapi.json
+/snapshots

contrib/docker/quickstart/docker-compose.yml

@@ -2,22 +2,25 @@ services:
   geoprox:
     # I recommend pinning the tag to a specific version.
     # Available tags can be found at https://hub.docker.com/repository/docker/ezrasingh/geoprox/tags
-    image: ezrasingh/geoprox:latest
+    image: ezrasingh/geoprox:${IMAGE_TAG:-latest}
     restart: on-failure:3
 
-    # This is optional, demonstrating how to specify your config path.
-    # The default path is /etc/geoprox/
+    # This is optional, demonstrating how to specify env vars
+    # These are all the defaults
     environment:
-      GEOPROX_CONFIG: /etc/geoprox/geoprox.toml
+      GEOPROX_CONFIG: /var/lib/geoprox/geoprox.toml
+      GEOPROX_HTTP_ADDR: 0.0.0.0
+      GEOPROX_HTTP_PORT: 5000
 
     ports:
-      - 5000:5000
+      - ${HOST_PORT:-5000}:5000
     volumes:
-      - ./geoprox.toml:/etc/geoprox/geoprox.toml:ro
+      - ./geoprox.toml:/var/lib/geoprox/geoprox.toml:ro
+      - ./snapshots/snapshot.bin:/var/lib/geoprox/snapshot.bin:z
 
   # Here is an example to generate just the OpenAPI spec
   geoprox-spec:
-    image: ezrasingh/geoprox:latest
+    image: ezrasingh/geoprox:${IMAGE_TAG:-latest}
     entrypoint: ['geoprox', 'spec' ]
     command: --destination /tmp --filename openapi.json --pretty
     volumes:

contrib/docker/quickstart/geoprox.toml

@@ -4,11 +4,23 @@
 http_addr = '0.0.0.0'
 # The port the server will listen on
 http_port = 5000
-# Timeout duration in seconds
-timeout = 10
+# Request timeout
+timeout = '10s'
 
 [shard]
 # Determines the default geohash length for inserts
 insert_depth = 6
 # Determines the default geohash length for searches
 search_depth = 6
+# Specifies the default number of results returned in range queries
+default_count = 100
+# Toggles the default sorting behavior for query results
+default_sorted = false
+
+[server.snapshots]
+# Toggle snapshot usage
+disabled = false
+# Directory where snapshots will be stored
+path = '/var/lib/geoprox'
+# How often snapshots will be taken
+every = '30s'

geoprox-server/CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Added support for TTL and key-expiration ([#15](https://github.com/ezrasingh/geoprox/issues/15)).
 - Added support for snapshots and persistence ([#17](https://github.com/ezrasingh/geoprox/issues/17)).
+- Using [`duration-string`](https://crates.io/crates/duration-string) crate to handle `Duration` configuration
 
 # 0.4.2
 

geoprox-server/src/api.rs

@@ -39,10 +39,13 @@ pub fn routes(app_state: AppState) -> Router {
 
     // ? background tasks
     purge_expirations(Arc::clone(&state), Duration::from_secs(1));
-    persist_snapshot(
-        Arc::clone(&state),
-        server_config.snapshot.every.unwrap_or_default().into(),
-    );
+
+    if !server_config.snapshots.disabled {
+        persist_snapshot(
+            Arc::clone(&state),
+            server_config.snapshots.every.unwrap_or_default().into(),
+        );
+    }
 
     Router::new()
         .nest(
@@ -164,7 +167,8 @@ mod test {
     fn setup() -> TestServer {
         let app = AppState::new(
             ServerConfig {
-                snapshot: SnapshotConfig {
+                snapshots: SnapshotConfig {
+                    disabled: false,
                     path: Some(current_dir().unwrap()),
                     every: None,
                 },

geoprox-server/src/app.rs

@@ -20,7 +20,7 @@ pub struct AppState {
 
 impl AppState {
     pub fn new(server_config: ServerConfig, shard_config: GeoShardConfig) -> Self {
-        match fs::read(server_config.snapshot.bin_path()) {
+        match fs::read(server_config.snapshots.bin_path()) {
             Ok(state) => Self {
                 geoshard: bincode::deserialize(&state).expect("could not restore snapshot"),
                 server_config,
@@ -36,7 +36,7 @@ impl AppState {
 
     pub fn store_snapshot(&self) {
         fs::write(
-            self.server_config.snapshot.bin_path(),
+            self.server_config.snapshots.bin_path(),
             bincode::serialize(&self.geoshard).unwrap(),
         )
         .expect("could not store snapshot");

geoprox-server/src/config.rs

@@ -6,11 +6,14 @@ use std::{
     time::Duration,
 };
 
-pub const DEFAULT_CONFIG_PATH: &str = "/etc/geoprox";
+pub const DEFAULT_CONFIG_PATH: &str = "/var/lib/geoprox";
 
 #[derive(Clone, Debug, Deserialize)]
 pub struct SnapshotConfig {
-    /// Directory where snapshots will be stored and read from (default /etc/geoprox/)
+    /// Toggles snapshot usage
+    #[serde(default)]
+    pub disabled: bool,
+    /// Directory where snapshots will be stored and read from (default /var/lib/geoprox)
     pub path: Option<PathBuf>,
     /// Determines how often snapshots will be taken (default 60s)
     pub every: Option<DurationString>,
@@ -29,6 +32,7 @@ impl SnapshotConfig {
 impl Default for SnapshotConfig {
     fn default() -> Self {
         Self {
+            disabled: false,
             path: Some(PathBuf::from(DEFAULT_CONFIG_PATH)),
             every: Some(DurationString::default()),
         }
@@ -44,7 +48,7 @@ pub struct ServerConfig {
     /// Timeout duration in seconds (default 10s)
     pub timeout: Option<DurationString>,
     /// Determines how snapshots will be handled
-    pub snapshot: SnapshotConfig,
+    pub snapshots: SnapshotConfig,
 }
 
 impl ServerConfig {
@@ -58,7 +62,7 @@ impl Default for ServerConfig {
             http_addr: Some(Self::DEFAULT_ADDR),
             http_port: Some(Self::DEFAULT_PORT),
             timeout: Some(DurationString::new(Duration::from_secs(10))),
-            snapshot: SnapshotConfig::default(),
+            snapshots: SnapshotConfig::default(),
         }
     }
 }

geoprox/CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+- Improved default config behavior
+
 ## 0.4.2
 
 - Added support for environment variables ([#6](https://github.com/ezrasingh/geoprox/issues/6)).

geoprox/README.md

@@ -65,7 +65,7 @@ geoprox help encode
 
 ## Configuration
 
-Geoprox allows specifying a configuration file using the `-c` or `--config` option or set the `GEOPROX_CONFIG` environment variable. This file can contain various settings to customize the behavior of the Geoprox server and commands. The configuration can be provided in any common format such as `YAML`, `TOML`, `JSON`, or `INI`.
+Geoprox allows specifying a configuration file using the `-c` or `--config` option or set the `GEOPROX_CONFIG` environment variable. This file can contain various settings to customize the behavior of the Geoprox server and commands. The configuration can be provided in any common format such as `YAML`, `TOML`, `JSON`, or `INI`. By default, configurations are expected to be found under `/var/lib/geoprox`.
 
 ### Example Config
 
@@ -78,8 +78,8 @@ Here's an example configuration file in `TOML` format:
 http_addr = '0.0.0.0'
 # The port the server will listen on
 http_port = 5000
-# Timeout duration in seconds
-timeout = 10
+# Request timeout
+timeout = '10s'
 
 [shard]
 # Determines the default geohash length for inserts
@@ -90,17 +90,25 @@ search_depth = 6
 default_count = 100
 # Toggles the default sorting behavior for query results
 default_sorted = false
+
+[server.snapshots]
+# Toggle snapshot usage
+disabled = false
+# Directory where snapshots will be stored
+path = '/var/lib/geoprox'
+# How often snapshots will be taken
+every = '30s'
 ```
 
 #### Environment Variables
 
 These are the currently supported environment variables. They will take precedence over settings defined in the configuration file.
 
-| Environment Variable | Description                            | Default Value               |
-| -------------------- | -------------------------------------- | --------------------------- |
-| `GEOPROX_CONFIG`     | Specifies the configuration file path. | `/etc/geoprox/geoprox.toml` |
-| `GEOPROX_HTTP_ADDR`  | The address the server will bind to.   | `0.0.0.0`                   |
-| `GEOPROX_HTTP_PORT`  | The port the server will listen on.    | `5000`                      |
+| Environment Variable | Description                            | Default Value                                             |
+| -------------------- | -------------------------------------- | --------------------------------------------------------- |
+| `GEOPROX_CONFIG`     | Specifies the configuration file path. | `/var/lib/geoprox/geoprox.{toml,yaml,json,ini,ron,json5}` |
+| `GEOPROX_HTTP_ADDR`  | The address the server will bind to.   | `0.0.0.0`                                                 |
+| `GEOPROX_HTTP_PORT`  | The port the server will listen on.    | `5000`                                                    |
 
 ## Fine Tuning
 

geoprox/src/cli.rs

@@ -1,15 +1,15 @@
 use clap::{ArgAction, Parser, Subcommand};
 use config::{Config, ConfigError};
 use geoprox_core::models::GeoShardConfig;
-use geoprox_server::config::ServerConfig;
+use geoprox_server::config::{ServerConfig, DEFAULT_CONFIG_PATH};
 use serde::Deserialize;
 use std::net::IpAddr;
 use std::path::PathBuf;
 
 #[derive(Parser)]
 #[command(version, about, long_about = None)]
 pub struct Cli {
-    /// Specify a config file
+    /// Specify a config file (defaults /var/lib/geoprox/geoprox.{toml,yaml,json,ini,ron,json5})
     #[arg(short, long, value_name = "CONFIG", env = "GEOPROX_CONFIG")]
     config: Option<PathBuf>,
 
@@ -22,11 +22,11 @@ pub enum Commands {
     /// Start Geoprox server
     Run {
         /// The address the server will bind to
-        #[arg(short, long, default_value = "0.0.0.0", env = "GEOPROX_HTTP_ADDR")]
+        #[arg(short, long, default_value_t = ServerConfig::DEFAULT_ADDR, env = "GEOPROX_HTTP_ADDR")]
         addr: IpAddr,
 
         /// The port the server will listen on
-        #[arg(short, long, default_value_t = 5000, env = "GEOPROX_HTTP_PORT")]
+        #[arg(short, long, default_value_t = ServerConfig::DEFAULT_PORT, env = "GEOPROX_HTTP_PORT")]
         port: u16,
     },
 
@@ -59,8 +59,8 @@ pub enum Commands {
         destination: Option<PathBuf>,
 
         /// Name of the output file (defaults to openapi.json)
-        #[arg(short, long)]
-        filename: Option<String>,
+        #[arg(short, long, default_value = "openapi.json")]
+        filename: String,
 
         /// Output the API specification to standard output (stdout)
         #[arg(short, long, action=ArgAction::SetTrue)]
@@ -87,7 +87,12 @@ pub fn runtime() -> Result<(Option<Commands>, GeoproxConfig), ConfigError> {
             .build()?
             .try_deserialize()?,
         None => Config::builder()
-            .add_source(config::File::with_name("/etc/geoprox/geoprox"))
+            .add_source(config::File::with_name(&format!(
+                // ?  look for geoprox.{toml,yaml,json,ini,ron,json5}
+                // ?  config under default config path
+                "{}/geoprox",
+                DEFAULT_CONFIG_PATH
+            )))
             .build()
             .unwrap_or_default()
             .try_deserialize()

geoprox/src/main.rs

@@ -44,8 +44,7 @@ fn main() {
                         .as_deref() // Convert &Option<PathBuf> to Option<&Path>
                         .unwrap_or(&cwd);
 
-                    let file_name = filename.as_deref().unwrap_or("openapi.json");
-                    dir.join(file_name)
+                    dir.join(filename)
                 };
                 // ? create the file and write the spec JSON to it
                 match std::fs::File::create(&file_path) {