# Custom branding in the Amazon DCV Access Console
Custom branding

To create a familiar experience for your users when they Amazon DCV, you can customize the appearance of Amazon DCV Access Console with your own login background image, logo, login message, documentation links and client download links. When you customize the Amazon DCV Access Console, your branding is displayed to users rather than the default Amazon DCV branding.

**Note**  
Any login background image, logo, login message, documentation links, and client download links you choose to use to customize the Amazon DCV Access Console is Your Content (as the term is defined in the Customer Agreement, which in turn is defined in the [EULA](https://www.nice-dcv.com/eula.html)). You are solely responsible for Your Content and your use of Your Content to customize the Amazon DCV Access Console, including compliance with the Policies as defined in the Customer Agreement and applicable law.

## Custom branding options


You can customize the appearance of the Amazon DCV Access Console by using the following branding options.


| Branding element | Description | Requirements and recommendations | 
| --- | --- | --- | 
|  Organization logo  |  Enables you to display an image that is familiar to your users. The image appears on the log in page, and at the top of the Console after the user has logged in (service-name.svg).  |  File type: .svg Recommended dimensions: 112 x 32 px  | 
|  Favicon  |  Enables your users to recognize the Console site in a browser full of tabs or bookmarks. The favicon icon is displayed at the top of the browser tab for the Console site (favicon.io).  |  File type: .ico Recommended dimensions: 28px x 28px  | 
|  Login message  |  Enables you to customize a message on the log in screen.  |  Length constraints: Minimum length of 1 character. Maximum length of 200 characters. File type: .svg  | 
|  Login background image  |  Enables you to customize the background image on the login screen (login-bacgroud.svg).  |  Recommended dimensions: 1440 px x 1024 px  | 
|  Documentation URL  |  Enables you to specify a URL for a Documentation link.  |  Format: https://example.com or http://example.com  | 
|  Downloads URL  |  Enables you to specify a URL for a Downloads link, so that users can download the appropriate native client to stream their Amazon DCV session from.  |  Format: https://example.com or http://example.com  | 

# Adding your custom branding


To customize the Amazon DCV Access Console with your organizational branding, you need to update the following with your preferred configurations:
+ Authentication Server
+ Web Client

## Updating customization on the Authentication Server


1. Connect to the host on which you are running the Authentication Server.

1. Create a backup directory and copy the files that will be changed.

   ```
   $ mkdir custom_branding_bkp
   ```

   ```
   $ sudo cp /opt/aws/dcv-access-console-auth-server/dcv-access-console-auth-server-*.jar custom_branding_bkp/
   ```

1. Create a working directory.

   ```
   $ mkdir custom_branding
   ```

   ```
   $ cd custom_branding
   ```

1. Copy the Authentication Server.

   ```
   $ sudo cp /opt/aws/dcv-access-console-auth-server/dcv-access-console-auth-server-*.jar .
   ```

1. Unzip the relevant files.

   ```
   $ unzip dcv-access-console-auth-server-*.jar BOOT-INF/classes/static/_next/static/chunks/app/login/*.js
   ```

   ```
   $ unzip dcv-access-console-auth-server-*.jar BOOT-INF/classes/static/service-name.svg
   ```

   ```
   $ unzip dcv-access-console-auth-server-*.jar BOOT-INF/classes/static/favicon.ico
   ```

   ```
   $ unzip dcv-access-console-auth-server-*.jar BOOT-INF/classes/static/login-background.svg
   ```

1. Replace the existing images file paths with paths to your new custom **organization logo** , **favicon**, and **login background images**.

   ```
   $ sudo cp path-to-new-favicon.ico BOOT-INF/classes/static/favicon.ico
   ```

   ```
   $ sudo cp path-to-new-service-name.svg BOOT-INF/classes/static/service-name.svg
   ```

   ```
   $ sudo cp path-to-new-login-background.svg BOOT-INF/classes/static/login-background.svg
   ```

1. Update the **alternative text** for the organization logo.

   ```
   $ OLD_ALT="Access Console"
   ```

   ```
   $ NEW_ALT="My new logo alt text"
   ```

   ```
   $ sudo sed -i "s/alt:\"$OLD_ALT\"/alt:\"$NEW_ALT\"/g" BOOT-INF/classes/static/_next/static/chunks/app/login/page-*.js
   ```

1. Update the **login message** on the login screen.

   ```
   $ OLD_TAGLINE="Manage and connect to your Amazon DCV sessions."
   ```

   ```
   $ NEW_TAGLINE="My new tag line"
   ```

   ```
   $ sudo sed -i "s/tagline:\"$OLD_TAGLINE\"/tagline:\"$NEW_TAGLINE\"/g" BOOT-INF/classes/static/_next/static/chunks/app/login/page-*.js
   ```

1. Replace the files in the jar.

   ```
   $ zip -ur dcv-access-console-auth-server-*.jar BOOT-INF/ 
   ```

1. Copy the new jar.

   ```
   $ sudo cp dcv-access-console-auth-server-*.jar /opt/aws/dcv-access-console-auth-server/
   ```

1. Reload the daemon and restart the authorization server.

   ```
   $ sudo systemctl daemon-reload  sudo systemctl restart dcv-access-console-auth-server
   ```

## Updating customization on the Web Client


1. Connect to the host on which you are running the Web Client.

1. Create a backup directory and copy the files that will be changed.

   ```
   $ mkdir custom_branding_bkp
   ```

   ```
   $ sudo cp -r /opt/aws/dcv-access-console-webclient custom_branding_bkp/
   ```

1. Replace the existing images file paths with paths to your new custom **organization logo** , **favicon**, and **login background images** (the login background image is used on the Web Client for error messages).

   ```
   $ sudo cp path-to-new-service-name.svg /opt/aws/dcv-access-console-webclient/public/service-name.svg
   ```

   ```
   $ sudo cp path-to-new-favicon.ico.body/opt/aws/dcv-access-console-webclient/.next/server/app/favicon.ico.body
   ```

   ```
   $ sudo cp path-to-new-login-background.svg/opt/aws/dcv-access-console-webclient/public/login-background.svg
   ```

1. Update the **alternative text** for the organization logo.

   ```
   $ OLD_ALT="Access Console"
   ```

   ```
   $ NEW_ALT="My new logo alt text"
   ```

   ```
   $ grep -rl "alt:\"$OLD_ALT\"" /opt/aws/dcv-access-console-webclient/.next/ | xargs sed -i "s/alt:\"$OLD_ALT\"/alt:\"$NEW_ALT\"/g"
   ```

1. Replace the **Documentation** URL.

   ```
   $ OLD_DOC_LINK="https:\/\/docs.aws.amazon.com\/dcv\/latest\/sm-admin\/what-is-sm.html"
   ```

   ```
   $ NEW_DOC_LINK="https:\/\/example.com"
   ```

   ```
   $ grep -rl $OLD_DOC_LINK /opt/aws/dcv-access-console-webclient/.next/ | xargs sed -i "s/$OLD_DOC_LINK/$NEW_DOC_LINK/g"
   ```

1. Replace the **Downloads** URL.

   ```
   $ OLD_DOWNLOADS_LINK="https:\/\/download.nice-dcv.com\/"
   ```

   ```
   $ NEW_DOWNLOADS_LINK="https:\/\/example.com"
   ```

   ```
   $ grep -rl $OLD_DOWNLOADS_LINK /opt/aws/dcv-access-console-webclient/.next/ | xargs sed -i "s/$OLD_DOWNLOADS_LINK/$NEW_DOWNLOADS_LINK/g"
   ```