forked from ravendb/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request ravendb#1414 from serezhub/RDoc-1712-Secure-Manual…
…-Setup RDoc-1712 - Secure Manual Setup
- Loading branch information
Showing
13 changed files
with
636 additions
and
157 deletions.
There are no files selected for viewing
178 changes: 153 additions & 25 deletions
178
...ntation.Pages/server/security/authentication/certificate-configuration.markdown
Large diffs are not rendered by default.
Oops, something went wrong.
Binary file added
BIN
+8.28 KB
...Pages/server/security/authentication/images/set-client-certificate-password.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+32 KB
...ion.Pages/server/security/authentication/images/snag/set-client-certificate-password.snag
Binary file not shown.
90 changes: 90 additions & 0 deletions
90
Documentation/4.2/Raven.Documentation.Pages/start/installation/manual.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
# Installation: Manual Setup | ||
|
||
{NOTE: Automatic Certificate Renewals Via Setup Wizard} | ||
|
||
RavenDB has developed a quick and simple process to set up a fully secure cluster with our Setup Wizard. | ||
We've developed automatic renewals of certificates when setting up with the Setup Wizard together with Let's Encrypt. | ||
|
||
If you choose manual setup and/or to provide your own certificate, **you are responsible for its periodic renewal**. | ||
|
||
{NOTE/} | ||
|
||
In this page: | ||
|
||
* [Downloading Server and Setting Up Node Folders](../../start/installation/manual#downloading-server-and-setting-up-node-folders) | ||
* [Disabling 'Setup Wizard'](../../start/installation/manual#disabling-setup-wizard) | ||
* [Server Url and Port](../../start/installation/manual#server-url-and-port) | ||
* [Security](../../start/installation/manual#security) | ||
* [Configuration](../../start/installation/manual#configuration) | ||
|
||
## Downloading Server and Setting Up Node Folders | ||
Download the [RavenDB server package](https://ravendb.net/download) and extract it into permanent server folders on each machine. | ||
|
||
We recommend using multiple machines to improve [cluster availability via failover](../../client-api/cluster/how-client-integrates-with-replication-and-cluster) in case one goes down. | ||
|
||
* Each folder that contains an extracted server package will become a functional node in your cluster. | ||
* If you move the folders after installation, **the server will not work**. | ||
You'll receive a 'System.InvalidOperationException: Unable to start the server.' error because it will look for the file path that is set when you install. | ||
|
||
By default, when a server is started using `run.ps1` (or `run.sh` in Linux) script. It will open a browser with a [Setup Wizard](../../start/installation/setup-wizard) which will guide you through the server configuration process. | ||
|
||
The setup is started because the default configuration file [settings.json](../../server/configuration/configuration-options#json) (found in the downloaded RavenDB Server package inside the **Server** folder) comes configured like this: | ||
|
||
{CODE-BLOCK:json} | ||
{ | ||
"ServerUrl": "http://127.0.0.1:0", | ||
"Setup.Mode": "Initial", | ||
"DataDir": "RavenData" | ||
} | ||
{CODE-BLOCK/} | ||
|
||
Which means that the Server will run: | ||
|
||
- On `localhost` with a `random port` | ||
- In `Setup Wizard` mode | ||
- Store the data in `RavenData` directory | ||
|
||
## Disabling 'Setup Wizard' | ||
|
||
To disable the 'Setup Wizard' please change the `Setup.Mode` in the settings.json configuration to `None` or remove it completely. | ||
|
||
## Server Url and Port | ||
|
||
Setting the `ServerUrl` to `http://127.0.0.1:0` will bind the server to a `localhost` with a `random port`. For manual setup we suggest changing the port to a non-random value - e.g. **8080**. | ||
|
||
{NOTE:Port in Use} | ||
|
||
In some cases the port might be in use, this will prevent the Server from starting with "address in use" error (`EADDRINUSE`). | ||
For a list of IPs and ports already in use on your machine, enter `netstat -a` in the command line. | ||
|
||
{NOTE/} | ||
|
||
## Security | ||
|
||
{WARNING: Protect Your Cluster From The Start} | ||
|
||
We highly recommend securing your server from the start to [prevent potential vulnerabilities](https://ravendb.net/articles/ravendb-secure-by-default-document-database) later. | ||
RavenDB makes securing your cluster from the start as easy as possible to prevent the possiblity of forgetting to secure before going into production. | ||
|
||
If you set RavenDB to listen to connections outside your local machine without first securing your cluster, | ||
your database will immediately block this now vulnerable configuration and require the administrator to properly setup the security and | ||
access control to prevent unauthorized access. | ||
|
||
{WARNING/} | ||
|
||
Read the [Manual Certificate Configuration](../../server/security/authentication/certificate-configuration) section to learn how to setup security manually. | ||
|
||
## Configuration | ||
|
||
Read the [Configuration Section](../../server/configuration/configuration-options) to learn more about using [settings.json](../../server/configuration/configuration-options#json) and see a list of configuration options. | ||
|
||
## Related articles | ||
|
||
### Installation | ||
|
||
- [Common Setup Wizard Errors and FAQ](../../server/security/common-errors-and-faq#setup-wizard-issues) | ||
- [Setup Wizard](../../start/installation/setup-wizard) | ||
|
||
### Security | ||
|
||
- [Security in RavenDB](../../server/security/overview) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file modified
BIN
-7.07 KB
(94%)
Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
-10.9 KB
(89%)
...cumentation.Pages/start/installation/images/setup/Certificate-Import-Wizard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+3.1 KB
(100%)
...ation.Pages/start/installation/images/setup/Complete-Existing-Cluster-Setup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+0 Bytes
(100%)
Documentation/5.1/Raven.Documentation.Pages/start/installation/images/setup/snag/10.snag
Binary file not shown.
Binary file modified
BIN
+0 Bytes
(100%)
...n.Documentation.Pages/start/installation/images/setup/snag/Certificate-Import-Wizard.snag
Binary file not shown.
Binary file modified
BIN
+0 Bytes
(100%)
...mentation.Pages/start/installation/images/setup/snag/Complete-Existing-Cluster-Setup.snag
Binary file not shown.
Oops, something went wrong.