diff --git a/.DS_Store b/.DS_Store index f2338631..fe0a7da5 100644 Binary files a/.DS_Store and b/.DS_Store differ diff --git a/getting-started.rst b/getting-started.rst index 39bd9398..98af196f 100644 --- a/getting-started.rst +++ b/getting-started.rst @@ -2,13 +2,11 @@ Getting Started ================= -Once you have Netmaker installed via the :doc:`Quick Install <./quick-start>` guide, you can use this Getting Started guide to help create and manage your first network. - .. toctree:: :maxdepth: 1 install - quick-start + manual-install netclient advanced-client-install server-installation diff --git a/install.rst b/install.rst index e47796ee..c408206e 100644 --- a/install.rst +++ b/install.rst @@ -2,23 +2,43 @@ Install ========= -IMPORTANT: Notes on Installation +Choose the install method that makes sense for you. + + +1. **We recommend using the nm-quick script for self-hosted/On-Prem setup.** + +.. code-block:: + + sudo wget -qO /root/nm-quick.sh https://raw.githubusercontent.com/gravitl/netmaker/master/scripts/nm-quick.sh && sudo chmod +x /root/nm-quick.sh && sudo /root/nm-quick.sh + +**IMPORTANT:** Notes on Installation - Due to the high volume of installations, the auto-generated domain has been rate-limited by the certificate provider. For this reason, we **strongly recommend** using your own domain. Using the auto-generated domain may lead to a failed installation due to rate limiting. +**IMPORTANT:** From v0.22.0 the install script will install PRO version of netmaker with a 30-day free trial, for you to try out full capabilities of netmaker. -Choose the install method that makes sense for you. +After trial period ends: +========================= + + a. if you wish to continue using PRO :- + + i. check these steps to obtain pro license ``_ + ii. Run `/root/nm-quick.sh -u` + + b. if you wish to downgrade to community version + + i. Run `/root/nm-quick.sh -d` + +2. **To get started the easiest way, visit our SaaS platform to set up a netmaker server with just a few clicks** ``_ -**For most users, we recommend the** :doc:`Quick Install<./quick-start>` **guide.** -`Trial, PoC, Testing, and Experimenting `_ +3. :doc:`check out these steps for manual installation process for on-prem, although we don't recommend this path, instead use the install script mentioned above<./manual-install>` -:doc:`Quick Install: for general small-to-medium use cases <./quick-start>` +4. :ref:`Kubernetes Installation ` -:ref:`Kubernetes Installation ` +5. :ref:`Non-Docker (from binary) Install ` -:ref:`Non-Docker (from binary) Install ` +6. :ref:`Highly Available Installation ` -:ref:`Highly Available Installation ` +7. :doc:`Advanced Install Resources <./server-installation>` -:doc:`Advanced Install Resources <./server-installation>` \ No newline at end of file diff --git a/quick-start.rst b/manual-install.rst similarity index 99% rename from quick-start.rst rename to manual-install.rst index 9b9a9625..70f9be59 100644 --- a/quick-start.rst +++ b/manual-install.rst @@ -1,5 +1,5 @@ =============== -Quick Install +Manual Install =============== Important Notes