snowykami/meilisearch
1
0
Fork 0
mirror of https://github.com/meilisearch/meilisearch.git synced 2024-11-26 12:05:05 +08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

chore: add missing docs

Browse Source
This commit is contained in:
Jérome Eertmans 2022-10-05 19:04:33 +02:00
parent 4a022acd33
commit 6933ba54fb
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
meilisearch-http/src/option.rs
View File

@ -71,12 +71,12 @@ pub struct Opt {
#[serde(default = "default_db_path")] #[serde(default = "default_db_path")]
pub db_path: PathBuf, pub db_path: PathBuf,
/// The address on which the http server will listen. /// Sets the HTTP address and port Meilisearch will use.
#[clap(long, env = MEILI_HTTP_ADDR, default_value_t = default_http_addr())] #[clap(long, env = MEILI_HTTP_ADDR, default_value_t = default_http_addr())]
#[serde(default = "default_http_addr")] #[serde(default = "default_http_addr")]
pub http_addr: String, pub http_addr: String,
/// Sets the instance's master key, automatically protecting all routes except GET /health /// Sets the instance's master key, automatically protecting all routes except `GET /health`.
#[serde(skip_serializing)] #[serde(skip_serializing)]
#[clap(long, env = MEILI_MASTER_KEY)] #[clap(long, env = MEILI_MASTER_KEY)]
pub master_key: Option<String>, pub master_key: Option<String>,
@ -128,8 +128,9 @@ pub struct Opt {
#[clap(long, env = MEILI_SSL_AUTH_PATH, parse(from_os_str))] #[clap(long, env = MEILI_SSL_AUTH_PATH, parse(from_os_str))]
pub ssl_auth_path: Option<PathBuf>, pub ssl_auth_path: Option<PathBuf>,
/// Read DER-encoded OCSP response from OCSPFILE and staple to certificate. /// Sets the server's OCSP file. *Optional*
/// Optional ///
/// Reads DER-encoded OCSP response from OCSPFILE and staple to certificate.
#[serde(skip_serializing)] #[serde(skip_serializing)]
#[clap(long, env = MEILI_SSL_OCSP_PATH, parse(from_os_str))] #[clap(long, env = MEILI_SSL_OCSP_PATH, parse(from_os_str))]
pub ssl_ocsp_path: Option<PathBuf>, pub ssl_ocsp_path: Option<PathBuf>,
@ -217,7 +218,7 @@ pub struct Opt {
#[serde(default)] #[serde(default)]
pub ignore_dump_if_db_exists: bool, pub ignore_dump_if_db_exists: bool,
/// Folder where dumps are created when the dump route is called. /// Sets the directory where Meilisearch will create dump files.
#[clap(long, env = MEILI_DUMPS_DIR, default_value_os_t = default_dumps_dir())] #[clap(long, env = MEILI_DUMPS_DIR, default_value_os_t = default_dumps_dir())]
#[serde(default = "default_dumps_dir")] #[serde(default = "default_dumps_dir")]
pub dumps_dir: PathBuf, pub dumps_dir: PathBuf,
@ -243,7 +244,7 @@ pub struct Opt {
#[clap(flatten)] #[clap(flatten)]
pub scheduler_options: SchedulerConfig, pub scheduler_options: SchedulerConfig,
/// The path to a configuration file that should be used to setup the engine. /// Set the path to a configuration file that should be used to setup the engine.
/// Format must be TOML. /// Format must be TOML.
#[serde(skip_serializing)] #[serde(skip_serializing)]
#[clap(long)] #[clap(long)]