You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documentation/5.1/Raven.Documentation.Pages/start/installation/setup-wizard.markdown
+57-36Lines changed: 57 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,31 +1,38 @@
1
1
# Installation: Setup Wizard Walkthrough
2
2
3
-
4
-
* We want to make it as easy as possible for you to start RavenDB with a valid, trusted server certificate from the beginning.
5
-
This will ensure that your servers are secure throughout your application lifecycle.
6
-
7
-
* Setting up securely will create a development environment that includes security related features such as encryption and client certificates.
8
-
This way, such features won't be missing when you launch, and there will be less bugs caused by code that needs to be adapted to
9
-
security features that must be added later.
10
-
11
-
* To make the setup process as smooth as possible, we have introduced the **Setup Wizard**,
12
-
a step-by-step guide to help you configure the desired security level and easily deploy a secure cluster.
13
-
14
-
* Using the Setup Wizard you can set up a secure cluster with:
15
-
***Let's Encrypt certificate** - Using the Wizard with "Let's Encrypt" will enable RavenDB's automatic certificate renewals.
16
-
***Self-obtained certificate** - You are responsible for periodic certificate renewals.
17
-
* Or choose to continue in an **unsecure mode**.
18
-
19
-
* Note: The RavenDB server can also be **set up manually** if choosing not to use the wizard.
20
-
See [Manual Setup](../../start/installation/manual).
21
-
22
-
* Note: this page explains how to follow the Setup Wizard, without going into security concerns details.
23
-
To learn more about how _Authentication_ and _Authorization_ are implemented with RavenDB, and about _Security_ in general,
24
-
go to [Security Overview](../../server/security/overview).
25
-
26
-
* If you are having trouble using the wizard, or with security in general, please visit the [Security Common Errors & FAQ](../../Server/Security/common-errors-and-faq) section.
3
+
* The **Setup Wizard** guides you through a step-by-step installation of a RavenDB server.
4
+
5
+
* You can use the wizard to install either a **secure** or an **unsecure** server.
6
+
* An **unsecure server** can be used for **trial and development**, providing there
7
+
is no issue with unauthorized access to the server and the data stored in it.
8
+
* It is **highly recommended** to use a **secure server** wherever access to the
9
+
server, its management, or its data should be restricted.
10
+
* You will also need a secure server in a development environment that requires
11
+
the usage of security related features like encryption and client certificates.
12
+
13
+
* When installing a secure server, connecting it will thereafter be possible only
14
+
for clients that own a valid, trusted certificate.
15
+
To secure the server throughout its lifecycle, you can provide a suitable certificate
16
+
during setup. The setup wizard allows you to either -
17
+
* Generate and use a **Let's Encrypt certificate**,
18
+
saving you the bother of providing your own certificate, and making it possible
19
+
for RavenDB to renewal the certificate automatically from now on,
20
+
* -or- Provide a **self-obtained certificate**,
21
+
leaving you responsible for periodic certificate renewals.
22
+
23
+
{INFO: Additional resources}
24
+
25
+
* This page explains how to follow the setup wizard, without going into security concerns details.
26
+
Learn more about _authentication_, _authorization_, and _security_ in RavenDB in:
Copy file name to clipboardExpand all lines: Documentation/5.2/Raven.Documentation.Pages/server/configuration/license-configuration.markdown
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,10 @@
2
2
3
3
{PANEL:License}
4
4
5
-
* When using this configuration key in _settings.json_ embed the license key as a __string__, e.g.:
5
+
* When using this configuration key in _settings.json_ embed the license key as a **string**, e.g.:
6
6
`"License": "{ paste your license key including curly brackets here }"`.
7
7
8
-
* When using this configuration key as an [environment variable](../../server/configuration/configuration-options#environment-variables) embed the JSON license key __object__.
8
+
* When using this configuration key as an [environment variable](../../server/configuration/configuration-options#environment-variables) embed the JSON license key **object**.
9
9
10
10
* If `License` is specified, it overrides the `License.Path` configuration.
11
11
@@ -22,10 +22,10 @@
22
22
Save the license key to a `license.json` file.
23
23
Provide the path to this file in the 'License.Path' configuration key:
24
24
25
-
* Either the __full__ path to the license file, e.g.:
25
+
* Either the **full** path to the license file, e.g.:
0 commit comments