Merge pull request #53 from CoLearn-Dev/default-params

Add default params for usability

Author: stneng

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "colink-server"
-version = "0.3.3"
+version = "0.3.4"
 edition = "2021"
 
 [dependencies]

Cargo.toml

@@ -4,7 +4,7 @@ CoLink provides a unified interface for the user, storage, communication, and co
 
 ## Preparations
 
-### Generate mTLS certificates
+### Generate mTLS certificates (optional)
 The CoLink server and the clients uses mTLS to communicate. In the repo, we included a set of [example certificates](https://github.com/CoLearn-Dev/colink-integration-test-dev/tree/main/example-tls/test-cert). **Please DO NOT use the example certificates in a production environment.**
 
 To generate the corresponding certificates for mTLS, you can use OpenSSL or CFSSL.
@@ -16,13 +16,13 @@ To generate the corresponding certificates for mTLS, you can use OpenSSL or CFSS
   - [mTLS](https://developers.cloudflare.com/cloudflare-one/identity/devices/mutual-tls-authentication/)
   - [GitHub repo](https://github.com/cloudflare/cfssl)
 
-### Set up RabbitMQ
+### Set up RabbitMQ (optional)
 - [Download and Installation](https://www.rabbitmq.com/download.html)
 - [Enable Management API](https://www.rabbitmq.com/management.html)
 - [Example Configuration](https://github.com/CoLearn-Dev/colink-integration-test-dev/blob/main/example-rabbitmq/rabbitmq.conf)
 
 ## Start CoLink server
-CoLink server requires a [message queue](#set-up-rabbitmq) as its building block. When starting the CoLink server, we need to specify MQ's URI and management API here. 
+CoLink server requires a message queue (RabbitMQ or Redis Stream) as its building block. When starting the CoLink server, we can specify MQ's URI and management API here (the default MQ is a built-in Redis). **Note: Redis mode does not support TLS for now. Please use RabbitMQ in production environments.**
 
 Use the following command to start the CoLink server
 ```
@@ -33,17 +33,21 @@ cargo run -- --address <address> --port <port> --mq-uri <mq uri> --mq-api <mq ap
 For the details about the parameters, please check [here](src/main.rs#L7).
 
 ### Example
+Minimal
+```bash
+cargo run
+```
 Without TLS
 ```bash
-cargo run -- --address 127.0.0.1 --port 8080 --mq-uri amqp://guest:guest@localhost:5672 --mq-api http://guest:guest@localhost:15672/api --core-uri http://127.0.0.1:8080
+cargo run -- --address 127.0.0.1 --port 2021 --mq-uri amqp://guest:guest@localhost:5672 --mq-api http://guest:guest@localhost:15672/api --core-uri http://127.0.0.1:2021
 ```
 TLS
 ```bash
-cargo run -- --address 127.0.0.1 --port 8080 --mq-uri <mq uri> --mq-api <mq api> --cert <path to server-fullchain.pem> --key <path to server-key.pem> --inter-core-ca <path to ca.pem>
+cargo run -- --address 127.0.0.1 --port 2021 --mq-uri <mq uri> --mq-api <mq api> --cert <path to server-fullchain.pem> --key <path to server-key.pem> --inter-core-ca <path to ca.pem>
 ```
 mTLS
 ```bash
-cargo run -- --address 127.0.0.1 --port 8080 --mq-uri <mq uri> --mq-api <mq api> --cert <path to server-fullchain.pem> --key <path to server-key.pem> --ca <path to ca.pem> --inter-core-ca <path to ca.pem> --inter-core-cert <path to client.pem> --inter-core-key <path to client-key.pem>
+cargo run -- --address 127.0.0.1 --port 2021 --mq-uri <mq uri> --mq-api <mq api> --cert <path to server-fullchain.pem> --key <path to server-key.pem> --ca <path to ca.pem> --inter-core-ca <path to ca.pem> --inter-core-cert <path to client.pem> --inter-core-key <path to client-key.pem>
 ```
 
 ## Test the server

README.md

@@ -7,11 +7,16 @@ use std::path::PathBuf;
 struct CommandLineArgs {
     /// Address of CoLink server
     // short and long flags (-d, --debug) will be deduced from the field's name
-    #[arg(short, long, env = "COLINK_SERVER_ADDRESS")]
+    #[arg(
+        short,
+        long,
+        env = "COLINK_SERVER_ADDRESS",
+        default_value = "127.0.0.1"
+    )]
     address: String,
 
     /// Port of CoLink server
-    #[arg(short, long, env = "COLINK_SERVER_PORT")]
+    #[arg(short, long, env = "COLINK_SERVER_PORT", default_value = "2021")]
     port: u16,
 
     /// URI of MQ (AMQP or Redis)
@@ -27,7 +32,11 @@ struct CommandLineArgs {
     mq_prefix: String,
 
     /// URI of CoLink server
-    #[arg(long, env = "COLINK_SERVER_CORE_URI")]
+    #[arg(
+        long,
+        env = "COLINK_SERVER_CORE_URI",
+        default_value = "http://127.0.0.1:2021"
+    )]
     core_uri: Option<String>,
 
     /// Path to server certificate.

src/main.rs

@@ -8,7 +8,7 @@ value = "true"
 operator_num = 1
 
 [registry]
-operator_num = 1
+operator_num = 0    # Disabled by default. If you wanted to connect to others, change it to 1.
 start_after = [ "policy_module", "remote_storage" ]
 [[registry.create_entry]]
 key_name = "_registry:init:default_registry_addr"