Skip to content

Commit

Permalink
Merge pull request #270 from gravitl/develop
Browse files Browse the repository at this point in the history
Install docs cleanup (#269)
  • Loading branch information
abhishek9686 authored Jan 24, 2024
2 parents 6e0a6e4 + e8bd566 commit 8e480d5
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 13 deletions.
Binary file modified .DS_Store
Binary file not shown.
4 changes: 1 addition & 3 deletions getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
38 changes: 29 additions & 9 deletions install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<https://docs.netmaker.io/quick-start.html#extra-steps-for-pro>`_
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** `<https://app.netmaker.io>`_

**For most users, we recommend the** :doc:`Quick Install<./quick-start>` **guide.**

`Trial, PoC, Testing, and Experimenting <https://github.com/gravitl/netmaker/tree/master#get-started-in-5-minutes>`_
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 <KubeInstall>`

:ref:`Kubernetes Installation <KubeInstall>`
5. :ref:`Non-Docker (from binary) Install <NoDocker>`

:ref:`Non-Docker (from binary) Install <NoDocker>`
6. :ref:`Highly Available Installation <HAInstall>`

:ref:`Highly Available Installation <HAInstall>`
7. :doc:`Advanced Install Resources <./server-installation>`

:doc:`Advanced Install Resources <./server-installation>`
2 changes: 1 addition & 1 deletion quick-start.rst → manual-install.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
===============
Quick Install
Manual Install
===============

Important Notes
Expand Down

0 comments on commit 8e480d5

Please sign in to comment.