Skip to content

Commit 06c43c4

Browse files
authored
Update Pro setup docs (#304)
* initial push * update * updated-images-and-instructions * Update pro-setup.rst * Update advanced-client-install.rst * Update pro-setup.rst * Update advanced-client-install.rst * Update advanced-client-install.rst * Update advanced-client-install.rst * moved-netclient-firewall-settings-guide-to-netclient-page * fixed-som-typos-and-removed-fw-settings
1 parent d289703 commit 06c43c4

15 files changed

+63
-17
lines changed

pro/images/14-day-trial.jpg

103 KB
Loading

pro/images/billing-info-form.jpg

72.3 KB
Loading

pro/images/missed-profile-info.jpg

107 KB
Loading

pro/images/payment-method-form.jpg

76.7 KB
Loading

pro/images/pricing-and-limits.jpg

91.1 KB
Loading

pro/images/pro-aftersignup.jpg

63.6 KB
Loading

pro/images/pro-aftersignup.png

24.2 KB
Loading

pro/images/pro-license-key2.jpg

90.3 KB
Loading

pro/images/pro-new-dashboard.jpg

93.8 KB
Loading
Loading
106 KB
Loading
36.5 KB
Loading

pro/images/tenant-name-form.jpg

39.6 KB
Loading

pro/images/tenants-list-page.jpg

44.8 KB
Loading

pro/pro-setup.rst

+63-17
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,87 @@
22
Netmaker Professional Setup
33
===========================
44

5-
This guide covers how to get setup with Netmaker Professional. For pricing,visit `our pricing page <https://www.netmaker.io/pricing>`_
5+
This guide covers how to get setup with Netmaker Professional. For pricing, visit `our pricing page <https://www.netmaker.io/pricing>`_
66

77

88
Get a License
99
=================================
1010

11-
Visit `<https://app.netmaker.io>`_ to set up a self-hosted instance on the Netmaker SAAS platform. When you first visit the site, you should be prompted to create an account. After you make one, you will be automatically directed to the switch tenant dashboard.
11+
Signup here `<https://account.netmaker.io/signup>`_ to get a license for your self-hosted Netmaker. Never miss to input your Firstname and Lastname.
1212

13-
.. image:: images/pro-aftersignup.png
13+
.. image:: images/profile-form-after-signup---regular-email.jpg
1414
:width: 80%
15-
:alt: screeen after signup on SAAS
15+
:alt: Profile form after signup on SAAS with regular email
1616
:align: center
1717

18+
|
1819
19-
Click the `` create tenant `` button and a modal will pop up. If you are a new user you can follow the link to setup a self hosted instance of Netmaker for a free 14 day trial, for existing users click on the contact us link.
20+
.. image:: images/profile-form-after-signup---sso.jpg
21+
:width: 80%
22+
:alt: Profile form after signup on SAAS with SSO
23+
:align: center
24+
25+
When you login to the site for the first time, normally you will be automatically directed to the tenant creation modal as shown in the first image below. But if, for some reason, you happen to have missed inputting your Firstname and Lastname after signing up, the Profile page will show up instead. Click on the [>] icon to expand the Profile form where you can input your profile info. This is required when creating tenants.
26+
27+
.. image:: images/pro-aftersignup.jpg
28+
:width: 80%
29+
:alt: screen after first login on SAAS
30+
:align: center
2031

21-
.. image:: images/pro-createtenantmodal.png
32+
|
33+
34+
.. image:: images/missed-profile-info.jpg
2235
:width: 80%
23-
:alt: selfhosted switch
36+
:alt: screen after first login on SAAS - missed profile info
2437
:align: center
2538

26-
After you click on the link, you will be taken to a page to fill out a licence request form. A representative will reach out to you to get you setup with a self-hosted tenant.
39+
For first time users Netmaker offers a free 14-day trial of the Professional plan of either a SaaS tenant or an On-Prem tenant. Click on the "Create an On-Prem tenant" option. Input the name of your new tenant then click on the Next button.
2740

28-
.. image:: images/pro-contactusform.png
41+
.. image:: images/tenant-name-form.jpg
2942
:width: 80%
30-
:alt: selfhosted switch
43+
:alt: Tenant name form
3144
:align: center
3245

33-
Once you have your tenant, you can click on manage account from the tenants table. Then you will need to add payment details before you can use your tenant, click on the stripe button to go to the stripe page and enter your payment info.
46+
47+
You can toggle between a Monthly or a Yearly subscription plan for when your trial period ends. Click on the "Tier breakdown" button to view the details of the plan. Once you're done, click on the "Add Payment Details in Stripe" button.
48+
49+
.. image:: images/pricing-and-limits.jpg
50+
:width: 80%
51+
:alt: Pricing and Limits
52+
:align: center
53+
54+
55+
Like many cloud service providers, payment information is required in order to create resources even during trial period. This can be in a form of Debit/Credit card information or a US Bank account. Fillout the form and then click on the "Add" button.
56+
57+
.. image:: images/payment-method-form.jpg
58+
:width: 80%
59+
:alt: Payment Method Form
60+
:align: center
61+
62+
63+
You should automatically be redirected back to the tenant creation modal. Review your new tenant details then click on the Create Tenant button.
64+
65+
.. image:: images/review-tenant-details-form.jpg
66+
:width: 80%
67+
:alt: Review tenant details
68+
:align: center
69+
70+
71+
Once created, your new tenant should show up in the Tenants page. Click on the Manage Account button to view its details.
72+
73+
.. image:: images/tenants-list-page.jpg
74+
:width: 80%
75+
:alt: Tenants page
76+
:align: center
77+
78+
3479

3580
Setup your server
3681
=================================
3782

38-
You will need the licence key and tenant id from the settings page back at the account management page on the settings tab.
83+
You will need the Licence Key and the Tenant ID which are found on the Settings tab.
3984

40-
.. image:: images/pro-license-key2.png
85+
.. image:: images/pro-license-key2.jpg
4186
:width: 80%
4287
:alt: License keys
4388
:align: center
@@ -49,9 +94,10 @@ Once you have your license key and tenant ID, you can get the nm-quick installer
4994
5095
wget https://raw.githubusercontent.com/gravitl/netmaker/master/scripts/nm-quick.sh
5196
chmod +x nm-quick.sh
52-
bash nm-quick.sh
97+
bash nm-quick.sh -u
98+
99+
Follow the prompts for a pro edition server. provide the License Key and Tenant ID when prompted.
53100

54-
Follow the prompts for a pro edition server. provide the license key and tenant id when prompted.
55101

56102
Upgrade to Pro from Community Edition
57103
======================================
@@ -81,11 +127,11 @@ After that run the following command:
81127

82128
.. code-block::
83129
84-
docker kill netmaker netmaker-ui && docker-compose up -d
130+
docker kill netmaker netmaker-ui && docker compose up -d
85131
86132
When you browse to your self-hosted Netmaker via dashboard.<YOUR_BASE_DOMAIN>, you should see the professional UI and a new Dashboard. The top menu bar will have relays and metrics added.
87133

88-
.. image:: images/pro-new-dashboard.png
134+
.. image:: images/pro-new-dashboard.jpg
89135
:width: 80%
90136
:alt: new dashboard
91137
:align: center

0 commit comments

Comments
 (0)