see on GitHub

Setup Examples : AWS Windows VM

In this walkthrough we will setup RavenDB on an AWS EC2 t2.micro Windows virtual machine.

We will go through the necessary steps that are required for RavenDB to run securely including how to configure RavenDB with the correct IP addresses and ports.

It's recommended to read the Setup Wizard section where you can find a detailed explanation about the RavenDB setup process.

Create the VM

Access the EC2 Dashboard and click on Launch Instance.

1

Select your operating system. In our example we choose "Microsoft Windows Server 2012 R2 Base".

2

Select the machine type. We chose the t2.micro with 1 core and 1 GB of memory.

3

We stick with the basic default settings of the machine and configure just the minimal requirements for RavenDB. You would probably want to go over the entire set of options and customize your VM.

Security Concerns

The following settings are fine if you just want to experiment with RavenDB. However, when security is needed you should set proper firewall rules and restrict access by IP. Please visit the AWS security documentation for more information about securing your VM.

Elastic IP address

By default, in AWS, an instance is assigned an IP addresses through DHCP. When the DHCP lease expires, or you restart the instance, this IP is released back to the pool and you will have to re-configure the RavenDB IP address. To solve this problem, use an Elastic IP address which doesn't change, and can even be dynamically re-assigned to other instances as you wish.

Let's open ports 443 and 38888 for use by RavenDB. You may choose other port numbers of course and restrict access by IP. RavenDB will use port 443 for HTTPS requests and port 38888 for TCP connections. We allow all incoming traffic on these ports by using 0.0.0.0.

4

Review your settings and launch the VM.

5

You will have to download a key pair which will be used later to set the Windows password.

7

Wait a couple minutes for the machine to initialize and click connect.

9

Get your password and download the Remote Desktop File.

10

Connect to the VM. Use the username "Administrator" and the password you just received.

12

Configure the VM

Open the "Windows Defender Firewall with Advanced Security" and go to the "Inbound Rules" tab.

Create a new rule for TCP ports 443 and 38888 (or the ones you choose).

15 16 17 18

Now let's setup RavenDB.

First we need to download it.

Dowload Chrome. You will need to allow it in the Internet Explorer firewall.

20 21

Install the Visual C++ 2015 Redistributable Package (or newer).

19

Run the RavenDB Setup Wizard

Download RavenDB and extract it to a path of your choice (e.g. C:\Raven4).

Write Permissions

RavenDB requires write permissions to the following locations:

  • The folder where RavenDB server is running
  • The data folder
  • The logs folder

If you intend to run as a service, the write permissions should be granted to the user running the service (e.g. "Local Service").

22

You have a few choices on how to run the RavenDB server. We will use the Setup Wizard, but you can also configure things manually.

Open PowerShell and navigate to the extracted RavenDB folder.

You can run the server as a console application by running run.ps1. In this example we will run it as a service by running setup-as-service.ps1. When running the ps1 script you will have to confirm that you trust it.

The service will be registered. The server will start and you will be redirected to the Setup Wizard.

23 24

Accept the agreement and choose the setup type you want to do. In the example we choose to setup securely with a Let's Encrypt certificate.

You will need to claim your domain, read more here.

When you reach the point where you have to enter the IP addresses, you can go to the EC2 management console and check the machine's IP addresses.

25

Choose the Private IP address here.

27

Check the External IP box and enter the public IP address. Then start the installation.

If you encounter errors during the process, please visit the FAQ section.

29

When the setup is finished you will receive a configuration ZIP file which contains an admin client certificate which will allow you to connect using the browser. Keep the file safe.

Restart the server.

Access the Studio

30

Some environments (like this one) don't allow you to set the client certificate automatically in the setup wizard so if you are not redirected to the Studio and you get an authentication error, please close all instances of Chrome and install the admin client certificate manually. Double click on the certificate (from the extracted configuration ZIP file) and click next all the way through. It will add it to the OS user certificates store.

32 33

Now you can access the Studio. Open Chrome and enter your new domain (e.g. https://a.tutorial.ravendb.community).

Chrome will let you select the certificate.

34 36

Access the certificate view to see both the loaded server certificate and the admin client certificate. Make sure to read the security section for better understanding of certificates and security issues.

37

If you want to access the RavenDB CLI, first find out the RavenDB process number in the Task Manager and then open PowerShell and navigate to the server folder. Run the following command using the rvn tool.

./rvn.exe admin-channel <pid>

40 41

Congratulations! You have a secure RavenDB server running on a simple EC2 machine.

Connecting a few servers in a cluster is easy. Follow these instructions to construct a cluster during setup.