Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ b. **Upload** ([import](../../../server/security/authentication/certificate-mana

![Importing and Exporting Certificates](./assets/importing-and-exporting-certificate.png)

1. Click **Manage Server** and select **Certificates** to access the Studio - Certificates Management screen.
1. Click **Manage Server** and select **Certificates** to access Studio - Certificates Management screen.
2. Click **Server certificates** in the source server.
![Server Certificates Button Options](./assets/server-certificates-button-options.png)
* **Export server certificates**
Expand Down Expand Up @@ -353,7 +353,7 @@ When uploading a `.pfx` file with multiple certificates, RavenDB will add all of
and will allow access to all these certificates explicitly by their thumbprint.
### Generating Client Certificates Via Command Line Interface

* RavenDB provides an intuitive certificates management GUI in the Studio.
* RavenDB provides an intuitive certificates management GUI in Studio.

* All of the operations which are described below are also available in Command Line Interface (CLI).
- Be sure to configure the `SecurityClearance` for each client certificate because the default is [cluster admin](../../../server/security/authorization/security-clearance-and-permissions.mdx#cluster-admin) which has full access.
Expand Down Expand Up @@ -385,7 +385,7 @@ and is explained here only to show how to view the full chain in Windows. The ri

![Figure 7. Client Certificate Chain](./assets/client-cert.png)

Because client certificates are managed by RavenDB directly and not through any PKI infrastructure **this is perfectly acceptable**.
Because client certificates are managed by RavenDB directly and [not through any PKI infrastructure](../overview.mdx#important) **this is perfectly acceptable**.
Authenticating a client certificate is done explicitly by looking for the thumbprint in the registered certificates list in the server
and not by validating the chain of trust.

Expand Down
4 changes: 2 additions & 2 deletions docs/server/security/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ Registering a certificate means one of the following:
* The certificate was registered explicitly by an administrator.
* The certificate was registered implicitly for having the same [Public Key Pinning Hash](authentication/certificate-renewal-and-rotation.mdx#implicit-trust-by-public-key-pinning-hash) as a registered certificate.

In any case, it must appear in the certificates view in the studio. Visit the [Certificate Management](authentication/certificate-management.mdx) section for more information.
In any case, it must appear in the certificates view in Studio. Visit the [Certificate Management](authentication/certificate-management.mdx) section for more information.
</Admonition>

In the Studio, administrators can use the [Certificates View](../../server/security/authentication/certificate-configuration.mdx) to easily manage their certificates. It can be used to generate client certificates, register existing client certificates, import and export server certificates, rename, assign permissions and more.
In Studio, administrators can use the [Certificates View](../../server/security/authentication/certificate-configuration.mdx) to easily manage their certificates. It can be used to generate client certificates, register existing client certificates, import and export server certificates, rename, assign permissions and more.

**Read more:**

Expand Down
13 changes: 13 additions & 0 deletions docs/start/installation/setup-wizard/configure-node-addresses.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,20 @@ import Panel from '@site/src/components/Panel';
Enter the private HTTPS port that the node will listen on (used by clients and browsers to connect to this server).
By default, this is set to `443`.
When using port 443, make sure it is not already used by other applications (such as IIS, Apache, Skype, etc.).
<Admonition type="note" title="">

On Linux, you might need to allow non-root processes to listen on port 443.
Run the following command to grant the server permission to bind to privileged ports:

```bash
sudo setcap CAP_NET_BIND_SERVICE=+eip ./RavenDB/Server/Raven.Server
```

<br />

Note that this must be re-applied after every upgrade, as Linux does not preserve file capabilities when a binary is replaced.

</Admonition>
If you choose a different port, remember to include it in the URL when accessing the server
(for example, `https://a.yourdomainname.development.run:8443`).
3. **TCP port**:
Expand Down
16 changes: 14 additions & 2 deletions docs/start/installation/upgrading-to-new-version.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,19 @@ Upgrading a RavenDB instance to a new version is very simple. To do so:
* These steps are strictly necessary when updating to version 5.1.
To update to lower versions, overriding the old binaries may be sufficient - although removing them is recommended.

4. Copy the new binaries.
4. Copy the new binaries.

<Admonition type="note" title="">

On Linux, if the server uses a privileged port (below 1024, e.g. port `443`),
re-apply the `setcap` capability to the new binary.
Linux does not preserve file capabilities when a binary is replaced:

```bash
sudo setcap CAP_NET_BIND_SERVICE=+eip ./RavenDB/Server/Raven.Server
```

</Admonition>

5. Restart the server.

Expand All @@ -53,7 +65,7 @@ However, sometimes our adjustments require changing the file format ("schema ver
If RavenDB finds during startup that the stored database uses an old format, it
will automatically perform this kind of migration.

<Admonition type="warning" title="">
<Admonition type="note" title="">
Migrating data files is only one type of migration.
If you try to downgrade to an older RavenDB version after making any changes in data files
format, RavenDB will fail to start with a detailed error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ b. **Upload** ([import](../../../server/security/authentication/certificate-mana

![Importing and Exporting Certificates](./assets/importing-and-exporting-certificate.png)

1. Click **Manage Server** and select **Certificates** to access the Studio - Certificates Management screen.
1. Click **Manage Server** and select **Certificates** to access Studio - Certificates Management screen.
2. Click **Server certificates** in the source server.
![Server Certificates Button Options](./assets/server-certificates-button-options.png)
* **Export server certificates**
Expand Down Expand Up @@ -352,7 +352,7 @@ When uploading a `.pfx` file with multiple certificates, RavenDB will add all of
and will allow access to all these certificates explicitly by their thumbprint.
### Generating Client Certificates Via Command Line Interface

* RavenDB provides an intuitive certificates management GUI in the Studio.
* RavenDB provides an intuitive certificates management GUI in Studio.

* All of the operations which are described below are also available in Command Line Interface (CLI).
- Be sure to configure the `SecurityClearance` for each client certificate because the default is [cluster admin](../../../server/security/authorization/security-clearance-and-permissions.mdx#cluster-admin) which has full access.
Expand Down Expand Up @@ -384,7 +384,7 @@ and is explained here only to show how to view the full chain in Windows. The ri

![Figure 7. Client Certificate Chain](./assets/client-cert.png)

Because client certificates are managed by RavenDB directly and not through any PKI infrastructure **this is perfectly acceptable**.
Because client certificates are managed by RavenDB directly and [not through any PKI infrastructure](../overview.mdx#important) **this is perfectly acceptable**.
Authenticating a client certificate is done explicitly by looking for the thumbprint in the registered certificates list in the server
and not by validating the chain of trust.

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-6.2/server/security/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ Registering a certificate means one of the following:
* The certificate was registered explicitly by an administrator.
* The certificate was registered implicitly for having the same [Public Key Pinning Hash](authentication/certificate-renewal-and-rotation.mdx#implicit-trust-by-public-key-pinning-hash) as a registered certificate.

In any case, it must appear in the certificates view in the studio. Visit the [Certificate Management](authentication/certificate-management.mdx) section for more information.
In any case, it must appear in the certificates view in Studio. Visit the [Certificate Management](authentication/certificate-management.mdx) section for more information.
</Admonition>

In the Studio, administrators can use the [Certificates View](../../server/security/authentication/certificate-configuration.mdx) to easily manage their certificates. It can be used to generate client certificates, register existing client certificates, import and export server certificates, rename, assign permissions and more.
In Studio, administrators can use the [Certificates View](../../server/security/authentication/certificate-configuration.mdx) to easily manage their certificates. It can be used to generate client certificates, register existing client certificates, import and export server certificates, rename, assign permissions and more.

**Read more:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,20 @@ import Panel from '@site/src/components/Panel';
Enter the private HTTPS port that the node will listen on (used by clients and browsers to connect to this server).
By default, this is set to `443`.
When using port 443, make sure it is not already used by other applications (such as IIS, Apache, Skype, etc.).
<Admonition type="note" title="">

On Linux, you might need to allow non-root processes to listen on port 443.
Run the following command to grant the server permission to bind to privileged ports:

```bash
sudo setcap CAP_NET_BIND_SERVICE=+eip ./RavenDB/Server/Raven.Server
```

<br />

Note that this must be re-applied after every upgrade, as Linux does not preserve file capabilities when a binary is replaced.

</Admonition>
If you choose a different port, remember to include it in the URL when accessing the server
(for example, `https://a.yourdomainname.development.run:8443`).
3. **TCP port**:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,19 @@ Upgrading a RavenDB instance to a new version is very simple. To do so:
* These steps are strictly necessary when updating to version 5.1.
To update to lower versions, overriding the old binaries may be sufficient - although removing them is recommended.

4. Copy the new binaries.
4. Copy the new binaries.

<Admonition type="note" title="">

On Linux, if the server uses a privileged port (below 1024, e.g. port `443`),
re-apply the `setcap` capability to the new binary.
Linux does not preserve file capabilities when a binary is replaced:

```bash
sudo setcap CAP_NET_BIND_SERVICE=+eip ./RavenDB/Server/Raven.Server
```

</Admonition>

5. Restart the server.

Expand All @@ -52,7 +64,7 @@ However, sometimes our adjustments require changing the file format ("schema ver
If RavenDB finds during startup that the stored database uses an old format, it
will automatically perform this kind of migration.

<Admonition type="warning" title="">
<Admonition type="note" title="">
Migrating data files is only one type of migration.
If you try to downgrade to an older RavenDB version after making any changes in data files
format, RavenDB will fail to start with a detailed error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ b. **Upload** ([import](../../../server/security/authentication/certificate-mana

![Importing and Exporting Certificates](./assets/importing-and-exporting-certificate.png)

1. Click **Manage Server** and select **Certificates** to access the Studio - Certificates Management screen.
1. Click **Manage Server** and select **Certificates** to access Studio - Certificates Management screen.
2. Click **Server certificates** in the source server.
![Server Certificates Button Options](./assets/server-certificates-button-options.png)
* **Export server certificates**
Expand Down Expand Up @@ -352,7 +352,7 @@ When uploading a `.pfx` file with multiple certificates, RavenDB will add all of
and will allow access to all these certificates explicitly by their thumbprint.
### Generating Client Certificates Via Command Line Interface

* RavenDB provides an intuitive certificates management GUI in the Studio.
* RavenDB provides an intuitive certificates management GUI in Studio.

* All of the operations which are described below are also available in Command Line Interface (CLI).
- Be sure to configure the `SecurityClearance` for each client certificate because the default is [cluster admin](../../../server/security/authorization/security-clearance-and-permissions.mdx#cluster-admin) which has full access.
Expand Down Expand Up @@ -384,7 +384,7 @@ and is explained here only to show how to view the full chain in Windows. The ri

![Figure 7. Client Certificate Chain](./assets/client-cert.png)

Because client certificates are managed by RavenDB directly and not through any PKI infrastructure **this is perfectly acceptable**.
Because client certificates are managed by RavenDB directly and [not through any PKI infrastructure](../overview.mdx#important) **this is perfectly acceptable**.
Authenticating a client certificate is done explicitly by looking for the thumbprint in the registered certificates list in the server
and not by validating the chain of trust.

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-7.0/server/security/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ Registering a certificate means one of the following:
* The certificate was registered explicitly by an administrator.
* The certificate was registered implicitly for having the same [Public Key Pinning Hash](authentication/certificate-renewal-and-rotation.mdx#implicit-trust-by-public-key-pinning-hash) as a registered certificate.

In any case, it must appear in the certificates view in the studio. Visit the [Certificate Management](authentication/certificate-management.mdx) section for more information.
In any case, it must appear in the certificates view in Studio. Visit the [Certificate Management](authentication/certificate-management.mdx) section for more information.
</Admonition>

In the Studio, administrators can use the [Certificates View](../../server/security/authentication/certificate-configuration.mdx) to easily manage their certificates. It can be used to generate client certificates, register existing client certificates, import and export server certificates, rename, assign permissions and more.
In Studio, administrators can use the [Certificates View](../../server/security/authentication/certificate-configuration.mdx) to easily manage their certificates. It can be used to generate client certificates, register existing client certificates, import and export server certificates, rename, assign permissions and more.

**Read more:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,20 @@ import Panel from '@site/src/components/Panel';
Enter the private HTTPS port that the node will listen on (used by clients and browsers to connect to this server).
By default, this is set to `443`.
When using port 443, make sure it is not already used by other applications (such as IIS, Apache, Skype, etc.).
<Admonition type="note" title="">

On Linux, you might need to allow non-root processes to listen on port 443.
Run the following command to grant the server permission to bind to privileged ports:

```bash
sudo setcap CAP_NET_BIND_SERVICE=+eip ./RavenDB/Server/Raven.Server
```

<br />

Note that this must be re-applied after every upgrade, as Linux does not preserve file capabilities when a binary is replaced.

</Admonition>
If you choose a different port, remember to include it in the URL when accessing the server
(for example, `https://a.yourdomainname.development.run:8443`).
3. **TCP port**:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,19 @@ Upgrading a RavenDB instance to a new version is very simple. To do so:
* These steps are strictly necessary when updating to version 5.1.
To update to lower versions, overriding the old binaries may be sufficient - although removing them is recommended.

4. Copy the new binaries.
4. Copy the new binaries.

<Admonition type="note" title="">

On Linux, if the server uses a privileged port (below 1024, e.g. port `443`),
re-apply the `setcap` capability to the new binary.
Linux does not preserve file capabilities when a binary is replaced:

```bash
sudo setcap CAP_NET_BIND_SERVICE=+eip ./RavenDB/Server/Raven.Server
```

</Admonition>

5. Restart the server.

Expand All @@ -52,7 +64,7 @@ However, sometimes our adjustments require changing the file format ("schema ver
If RavenDB finds during startup that the stored database uses an old format, it
will automatically perform this kind of migration.

<Admonition type="warning" title="">
<Admonition type="note" title="">
Migrating data files is only one type of migration.
If you try to downgrade to an older RavenDB version after making any changes in data files
format, RavenDB will fail to start with a detailed error message.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ b. **Upload** ([import](../../../server/security/authentication/certificate-mana

![Importing and Exporting Certificates](./assets/importing-and-exporting-certificate.png)

1. Click **Manage Server** and select **Certificates** to access the Studio - Certificates Management screen.
1. Click **Manage Server** and select **Certificates** to access Studio - Certificates Management screen.
2. Click **Server certificates** in the source server.
![Server Certificates Button Options](./assets/server-certificates-button-options.png)
* **Export server certificates**
Expand Down Expand Up @@ -352,7 +352,7 @@ When uploading a `.pfx` file with multiple certificates, RavenDB will add all of
and will allow access to all these certificates explicitly by their thumbprint.
### Generating Client Certificates Via Command Line Interface

* RavenDB provides an intuitive certificates management GUI in the Studio.
* RavenDB provides an intuitive certificates management GUI in Studio.

* All of the operations which are described below are also available in Command Line Interface (CLI).
- Be sure to configure the `SecurityClearance` for each client certificate because the default is [cluster admin](../../../server/security/authorization/security-clearance-and-permissions.mdx#cluster-admin) which has full access.
Expand Down Expand Up @@ -384,7 +384,7 @@ and is explained here only to show how to view the full chain in Windows. The ri

![Figure 7. Client Certificate Chain](./assets/client-cert.png)

Because client certificates are managed by RavenDB directly and not through any PKI infrastructure **this is perfectly acceptable**.
Because client certificates are managed by RavenDB directly and [not through any PKI infrastructure](../overview.mdx#important) **this is perfectly acceptable**.
Authenticating a client certificate is done explicitly by looking for the thumbprint in the registered certificates list in the server
and not by validating the chain of trust.

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-7.1/server/security/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ Registering a certificate means one of the following:
* The certificate was registered explicitly by an administrator.
* The certificate was registered implicitly for having the same [Public Key Pinning Hash](authentication/certificate-renewal-and-rotation.mdx#implicit-trust-by-public-key-pinning-hash) as a registered certificate.

In any case, it must appear in the certificates view in the studio. Visit the [Certificate Management](authentication/certificate-management.mdx) section for more information.
In any case, it must appear in the certificates view in Studio. Visit the [Certificate Management](authentication/certificate-management.mdx) section for more information.
</Admonition>

In the Studio, administrators can use the [Certificates View](../../server/security/authentication/certificate-configuration.mdx) to easily manage their certificates. It can be used to generate client certificates, register existing client certificates, import and export server certificates, rename, assign permissions and more.
In Studio, administrators can use the [Certificates View](../../server/security/authentication/certificate-configuration.mdx) to easily manage their certificates. It can be used to generate client certificates, register existing client certificates, import and export server certificates, rename, assign permissions and more.

**Read more:**

Expand Down
Loading
Loading