From 058d92e100664d96c49c259108256dea86dda610 Mon Sep 17 00:00:00 2001 From: vlw Date: Thu, 7 Aug 2025 08:34:01 +0200 Subject: [PATCH] doc(fix): fixed typos and misses --- README.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6f78b38..88f053f 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,14 @@ A MariaDB or MySQL server with at least `SELECT` rights granted to a database ta # Get started 1. Create a git repository for your project. 2. Create a new empty MariaDB/MySQL database table. -3. Run this command from the root directory of your local repository. +3. Run this command from the root directory of your project. ```sh curl -fsSL https://codeberg.org/reflect/install/raw/branch/master/install.sh | bash ``` +4. Follow the steps in the installer. That's it! + # Arguments You can pass optional named arguments to this script for headless installation of Reflect. @@ -33,7 +35,7 @@ Pass `--overwrite=y` to overwrite all existing Reflect configuration files. ``` Pass a `--dir` argument with a value of a directory Reflect should consider its [`root_path`](https://reflect.vlw.se/docs/Reference/Env#root_path). -### `--endpoints` - Overwrite configuration files +### `--endpoints` - Reflect endpoint directory ```sh ./install.sh --endpoints="api" ``` @@ -45,7 +47,7 @@ Pass an `--endpoints` argument with a value of a directory relative to [`root_pa ```sh ./install.sh --db="reflect" ``` -Pass a `--db` argument with a value of a database table that Reflect should use. +Pass a `--db` argument with a value of a database table that Reflect should use when connecting to you MariaDB/MySQL server. ### `--host` - Reflect database hostname ```sh @@ -59,12 +61,13 @@ Pass a `--host` argument with a value of a fully qualified hostname that Reflect ``` Pass a `--user` argument with a value of a username that Reflect should use when connecting to you MariaDB/MySQL server. -### `--password` - Reflect database user +### `--password` - Reflect database password ```sh ./install.sh --password="mypassword" ``` Pass a `--password` argument with a value of a password that Reflect should use when connecting to you MariaDB/MySQL server. +#### Disable password authentication ```sh ./install.sh --password=null ``` @@ -72,30 +75,25 @@ Pass "null" to this argument to disable password authentication ### Database seeding -### `--db` - Reflect database table -```sh -./install.sh --db="reflect" -``` -Pass a `--db` argument with a value of a database table that Reflect should use. - -### `--seed_host` - Reflect database hostname +### `--seed_host` - Database hostname for seeding ```sh ./install.sh --seed_host="/path/to/project" ``` Pass a `--host` argument with a value of a fully qualified hostname that will be used by this script to seed the database. -### `--seed_user` - Reflect database user +### `--seed_user` - Database user for seeding ```sh ./install.sh --seed_user="www-data" ``` Pass a `--user` argument with a value of a username that will be used by this script to seed the database. -### `--seed_password` - Reflect database user +### `--seed_password` - Database password for seeding ```sh ./install.sh --seed_password="mypassword" ``` Pass a `--password` argument with a value of a password that will be used by this script to seed the database. +#### Disable password authentication ```sh ./install.sh --seed_password=null ```