|
| 1 | +--- |
| 2 | +docs: |
| 3 | +doctypes: |
| 4 | + - task |
| 5 | +tags: |
| 6 | + - docs |
| 7 | +title: Add a file in a configuration |
| 8 | +toc: true |
| 9 | +weight: 400 |
| 10 | +--- |
| 11 | + |
| 12 | + |
| 13 | +## Overview |
| 14 | + |
| 15 | +This guide explains how to add files in the F5 NGINX One Console. While you can manage files in the CLI, the NGINX One Console supports editing in |
| 16 | +a UI that resembles an Integrated Development Environment (IDE), with recommendations. |
| 17 | + |
| 18 | +## Before you start |
| 19 | + |
| 20 | +Before you add files in your configuration, ensure: |
| 21 | + |
| 22 | +- You have access to the NGINX One Console. |
| 23 | +- NGINX instances are properly registered with NGINX One Console |
| 24 | + |
| 25 | +## Important considerations |
| 26 | + |
| 27 | +If your instance is a member of a Config Sync Group, changes that you make may be synchronized to other instances in that group. |
| 28 | +For more information, see how you can [Manage Config Sync Groups]({{< relref "/nginx-one/how-to/config-sync-groups/manage-config-sync-groups.md" >}}). |
| 29 | + |
| 30 | +## Add a file |
| 31 | + |
| 32 | +You can use the NGINX One Console to add a file to a specific instance. To do so: |
| 33 | + |
| 34 | +1. Select the instance to manage. |
| 35 | +1. Select the **Configuration** tab. |
| 36 | + |
| 37 | + {{< tip >}} |
| 38 | + |
| 39 | + From this window, select the file of your choice. If you want to delete this |
| 40 | + file, Select **Edit Configuration** and select the Trash icon. |
| 41 | + |
| 42 | + If this was a mistake, a revert button appears. But do not wait. As noted in |
| 43 | + one of the UI messages, "This action cannot be undone once you publish the |
| 44 | + configuration." |
| 45 | + |
| 46 | + {{< /tip >}} |
| 47 | + |
| 48 | +1. Select **Edit Configuration**. |
| 49 | +1. In the **Edit Configuration** window that appears, select **Add File**. |
| 50 | + |
| 51 | +You now have multiple options, described in the sections which follow. |
| 52 | + |
| 53 | +### New Configuration File |
| 54 | + |
| 55 | +Enter the name of the desired configuration file, such as `abc.conf` and select **Add**. The configuration file appears in the **Edit Configuration** window. |
| 56 | + |
| 57 | +### New SSL Certificate or CA Bundle |
| 58 | + |
| 59 | +First you can select the toggle to allow NGINX One Console to manaage the new certificate or bundle. |
| 60 | + |
| 61 | +<!-- Candidate for an "include". Common content with add-file.md --> |
| 62 | +In the screen that appears, you can add a certificate name. If you don't add a name, NGINX One will add a name for you, based on the expiration date for the certificate. |
| 63 | + |
| 64 | +You can add certificates in the following formats: |
| 65 | + |
| 66 | +- **SSL Certificate and Key** |
| 67 | +- **CA Certificate Bundle** |
| 68 | + |
| 69 | +In each case, you can upload files directly, or enter the content of the certificates in a text box. Once you upload these certificates, you'll see: |
| 70 | + |
| 71 | +- **Certificate Details**, with the Subject Name, start and end dates. |
| 72 | +- **Key Details**, with the encryption key size and algorithm, such as RSA |
| 73 | + |
| 74 | + {{< tip >}} |
| 75 | + |
| 76 | + Make sure to specify the path to your certificate in your NGINX configuration, |
| 77 | + with the `ssl_certificate` and `ssl_certificate_key` directives. |
| 78 | + |
| 79 | + {{< /tip >}} |
| 80 | +<!-- end potential "include" --> |
| 81 | + |
| 82 | +### Existing SSL Certificate or CA Bundle |
| 83 | + |
| 84 | +With this option, You can incorporate [Managed certificates]({{< relref "/nginx-one/how-to/certificates/manage-certificates.md#managed-and-unmanaged-certificates" >}}). |
| 85 | +In the **Choose Certificate** drop-down, select the managed certificate of your choice, and select **Add**. You can then: |
| 86 | + |
| 87 | +1. Review details of the certificate. The next steps depend on whether the certificate is a CA bundle or a certificate / key pair. |
| 88 | +1. Enter the **Certificate File Path**, such as `/etc/ssl/nginx/mycert.crt`. |
| 89 | +1. If you selected a key pair, you'll also enter the **Key File Path**, such as `/etc/ssl/nginx/mycert.key`. |
| 90 | +1. Select **Add**. You should now be returned to the **Edit Configuration** window. |
| 91 | + You should now see the files you specified in the directory tree. |
| 92 | +1. Select **Next** and then **Save and Publish**. |
| 93 | + You may see a message that suggests publication is in progress. |
| 94 | + - If the instance is offline, **Save and Publish** does not work. |
| 95 | +1. When publication is complete, you're taken back to the **Configuration** tab. You should see the updated configuration in the window. |
| 96 | + |
| 97 | +## See also |
| 98 | + |
| 99 | +- [Create and manage data plane keys]({{< relref "/nginx-one/how-to/data-plane-keys/create-manage-data-plane-keys.md" >}}) |
| 100 | +- [View and edit NGINX configurations]({{< relref "/nginx-one/how-to/nginx-configs/view-edit-nginx-configurations.md" >}}) |
| 101 | +- [Manage certificates]({{< relref "/nginx-one/how-to/certificates/manage-certificates.md" >}}) |
0 commit comments