diff --git a/docs/generate-toc.py b/docs/generate-toc.py index 49c3a594..018fa489 100755 --- a/docs/generate-toc.py +++ b/docs/generate-toc.py @@ -85,36 +85,36 @@ TOC = [ Page("Getting Started", "tutorial/getting_started.md"), Page( "Environmental Considerations", - "tutorial/subs/environment_consideration.md", - ), - Page("System Preparation", "tutorial/subs/system_preparation.md"), - Page( - "Installing for Development", - "tutorial/subs/install_for_development.md", + "tutorial/environment_consideration.md", ), + Page("System Preparation", "tutorial/system_preparation.md"), Page( "Installing for Production", - "tutorial/subs/install_for_production_use.md", + "tutorial/install_for_production_use.md", + ), + Page( + "Installing for Development", + "tutorial/install_for_development.md", ), Page( "Special instructions for CentOS7 users", - "tutorial/subs/special_for_centos7.md", + "tutorial/special_for_centos7.md", ), - Page("Your First Email", "tutorial/subs/your_first_email.md"), + Page("Your First Email", "tutorial/your_first_email.md"), Page( "Beyond Basics", "tutorial/beyond_basics.md", children=[ - Page("Configuring DKIM", "tutorial/subs/dkim.md"), - Page("Configuring TLS", "tutorial/subs/tls.md"), + Page("Configuring DKIM", "tutorial/dkim.md"), + Page("Configuring TLS", "tutorial/tls.md"), ], ), Page( "Advanced Configurations", "tutorial/advanced_config.md", children=[ - Page("Lua Resources", "tutorial/subs/lua_resources.md"), - Page("Lua Functions", "tutorial/subs/lua_functions.md"), + Page("Lua Resources", "tutorial/lua_resources.md"), + Page("Lua Functions", "tutorial/lua_functions.md"), ], ), ], diff --git a/docs/tutorial/subs/dkim.md b/docs/tutorial/dkim.md similarity index 100% rename from docs/tutorial/subs/dkim.md rename to docs/tutorial/dkim.md diff --git a/docs/tutorial/subs/environment_consideration.md b/docs/tutorial/environment_consideration.md similarity index 93% rename from docs/tutorial/subs/environment_consideration.md rename to docs/tutorial/environment_consideration.md index f4a1dbe5..6a6c0751 100644 --- a/docs/tutorial/subs/environment_consideration.md +++ b/docs/tutorial/environment_consideration.md @@ -6,7 +6,8 @@ KumoMTA is a performance MTA that will leverage every bit of power you provide. ## Operating Systems -So far this is tested on Rocky (8), Alma (8), OpenSuse Leap (15.4), Ubuntu (22), ... +So far this is tested on Rocky (8,9), Alma (8,9), OpenSuse Leap (15.4), Ubuntu (22), AL2, CentOS7, ... +It has been deployed in AWS, Azure, GCP, VMWare and bare metal. ## RAM and Storage diff --git a/docs/tutorial/getting_started.md b/docs/tutorial/getting_started.md index 2872782d..68c26a2e 100644 --- a/docs/tutorial/getting_started.md +++ b/docs/tutorial/getting_started.md @@ -12,8 +12,8 @@ If you have no idea what an MTA is then [this may be a good primer](https://en.w That depends. -- If you just want to _use_ it to send email, follow the instructions to [**Install For Production Use**](./subs/install_for_production_use.md). -- If you want to experiment, contrubute, or hack stuff up, follow the instructions to [**Install For Development**](./subs/install_for_development.md). +- If you just want to _use_ it to send email, follow the instructions to [**Install For Production Use**](./install_for_production_use.md). +- If you want to experiment, contrubute, or hack stuff up, follow the instructions to [**Install For Development**](./install_for_development.md). ## What's next? diff --git a/docs/tutorial/subs/install_for_development.md b/docs/tutorial/install_for_development.md similarity index 93% rename from docs/tutorial/subs/install_for_development.md rename to docs/tutorial/install_for_development.md index c9fe3aa1..67577895 100644 --- a/docs/tutorial/subs/install_for_development.md +++ b/docs/tutorial/install_for_development.md @@ -2,7 +2,7 @@ ## Prepare your environment -Read the [Environmental considerations](https://github.com/kumomta/kumomta/blob/main/docs/guide/subs/environment_consideration.md) before proceeding. You will need a suitably sized server with all of the prerequisites in order to be successful. +Read the [Environmental considerations](https://github.com/kumomta/kumomta/blob/main/docs/tutorial/environment_consideration.md) before proceeding. You will need a suitably sized server with all of the prerequisites in order to be successful. ## Step by Step @@ -30,9 +30,9 @@ This is long and complicated and only relevent if you plan to use Cento7 AND nee If that describes you, then you can follow this to prepage your system, then come back to install Rust and the KumoMTA repo. -[Special Instructions for Centos7](https://github.com/kumomta/kumomta/blob/main/docs/guide/subs/special_for_centos7) +[Special Instructions for Centos7](https://github.com/kumomta/kumomta/blob/main/docs/tutorial/special_for_centos7) -If you just want to run it in CentOS7, we built and RPM for you [on this page](https://github.com/kumomta/kumomta/blob/main/docs/guide/subs/install_for_production_use.md). +If you just want to run it in CentOS7, we built and RPM for you [on this page](https://github.com/kumomta/kumomta/blob/main/docs/tutorial/install_for_production_use.md). ### In Ubuntu diff --git a/docs/tutorial/subs/install_for_production_use.md b/docs/tutorial/install_for_production_use.md similarity index 100% rename from docs/tutorial/subs/install_for_production_use.md rename to docs/tutorial/install_for_production_use.md diff --git a/docs/tutorial/subs/lua_functions.md b/docs/tutorial/lua_functions.md similarity index 100% rename from docs/tutorial/subs/lua_functions.md rename to docs/tutorial/lua_functions.md diff --git a/docs/tutorial/subs/lua_resources.md b/docs/tutorial/lua_resources.md similarity index 100% rename from docs/tutorial/subs/lua_resources.md rename to docs/tutorial/lua_resources.md diff --git a/docs/tutorial/subs/special_for_centos7.md b/docs/tutorial/special_for_centos7.md similarity index 100% rename from docs/tutorial/subs/special_for_centos7.md rename to docs/tutorial/special_for_centos7.md diff --git a/docs/tutorial/subs/system_preparation.md b/docs/tutorial/system_preparation.md similarity index 100% rename from docs/tutorial/subs/system_preparation.md rename to docs/tutorial/system_preparation.md diff --git a/docs/tutorial/subs/tls.md b/docs/tutorial/tls.md similarity index 100% rename from docs/tutorial/subs/tls.md rename to docs/tutorial/tls.md diff --git a/docs/tutorial/subs/your_first_email.md b/docs/tutorial/your_first_email.md similarity index 100% rename from docs/tutorial/subs/your_first_email.md rename to docs/tutorial/your_first_email.md